utilactivity.java

Sequoia ERP是一个真正的企业级开源ERP解决方案。它提供的模块包括：电子商务应用(e-commerce), POS系统(point of sales),知识管理,存货与仓库管理

/*
 * Copyright (C) 2006  Open Source Strategies, Inc.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
/* Copyright (c) 2005-2006 Open Source Strategies, Inc. */

/*
 *  $Id:$
 *
 *  Copyright (c) 2001-2005 The Open For Business Project - www.ofbiz.org
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a
 *  copy of this software and associated documentation files (the "Software"),
 *  to deal in the Software without restriction, including without limitation
 *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
 *  and/or sell copies of the Software, and to permit persons to whom the
 *  Software is furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included
 *  in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 *  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
 *  OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
 *  THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package com.opensourcestrategies.crmsfa.activities;

import java.util.Map;
import java.util.List;
import java.util.ArrayList;
import java.util.Iterator;
import java.sql.Timestamp;

import org.ofbiz.base.util.Debug;
import org.ofbiz.base.util.UtilMisc;
import org.ofbiz.base.util.UtilDateTime;
import org.ofbiz.entity.GenericDelegator;
import org.ofbiz.entity.GenericValue;
import org.ofbiz.entity.GenericEntityException;
import org.ofbiz.entity.condition.EntityConditionList;
import org.ofbiz.entity.condition.EntityExpr;
import org.ofbiz.entity.condition.EntityOperator;
import org.ofbiz.entity.util.EntityFindOptions;
import org.ofbiz.entity.util.EntityUtil;
import org.ofbiz.entity.util.EntityListIterator;

import com.opensourcestrategies.crmsfa.party.PartyHelper;

/**
 * Activity utility methods.
 *
 * @author     <a href="mailto:[e-mail]">Leon Torres</a>
 * @version    $Rev: 5 $
 */
public class UtilActivity {

    public static final String module = UtilActivity.class.getName();

    // list the activity statuses in one place in case the model changes
    public static List ACT_STATUSES_PENDING = null;
    public static List ACT_STATUSES_COMPLETED = null;
    static {
        ACT_STATUSES_COMPLETED = UtilMisc.toList("TASK_COMPLETED", "TASK_CANCELLED", "TASK_REJECTED", "EVENT_COMPLETED", "EVENT_CANCELLED", "EVENT_REJECTED");
        ACT_STATUSES_PENDING = UtilMisc.toList("TASK_SCHEDULED", "TASK_CONFIRMED", "TASK_ON_HOLD", "EVENT_SCHEDULED", "EVENT_CONFIRMED", "EVENT_ON_HOLD");
        ACT_STATUSES_PENDING.add("TASK_STARTED");
        ACT_STATUSES_PENDING.add("EVENT_STARTED");
    }

    /**
     * gets all unexpired parties related to the work effort. The result is a list of WorkEffortPartyAssignments containing
     * the partyIds we need.
     */
    public static List getActivityParties(GenericDelegator delegator, String workEffortId) throws GenericEntityException {
        // add each role type id (ACCOUNT, CONTACT, etc) to an OR condition list
        List roleCondList = new ArrayList();
        for (Iterator iter = PartyHelper.CLIENT_PARTY_ROLES.iterator(); iter.hasNext(); ) {
            String roleTypeId = (String) iter.next();
            roleCondList.add(new EntityExpr("roleTypeId", EntityOperator.EQUALS, roleTypeId));
        }
        EntityConditionList roleEntityCondList = new EntityConditionList(roleCondList, EntityOperator.OR);

        // roleEntityCondList AND workEffortId = ${workEffortId} AND filterByDateExpr
        EntityConditionList mainCondList = new EntityConditionList(UtilMisc.toList(
                    roleEntityCondList,
                    new EntityExpr("workEffortId", EntityOperator.EQUALS, workEffortId), 
                    EntityUtil.getFilterByDateExpr()
                    ), EntityOperator.AND);

        EntityListIterator partiesIt = delegator.findListIteratorByCondition("WorkEffortPartyAssignment", mainCondList, null,
                UtilMisc.toList("partyId"),  // fields to select (right now we just want the partyId)
                null, // fields to order by (unimportant here)
                new EntityFindOptions(true, EntityFindOptions.TYPE_SCROLL_INSENSITIVE, EntityFindOptions.CONCUR_READ_ONLY, true));
        return partiesIt.getCompleteList();
    }

