gov.nih.nci.firebird.service.task.CoordinatorTasksGenerator.java Source code

Java tutorial

Introduction

Here is the source code for gov.nih.nci.firebird.service.task.CoordinatorTasksGenerator.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.service.task;

import gov.nih.nci.firebird.data.AnnualRegistration;
import gov.nih.nci.firebird.data.InvestigatorProfile;
import gov.nih.nci.firebird.data.RegistrationStatus;
import gov.nih.nci.firebird.data.user.FirebirdUser;
import gov.nih.nci.firebird.data.user.InvestigatorStatus;
import gov.nih.nci.firebird.data.user.ManagedInvestigator;
import gov.nih.nci.firebird.service.annual.registration.AnnualRegistrationService;
import gov.nih.nci.firebird.service.messages.FirebirdStringTemplate;
import gov.nih.nci.firebird.service.messages.FirebirdTemplateParameter;
import gov.nih.nci.firebird.service.messages.TemplateService;

import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.apache.commons.lang.time.DateUtils;

import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.inject.Inject;

/**
 * Class for generating tasks for a coordinator user.
 */
class CoordinatorTasksGenerator {

    private final TemplateService templateService;
    private final AnnualRegistrationService annualRegistrationService;

    @Inject
    CoordinatorTasksGenerator(TemplateService templateService,
            AnnualRegistrationService annualRegistrationService) {
        super();
        this.templateService = templateService;
        this.annualRegistrationService = annualRegistrationService;
    }

    List<Task> generateTasks(FirebirdUser user) {
        List<Task> tasks = Lists.newArrayList();
        if (user.isRegistrationCoordinator()) {
            tasks.addAll(getCoordinatorRoleVerificationTask(user));
            tasks.addAll(getCoordinatorRegistrationRenewalTasks(user));
            tasks.addAll(getAnnualRegistrationApprovedTasksForCoordinator(user));
            if (user.isCtepUser()) {
                tasks.addAll(getInvestigatorSuspensionNoticeTasks(user));
                tasks.addAll(getInvestigatorDisqualificationNoticeTasks(user));
            }
        }
        return tasks;
    }

    private List<Task> getCoordinatorRoleVerificationTask(FirebirdUser user) {
        List<Task> tasks = Lists.newArrayList();
        if (containsCoordinatorRoleAwaitingApproval(user)) {
            tasks.add(createCoordinatorRoleVerificationTask());
        }
        return tasks;
    }

    private boolean containsCoordinatorRoleAwaitingApproval(FirebirdUser user) {
        Set<ManagedInvestigator> managedInvestigators = user.getRegistrationCoordinatorRole()
                .getManagedInvestigators();
        return Iterables.any(managedInvestigators, new Predicate<ManagedInvestigator>() {
            @Override
            public boolean apply(ManagedInvestigator managedInvestigator) {
                return !managedInvestigator.isApproved();
            }
        });
    }

    private Task createCoordinatorRoleVerificationTask() {
        TaskType taskType = TaskType.COORDINATOR_ROLE_AWAITING_VERIFICATION;
        Date date = new Date();
        Map<FirebirdTemplateParameter, Object> parameters = Collections.emptyMap();
        String description = templateService.generateString(
                FirebirdStringTemplate.COORDINATOR_ROLE_AWAITING_VERIFICATION_TASK_TITLE, parameters);
        return new Task(description, date, taskType, null);
    }

    private List<Task> getCoordinatorRegistrationRenewalTasks(FirebirdUser user) {
        List<Task> registrationRenewalTasks = Lists.newArrayList();
        for (InvestigatorProfile profile : user.getRegistrationCoordinatorRole().getApprovedManagedProfiles()) {
            for (AnnualRegistration registration : profile.getAnnualRegistrationsAwaitingRenewal()) {
                registrationRenewalTasks.add(createCoordinatorRegistrationRenewalTask(registration));
            }
        }
        return registrationRenewalTasks;
    }

    private Task createCoordinatorRegistrationRenewalTask(AnnualRegistration registration) {
        Date date = DateUtils.addDays(registration.getDueDate(),
                -annualRegistrationService.getDaysBeforeDueDateToSendFirstNotification());
        Map<FirebirdTemplateParameter, Object> parameters = Maps.newHashMap();
        parameters.put(FirebirdTemplateParameter.ANNUAL_REGISTRATION, registration);
        String description = templateService
                .generateString(FirebirdStringTemplate.COORDINATOR_REGISTRATION_RENEWAL_TASK_TITLE, parameters);
        return new Task(description, date, TaskType.REGISTRATION_RENEWAL, registration.getId());
    }

