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

Java tutorial

Introduction

Here is the source code for gov.nih.nci.firebird.selenium2.pages.sponsor.protocol.review.ReviewRegistrationTab.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 org.junit.Assert.*;
import gov.nih.nci.firebird.commons.selenium2.support.AbstractLoadableComponent;
import gov.nih.nci.firebird.commons.selenium2.support.IdentifiableComponentFactory;
import gov.nih.nci.firebird.commons.selenium2.util.JQueryUtils;
import gov.nih.nci.firebird.commons.selenium2.util.TableUtils;
import gov.nih.nci.firebird.selenium2.pages.base.TableListing;
import gov.nih.nci.firebird.selenium2.pages.components.tags.RegistrationCommentsTag;
import gov.nih.nci.firebird.selenium2.pages.components.tags.RegistrationCommentsTag.CommentType;
import gov.nih.nci.firebird.selenium2.pages.components.tags.SponsorReviewRegistrationFormsTable;
import gov.nih.nci.firebird.selenium2.pages.components.tags.SponsorReviewRegistrationFormsTable.RegistrationListing;
import gov.nih.nci.firebird.selenium2.pages.investigator.registration.common.RegistrationReviewCommentDialog;
import gov.nih.nci.firebird.selenium2.pages.sponsor.registration.common.AdditionalAttachmentsDialog;
import gov.nih.nci.firebird.selenium2.pages.sponsor.registration.common.FinancialDisclosuresSupportingDocumentsDialog;
import gov.nih.nci.firebird.selenium2.pages.sponsor.registration.common.FormReviewCommentDialog;

import java.util.List;

import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.CacheLookup;
import org.openqa.selenium.support.FindBy;

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

/**
 * /sponsor/protocol/review/ajax/review_registration.jsp
 */
public class ReviewRegistrationTab extends AbstractLoadableComponent<ReviewRegistrationTab> {

    public static final IdentifiableComponentFactory<ReviewRegistrationTab> FACTORY = new Factory();

    private static final String TITLE_ID = "reviewProtocolRegistrationTitle";
    private static final String REGISTRATION_STATUS_ID = "registrationStatus";
    private static final String COMPLETE_SUCCESS_MESSAGE_CLASS = "validMessage";
    private static final String COMPLETE_REVIEW_BUTTON_ID = "completeReviewButton";
    private static final String COMPLETE_REVIEW_BUTTON_INSTRUCTIONS_CLASS = "instructions";

    private ReviewRegistrationTabHelper helper = new ReviewRegistrationTabHelper(this);

    @FindBy(id = TITLE_ID)
    @CacheLookup
    private WebElement headerElement;

    @FindBy(id = REGISTRATION_STATUS_ID)
    private WebElement statusHeader;

    private final SponsorReviewRegistrationFormsTable table;
    private final RegistrationCommentsTag commentsTag;
    private final RegistrationPacketPage page;

    public ReviewRegistrationTab(WebDriver driver, RegistrationPacketPage page) {
        super(driver);
        table = new SponsorReviewRegistrationFormsTable(getDriver(), this);
        this.page = page;
        commentsTag = new RegistrationCommentsTag(getDriver());
    }

    public ReviewRegistrationTabHelper getHelper() {
        return helper;
    }

    public String getHeader() {
        return headerElement.getText();
    }

    public String getStatusHeader() {
        return statusHeader.getText();
    }

    public boolean isCompleteReviewButtonPresent() {
        return isPresent(By.id(COMPLETE_REVIEW_BUTTON_ID));
    }

    private WebElement getCompleteReviewButton() {
        return Iterables.find(getDriver().findElements(By.id(COMPLETE_REVIEW_BUTTON_ID)),
                new Predicate<WebElement>() {
                    @Override
                    public boolean apply(WebElement button) {
                        return button.isDisplayed();
                    }
                });
    }

    public AbstractLoadableComponent<?> clickCompleteReview() {
        getCompleteReviewButton().click();
        pause(500);
        return identifyDisplayedComponent(RegistrationReviewCommentDialog.getFactory(this),
                ReviewCompletionDialog.getFactory(this), ReviewRegistrationTab.FACTORY);
    }

    public String getComments() {
        return getCommentsTag().getComments(CommentType.SPONSOR);
    }

    public RegistrationPacketPage getPage() {
        return page.waitUntilReady();
    }

    public List<RegistrationListing> getFormListings() {
        return getTable().getListings();
    }

    private SponsorReviewRegistrationFormsTable getTable() {
        return table.waitUntilReady();
    }

    public void waitForCompleteSuccessMessageDisplayed() {
        waitFor(By.className(COMPLETE_SUCCESS_MESSAGE_CLASS));
    }

    public RegistrationCommentsTag getCommentsTag() {
        return commentsTag.waitUntilReady();
    }

    public boolean isCompleteReviewButtonInstructionsPresent() {
        return isPresent(By.className(COMPLETE_REVIEW_BUTTON_INSTRUCTIONS_CLASS));
    }

    public String getCompleteReviewButtonInstructions() {
        return getDriver().findElement(By.className(COMPLETE_REVIEW_BUTTON_INSTRUCTIONS_CLASS)).getText();
    }

