uidisplayobjectattribwebeventprocessor.java

国外的一套开源CRM

/*
 * 
 * Copyright (c) 2004 SourceTap - www.sourcetap.com
 *
 *  The contents of this file are subject to the SourceTap Public License 
 * ("License"); You may not use this file except in compliance with the 
 * License. You may obtain a copy of the License at http://www.sourcetap.com/license.htm
 * Software distributed under the License is distributed on an  "AS IS"  basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific language governing rights and limitations under the License.
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 */

package com.sourcetap.sfa.customization;

import java.util.HashMap;
import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.ofbiz.base.util.Debug;
import org.ofbiz.entity.GenericDelegator;
import org.ofbiz.entity.GenericEntityException;
import org.ofbiz.entity.GenericValue;
import org.ofbiz.entity.model.ModelEntity;

import com.sourcetap.sfa.event.DataMatrix;
import com.sourcetap.sfa.event.GenericEventProcessor;
import com.sourcetap.sfa.event.GenericWebEventProcessor;
import com.sourcetap.sfa.ui.UICache;
import com.sourcetap.sfa.ui.UIWebScreenSection;
import com.sourcetap.sfa.util.UserInfo;


/**
 * DOCUMENT ME!
 *
 */
public class UIDisplayObjectAttribWebEventProcessor
    extends GenericWebEventProcessor {
		public static final String module = UIDisplayObjectAttribWebEventProcessor.class.getName();

    /**
     * DOCUMENT ME!
     *
     * @param userInfo 
     * @param uiWebScreenSection 
     * @param request 
     * @param response 
     * @param delegator 
     * @param eventProcessor 
     * @param dataMatrix 
     * @param uiCache 
     *
     * @return 
     */
    protected int postUpdate(UserInfo userInfo,
        UIWebScreenSection uiWebScreenSection, HttpServletRequest request,
        HttpServletResponse response, GenericDelegator delegator,
        GenericEventProcessor eventProcessor, DataMatrix dataMatrix,
        UICache uiCache) {

        // Clear UI cache.
        uiCache.clear();

        return STATUS_CONTINUE;
    }

    /**
     * DOCUMENT ME!
     *
     * @param userInfo 
     * @param uiWebScreenSection 
     * @param request 
     * @param response 
     * @param delegator 
     * @param eventProcessor 
     * @param dataMatrix 
     * @param uiCache 
     *
     * @return 
     */
    protected int postInsert(UserInfo userInfo,
        UIWebScreenSection uiWebScreenSection, HttpServletRequest request,
        HttpServletResponse response, GenericDelegator delegator,
        GenericEventProcessor eventProcessor, DataMatrix dataMatrix,
        UICache uiCache) {

        // Clear UI cache.
        uiCache.clear();

        return STATUS_CONTINUE;
    }

    /**
     * DOCUMENT ME!
     *
     * @param userInfo 
     * @param uiWebScreenSection 
     * @param request 
     * @param response 
     * @param delegator 
     * @param eventProcessor 
     * @param primaryME 
     * @param fields 
     * @param uiCache 
     *
     * @return 
     */
    protected int postDelete(UserInfo userInfo,
        UIWebScreenSection uiWebScreenSection, HttpServletRequest request,
        HttpServletResponse response, GenericDelegator delegator,
        GenericEventProcessor eventProcessor, ModelEntity primaryME,
        HashMap fields, UICache uiCache) {

        // Clear UI cache.
        uiCache.clear();

        return STATUS_CONTINUE;
    }

    /**
     * DOCUMENT ME!
     *
     * @param userInfo 
     * @param uiWebScreenSection 
     * @param request 
     * @param response 
     * @param delegator 
     * @param eventProcessor 
     * @param dataMatrix 
     * @param entityNameList 
     *
     * @return 
     */
    protected int postCreate(UserInfo userInfo,
        UIWebScreenSection uiWebScreenSection, HttpServletRequest request,
        HttpServletResponse response, GenericDelegator delegator,
        GenericEventProcessor eventProcessor, DataMatrix dataMatrix,
        List entityNameList) {

        // Get the empty generic value.
        GenericValue displayObjectAttribGV = dataMatrix.getCurrentBuffer()
                                                       .getGenericValue(0, 0);

        // Set default values on the new record so they will be displayed for the user to see before saving.
        // This is done here instead of the regular event processor because the values have to be read from the
        // request object parameters.
        // Display Object ID
        String displayObjectId = (request.getParameter("displayObjectId") == null)
            ? "" : request.getParameter("displayObjectId");

        displayObjectAttribGV.set("displayObjectId", displayObjectId);

        // Display Type ID
        HashMap uiDisplayObjectFindMap = new HashMap();
        uiDisplayObjectFindMap.put("displayObjectId", displayObjectId);

        try {
            GenericValue uiDisplayObjectGV = delegator.findByPrimaryKey("UiDisplayObject",
                    uiDisplayObjectFindMap);
            String displayTypeId = uiDisplayObjectGV.getString("displayTypeId");

            displayObjectAttribGV.set("displayTypeId", displayTypeId);
        } catch (GenericEntityException e) {
            Debug.logError(
                "[UIDisplayObjectAttribEventProcessor.postCreate] Error while looking for display object: " +
                e.getLocalizedMessage(), module);
        }

        return STATUS_CONTINUE;
    }

    /**
     * This function gets the application path to be used to reconstruct the URI when a
     * UI History record is logged.  Example: "/accounts"
     * @author  John Nutting
     * @param url The URL used to open the screen section
     * @return String containing the application path
     */
    protected String getUiHistoryAppPath(String url) {
        return "/uiDisplayObjectAttribHeader";
    }

    /**
     * This function gets the description to store in the UI history table.  This description
     * will show up in the UI History drop list.
     * @author  John Nutting
     * @param dataMatrix DataMatrix object containing the data from the screen
     * @param delegator Generic delegator through which the data base is accessed
     * @param action The action being performed on the screen
     * @param uiWebScreenSection The UIWebScreenSection being used to construct the screen section
     * @return String containing the UI History description
     */
    protected String getUiHistoryDescription(DataMatrix dataMatrix,
        GenericDelegator delegator, String action,
        UIWebScreenSection uiWebScreenSection) {
        GenericValue primaryGV = dataMatrix.getCurrentBuffer().getGenericValue(0,
                0);

        return "Display Obj Attrib: " + primaryGV.getString("displayObjectId") +
        "/" + primaryGV.getString("displayTypeId") + "/" +
        primaryGV.getString("displayAttribId");
    }
}