    private List<Task> getAnnualRegistrationApprovedTasksForCoordinator(FirebirdUser user) {
        List<Task> tasks = Lists.newArrayList();
        for (InvestigatorProfile profile : user.getRegistrationCoordinatorRole().getApprovedManagedProfiles()) {
            for (AnnualRegistration registration : profile.getAnnualRegistrations()) {
                if (registration.getStatus() == RegistrationStatus.APPROVED
                        && !registration.isApprovalAcknowledgedByCoordinator()) {
                    tasks.add(createAnnualRegistrationApprovedTask(registration,
                            FirebirdStringTemplate.ANNUAL_REGISTRATION_APPROVED_TASK_FOR_COORDINATOR_TITLE));
                }
            }
        }
        return tasks;
    }

    private Task createAnnualRegistrationApprovedTask(AnnualRegistration registration,
            FirebirdStringTemplate taskTitle) {
        Date date = registration.getStatusDate();
        Map<FirebirdTemplateParameter, Object> parameters = Maps.newHashMap();
        parameters.put(FirebirdTemplateParameter.ANNUAL_REGISTRATION, registration);
        String description = templateService.generateString(taskTitle, parameters);
        return new Task(description, date, TaskType.ANNUAL_REGISTRATION_APPROVED, registration.getId());
    }

    private List<Task> getInvestigatorSuspensionNoticeTasks(FirebirdUser coordinator) {
        List<Task> tasks = Lists.newArrayList();
        for (ManagedInvestigator role : coordinator.getRegistrationCoordinatorRole().getManagedInvestigators()) {
            FirebirdUser investigator = role.getInvestigatorProfile().getUser();
            if (isSuspended(investigator)
                    && investigator.getInvestigatorRole().isStatusChangeNotificationRequiredForCoordinator()) {
                tasks.add(createSuspendedInvestigatorCoordinatorNotificationTask(investigator));
            }
        }
        return tasks;
    }

    private boolean isSuspended(FirebirdUser investigator) {
        return investigator.isCtepUser()
                && InvestigatorStatus.SUSPENDED.equals(investigator.getInvestigatorRole().getStatus());
    }

    private Task createSuspendedInvestigatorCoordinatorNotificationTask(FirebirdUser investigator) {
        Date date = new Date();
        Map<FirebirdTemplateParameter, Object> parameters = Maps.newHashMap();
        parameters.put(FirebirdTemplateParameter.INVESTIGATOR, investigator.getPerson());
        AnnualRegistration registration = investigator.getInvestigatorRole().getProfile()
                .getCurrentAnnualRegistration();
        String description = templateService.generateString(
                FirebirdStringTemplate.CTEP_INVESTIGATOR_SUSPENEDED_TASK_TITLE_FOR_COORDINATOR, parameters);
        return new Task(description, date, TaskType.INVESTIGATOR_SUSPENSION_NOTICE, registration.getId());
    }

    private List<Task> getInvestigatorDisqualificationNoticeTasks(FirebirdUser coordinator) {
        List<Task> tasks = Lists.newArrayList();
        for (ManagedInvestigator role : coordinator.getRegistrationCoordinatorRole().getManagedInvestigators()) {
            FirebirdUser investigator = role.getInvestigatorProfile().getUser();
            if (investigator.getInvestigatorRole().getDisqualificationReason() != null && !investigator
                    .getInvestigatorRole().getDisqualificationReason().isAcknowledgedByCoordinator()) {
                tasks.add(createDisqualifiedInvestigatorCoordinatorNotificationTask(investigator));
            }
        }
        return tasks;
    }

    private Task createDisqualifiedInvestigatorCoordinatorNotificationTask(FirebirdUser investigator) {
        Date date = new Date();
        Map<FirebirdTemplateParameter, Object> parameters = Maps.newHashMap();
        parameters.put(FirebirdTemplateParameter.INVESTIGATOR, investigator.getPerson());
        AnnualRegistration registration = investigator.getInvestigatorRole().getProfile()
                .getCurrentAnnualRegistration();
        String description = templateService.generateString(
                FirebirdStringTemplate.CTEP_INVESTIGATOR_DISQUALIFIED_TASK_TITLE_FOR_COORDINATOR, parameters);
        return new Task(description, date, TaskType.INVESTIGATOR_DISQUALIFICATION_NOTICE, registration.getId());
    }
}