    @Override
    protected void assertLoaded() {
        table.assertLoaded();
        assertFindBysPresent();
        assertFalse(JQueryUtils.isTabLoading(getDriver()));
        assertFalse(JQueryUtils.isAjaxCallExecuting(getDriver()));
        assertFalse(JQueryUtils.isDialogDisplayed(getDriver()));
        assertFalse(JQueryUtils.isPageMasked(getDriver()));
    }

    public class RegistrationFormListing implements TableListing {

        private static final int FORM_COLUMN_INDEX = 0;
        private static final int STATUS_COLUMN_INDEX = 1;
        private static final int STATUS_DATE_COLUMN_INDEX = 2;
        private static final int DISPOSITION_COLUMN_INDEX = 3;
        private static final int COMMENTS_COLUMN_INDEX = 4;
        private static final int ADDITIONAL_DOCUMENTS_COLUMN_INDEX = 5;

        private static final String ACCEPT_RADIO_SELECTOR = "input[value=true]";
        private static final String REJECT_RADIO_SELECTOR = "input[value=false]";

        private final Long id;
        private final String form;
        private final WebElement formDownloadLink;
        private final String status;
        private final String statusDate;
        private WebElement acceptRadio;
        private WebElement rejectRadio;
        private WebElement commentsLink;
        private WebElement additionalDocmentsLink;

        public RegistrationFormListing(WebElement row) {
            this.id = Long.valueOf(ReviewRegistrationTab.getId(row));
            List<WebElement> cells = TableUtils.getCells(row);
            WebElement formCell = cells.get(FORM_COLUMN_INDEX);
            this.form = formCell.getText();
            this.formDownloadLink = getElementIfPresent(formCell, By.tagName("a"));
            this.status = cells.get(STATUS_COLUMN_INDEX).getText();
            this.statusDate = cells.get(STATUS_DATE_COLUMN_INDEX).getText();

            this.acceptRadio = getElementIfPresent(cells.get(DISPOSITION_COLUMN_INDEX),
                    By.cssSelector(ACCEPT_RADIO_SELECTOR));
            this.rejectRadio = getElementIfPresent(cells.get(DISPOSITION_COLUMN_INDEX),
                    By.cssSelector(REJECT_RADIO_SELECTOR));
            this.commentsLink = getElementIfPresent(cells.get(COMMENTS_COLUMN_INDEX), By.tagName("img"));
            this.additionalDocmentsLink = getElementIfPresent(cells.get(ADDITIONAL_DOCUMENTS_COLUMN_INDEX),
                    By.tagName("img"));
        }

        @Override
        public Long getId() {
            return id;
        }

        public String getForm() {
            return form;
        }

        public String getStatus() {
            return status;
        }

        public String getStatusDate() {
            return statusDate;
        }

        public void clickAcceptRadioButton() {
            clickDispositionRadioButton(acceptRadio);
            waitUntilReady();
        }

        private void clickDispositionRadioButton(WebElement radioButton) {
            if (radioButton != null) {
                radioButton.click();
            } else {
                throw new IllegalArgumentException(form + " does not have disposition options");
            }
        }

        public FormReviewCommentDialog clickRejectRadioButton() {
            clickDispositionRadioButton(rejectRadio);
            return new FormReviewCommentDialog(getDriver(), ReviewRegistrationTab.this).waitUntilReady();
        }

        public void clearDisposition() {
            if (acceptRadio.isSelected()) {
                clickDispositionRadioButton(acceptRadio);
            } else if (rejectRadio.isSelected()) {
                clickDispositionRadioButton(rejectRadio);
            }
            waitUntilReady();
        }

        public AbstractLoadableComponent<?> clickFormDownload() {
            formDownloadLink.click();
            pause(400);
            return identifyDisplayedComponent(AdditionalAttachmentsDialog.getFactory(ReviewRegistrationTab.this),
                    ReviewHumanResearchCertificatesDialog.getFactory(ReviewRegistrationTab.this), FACTORY);
        }

        public FormReviewCommentDialog clickComments() {
            commentsLink.click();
            return new FormReviewCommentDialog(getDriver(), ReviewRegistrationTab.this).waitUntilReady();
        }

        public AbstractLoadableComponent<?> clickAdditionalDocuments() {
            additionalDocmentsLink.click();
            return identifyDisplayedComponent(
                    gov.nih.nci.firebird.selenium2.pages.sponsor.registration.common.RegistrationClinicalLabCertificatesDialog
                            .getFactory(ReviewRegistrationTab.this),
                    FinancialDisclosuresSupportingDocumentsDialog.getFactory(ReviewRegistrationTab.this));
        }

        public boolean hasAdditionalDocuments() {
            return additionalDocmentsLink != null;
        }

        public boolean hasComments() {
            return commentsLink != null;
        }

        public boolean isDispositionSelectionEnabled() {
            return acceptRadio.isEnabled();
        }

        public boolean isAccepted() {
            return acceptRadio != null && acceptRadio.isSelected();
        }

        public boolean isRejected() {
            return rejectRadio != null && rejectRadio.isSelected();
        }

    }

    private static class Factory extends IdentifiableComponentFactory<ReviewRegistrationTab> {

        @Override
        protected ReviewRegistrationTab getInstance(WebDriver driver) {
            return new ReviewRegistrationTab(driver, new RegistrationPacketPage(driver));
        }

    }

}