    /**
     * Helper method to delete all the associations related to a work effort.
     * TODO: make this more intelligent so it doesn't delete if the association has not changed
     *       and then rename this to removeUpdatedAssociationsForWorkEffort
     */
    public static void removeAllAssociationsForWorkEffort(String workEffortId, GenericDelegator delegator) throws GenericEntityException {

        // delete any existing opportunity relationships
        List oldAssocs = delegator.findByAnd("SalesOpportunityWorkEffort", UtilMisc.toMap("workEffortId", workEffortId));
        for (Iterator iter = oldAssocs.iterator(); iter.hasNext(); ) {
            GenericValue old = (GenericValue) iter.next();
            // TODO: deleted by hand because we don't have a service yet
            old.remove(); 
        }

        // delete any existing case relationships
        oldAssocs = delegator.findByAnd("CustRequestWorkEffort", UtilMisc.toMap("workEffortId", workEffortId));
        for (Iterator iter = oldAssocs.iterator(); iter.hasNext(); ) {
            GenericValue old = (GenericValue) iter.next();
            // TODO: add permissions to deleteWorkEffortRequest and use that service, otherwise it's exactly identical to the following line
            old.remove(); 
        }

        // delete existing party relationships with roles like ACCOUNT, CONTACT, PROSPECT
        for (Iterator iter = PartyHelper.CLIENT_PARTY_ROLES.iterator(); iter.hasNext(); ) {
            oldAssocs = EntityUtil.filterByDate(delegator.findByAnd("WorkEffortPartyAssignment",
                        UtilMisc.toMap("workEffortId", workEffortId, "roleTypeId", iter.next())));
            for (Iterator inner = oldAssocs.iterator(); inner.hasNext(); ) {
                GenericValue assoc = (GenericValue) inner.next();
                assoc.set("thruDate", UtilDateTime.nowTimestamp());
                assoc.store();
            }
        }
    }

    /**
     * Helper method to check if a userLogin has any TASK or EVENT conflicts between two timestamps.
     * It will search the WorkEffortAndPartyAssign view for all EVENT_SCHEDULED events
     * that the user marked as availabilityStatusId=WEPT_AV_BUSY or WEPT_AV_AWAY, and
     * statusId=PRTYASGN_ASSIGNED, and filter out those that fall outside the specified duration. 
     *
     * @param   workEffortId    if specified, filters out the work effort ID
     * @return  List of events/tasks that the user conflicts with
     */
    public static List getActivityConflicts(GenericValue userLogin, Timestamp start, Timestamp end, String workEffortId) throws GenericEntityException {
        GenericDelegator delegator = userLogin.getDelegator();
        List conditions = UtilMisc.toList(
                new EntityExpr("partyId", EntityOperator.EQUALS, userLogin.getString("partyId")),
                new EntityConditionList(
                    UtilMisc.toList(
                        new EntityExpr("currentStatusId", EntityOperator.EQUALS, "EVENT_SCHEDULED"),
                        new EntityExpr("currentStatusId", EntityOperator.EQUALS, "TASK_SCHEDULED")
                        ), EntityOperator.OR
                    ),
                new EntityExpr("statusId", EntityOperator.EQUALS, "PRTYASGN_ASSIGNED"),
                new EntityConditionList(
                    UtilMisc.toList(
                        new EntityExpr("availabilityStatusId", EntityOperator.EQUALS, "WEPA_AV_BUSY"),
                        new EntityExpr("availabilityStatusId", EntityOperator.EQUALS, "WEPA_AV_AWAY")
                        ), EntityOperator.OR
                    ),
                new EntityConditionList(
                    UtilMisc.toList(
                        EntityUtil.getFilterByDateExpr(start, "estimatedStartDate", "estimatedCompletionDate"),
                        EntityUtil.getFilterByDateExpr(end, "estimatedStartDate", "estimatedCompletionDate")
                        ), EntityOperator.OR
                    )
                );
        if (workEffortId != null) conditions.add(new EntityExpr("workEffortId", EntityOperator.NOT_EQUAL, workEffortId));
        EntityConditionList cond = new EntityConditionList(conditions, EntityOperator.AND);
        return delegator.findByCondition("WorkEffortAndPartyAssign", cond, UtilMisc.toList("workEffortId"), null);
    }

    /**
     * As above, but for all work efforts.
     */
    public static List getActivityConflicts(GenericValue userLogin, Timestamp start, Timestamp end) throws GenericEntityException {
        return getActivityConflicts(userLogin, start, end, null);
    }

    /**
     * Determine if the activity has a status which should be considered "finished" or "history" or "done with".
     * It is recommended to use this instead of checking ACT_STATUSES_COMPLETED directly or testing the statuses by hand
     */
    public static boolean activityIsInactive(GenericValue activity) {
        for (Iterator iter = ACT_STATUSES_COMPLETED.iterator(); iter.hasNext(); ) {
            if (iter.next().equals(activity.getString("currentStatusId"))) {
                return true;
            }
        }
        return false;
    }
}