gov.nih.nci.firebird.selenium2.pages.sponsor.protocol.review.ReviewRegistrationTabHelper.java Source code

Java tutorial

Introduction

Here is the source code for gov.nih.nci.firebird.selenium2.pages.sponsor.protocol.review.ReviewRegistrationTabHelper.java

Source

/**
 * The software subject to this notice and license includes both human readable
 * source code form and machine readable, binary, object code form. The NCI OCR
 * Software was developed in conjunction with the National Cancer Institute
 * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent
 * government employees are authors, any rights in such works shall be subject
 * to Title 17 of the United States Code, section 105.
 *
 * This NCI OCR Software License (the License) is between NCI and You. You (or
 * Your) shall mean a person or an entity, and all other entities that control,
 * are controlled by, or are under common control with the entity. Control for
 * purposes of this definition means (i) the direct or indirect power to cause
 * the direction or management of such entity, whether by contract or otherwise,
 * or (ii) ownership of fifty percent (50%) or more of the outstanding shares,
 * or (iii) beneficial ownership of such entity.
 *
 * This License is granted provided that You agree to the conditions described
 * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up,
 * no-charge, irrevocable, transferable and royalty-free right and license in
 * its rights in the NCI OCR Software to (i) use, install, access, operate,
 * execute, copy, modify, translate, market, publicly display, publicly perform,
 * and prepare derivative works of the NCI OCR Software; (ii) distribute and
 * have distributed to and by third parties the NCI OCR Software and any
 * modifications and derivative works thereof; and (iii) sublicense the
 * foregoing rights set out in (i) and (ii) to third parties, including the
 * right to license such rights to further third parties. For sake of clarity,
 * and not by way of limitation, NCI shall have no right of accounting or right
 * of payment from You or Your sub-licensees for the rights granted under this
 * License. This License is granted at no charge to You.
 *
 * Your redistributions of the source code for the Software must retain the
 * above copyright notice, this list of conditions and the disclaimer and
 * limitation of liability of Article 6, below. Your redistributions in object
 * code form must reproduce the above copyright notice, this list of conditions
 * and the disclaimer of Article 6 in the documentation and/or other materials
 * provided with the distribution, if any.
 *
 * Your end-user documentation included with the redistribution, if any, must
 * include the following acknowledgment: This product includes software
 * developed by 5AM and the National Cancer Institute. If You do not include
 * such end-user documentation, You shall include this acknowledgment in the
 * Software itself, wherever such third-party acknowledgments normally appear.
 *
 * You may not use the names "The National Cancer Institute", "NCI", or "5AM"
 * to endorse or promote products derived from this Software. This License does
 * not authorize You to use any trademarks, service marks, trade names, logos or
 * product names of either NCI or 5AM, except as required to comply with the
 * terms of this License.
 *
 * For sake of clarity, and not by way of limitation, You may incorporate this
 * Software into Your proprietary programs and into any third party proprietary
 * programs. However, if You incorporate the Software into third party
 * proprietary programs, You agree that You are solely responsible for obtaining
 * any permission from such third parties required to incorporate the Software
 * into such third party proprietary programs and for informing Your
 * sub-licensees, including without limitation Your end-users, of their
 * obligation to secure any required permissions from such third parties before
 * incorporating the Software into such third party proprietary software
 * programs. In the event that You fail to obtain such permissions, You agree
 * to indemnify NCI for any claims against NCI by such third parties, except to
 * the extent prohibited by law, resulting from Your failure to obtain such
 * permissions.
 *
 * For sake of clarity, and not by way of limitation, You may add Your own
 * copyright statement to Your modifications and to the derivative works, and
 * You may provide additional or different license terms and conditions in Your
 * sublicenses of modifications of the Software, or any derivative works of the
 * Software as a whole, provided Your use, reproduction, and distribution of the
 * Work otherwise complies with the conditions stated in this License.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO
 * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR
 * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package gov.nih.nci.firebird.selenium2.pages.sponsor.protocol.review;

import static gov.nih.nci.firebird.test.util.FirebirdPropertyUtils.*;
import static org.junit.Assert.*;
import gov.nih.nci.firebird.commons.selenium2.support.AbstractLoadableComponent;
import gov.nih.nci.firebird.commons.selenium2.util.WaitUtils;
import gov.nih.nci.firebird.data.AbstractProtocolRegistration;
import gov.nih.nci.firebird.data.AbstractRegistrationForm;
import gov.nih.nci.firebird.data.FormStatus;
import gov.nih.nci.firebird.data.InvestigatorRegistration;
import gov.nih.nci.firebird.data.RegistrationStatus;
import gov.nih.nci.firebird.data.SubInvestigatorRegistration;
import gov.nih.nci.firebird.selenium2.pages.components.tags.SponsorReviewRegistrationFormsTable.RegistrationListing;
import gov.nih.nci.firebird.selenium2.pages.sponsor.registration.common.AdditionalAttachmentsDialog;
import gov.nih.nci.firebird.selenium2.pages.sponsor.registration.common.FormReviewCommentDialog;
import gov.nih.nci.firebird.selenium2.pages.util.FirebirdTableUtils;

import java.util.Set;

import com.google.common.base.Predicate;
import com.google.common.collect.Sets;

public class ReviewRegistrationTabHelper {

    private final ReviewRegistrationTab tab;

    ReviewRegistrationTabHelper(ReviewRegistrationTab tab) {
        this.tab = tab;
    }

    public void checkRegistrationPageHeader(AbstractProtocolRegistration registration) {
        String expected;
        String personDisplayName = registration.getProfile().getPerson().getDisplayName();
        String protocolNumber = registration.getProtocol().getProtocolNumber();
        String protocolTitle = registration.getProtocol().getProtocolTitle();
        if (registration instanceof InvestigatorRegistration) {
            expected = getPropertyText("registration.header.primaryInvestigator", personDisplayName, protocolNumber,
                    protocolTitle);
        } else {
            String investigatorDisplayName = ((SubInvestigatorRegistration) registration).getPrimaryRegistration()
                    .getProfile().getPerson().getDisplayName();
            expected = getPropertyText("registration.header.subinvestigator", personDisplayName,
                    investigatorDisplayName, protocolNumber, protocolTitle);
        }
        assertEquals(expected, getTab().getHeader());
    }

    private ReviewRegistrationTab getTab() {
        return tab.waitUntilReady();
    }

    public AbstractLoadableComponent<?> clickFormDownload(AbstractRegistrationForm form) {
        return getMatchingListing(form).clickDownload();
    }

    public RegistrationListing getMatchingListing(final AbstractRegistrationForm form) {
        return FirebirdTableUtils.getListing(getTab().getFormListings(), form);
    }

    public void reviewForm(AbstractRegistrationForm form) {
        reviewForm(getMatchingListing(form));
    }

    public void reviewForm(RegistrationListing listing) {
        AbstractLoadableComponent<?> component = listing.clickDownload();
        if (component instanceof AdditionalAttachmentsDialog) {
            AdditionalAttachmentsDialog dialog = (AdditionalAttachmentsDialog) component;
            dialog.clickClose();
        } else if (component instanceof ReviewHumanResearchCertificatesDialog) {
            ReviewHumanResearchCertificatesDialog dialog = (ReviewHumanResearchCertificatesDialog) component;
            dialog.clickClose();
        }
    }

    public void reviewAllForms(AbstractProtocolRegistration registration) {
        for (AbstractRegistrationForm form : getFormsRequiringReview(registration)) {
            reviewForm(getMatchingListing(form));
        }
    }

    private Set<AbstractRegistrationForm> getFormsRequiringReview(AbstractProtocolRegistration registration) {
        return Sets.filter(registration.getFormsForSponsorReview(), new Predicate<AbstractRegistrationForm>() {
            @Override
            public boolean apply(AbstractRegistrationForm form) {
                return form.isReviewRequired();
            }
        });
    }

    public void rejectAllForms(AbstractProtocolRegistration registration) {
        for (AbstractRegistrationForm form : getFormsRequiringReview(registration)) {
            rejectForm(form, form.getFormType().getName());
        }
    }

    public void rejectForm(AbstractRegistrationForm form, String comments) {
        FormReviewCommentDialog rejectionCommentsDialog = getMatchingListing(form).clickReject();
        rejectionCommentsDialog.typeComments(comments);
        rejectionCommentsDialog.clickSave();
    }

    public void acceptAllForms(AbstractProtocolRegistration registration) {
        for (AbstractRegistrationForm form : getFormsRequiringReview(registration)) {
            acceptForm(form);
        }
        WaitUtils.pause(400);
    }

    public void acceptForm(AbstractRegistrationForm form) {
        RegistrationListing listing = getMatchingListing(form);
        if (!listing.isAcceptSelected()) {
            listing.clickAccept();
        }
    }

    public void clearFormDispositions(AbstractProtocolRegistration registration) {
        for (AbstractRegistrationForm form : getFormsRequiringReview(registration)) {
            getMatchingListing(form).clearDisposition();
        }
    }

    public void checkForRegistrationStatus(RegistrationStatus expectedStatus) {
        assertEquals(expectedStatus.getDisplay(), getTab().getStatusHeader());
    }

    public void checkFormStatuses(AbstractProtocolRegistration registration, FormStatus expectedStatus) {
        for (AbstractRegistrationForm form : registration.getFormsForSponsorReview()) {
            if (form.isReviewRequired()) {
                assertEquals(expectedStatus.getDisplay(), getMatchingListing(form).getStatus());
            } else {
                assertEquals(FormStatus.NOT_APPLICABLE.getDisplay(), getMatchingListing(form).getStatus());
            }
        }
    }

    public void checkCommentsForText(String comments) {
        assertTrue(tab.getComments().contains(comments));
    }

    public void checkAllFormDispositionsDisabled(InvestigatorRegistration registration) {
        for (AbstractRegistrationForm form : getFormsRequiringReview(registration)) {
            assertFalse(getMatchingListing(form).isDispositionSelectionEnabled());
        }
    }

    public AbstractLoadableComponent<?> acceptRegistration(AbstractProtocolRegistration registration) {
        reviewAllForms(registration);
        acceptAllForms(registration);
        return getTab().clickCompleteReview();
    }

}