taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/GroupModel.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.taglibs.rdc.core;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * <p>This is the book-keeping class for the RDC container
 * <b>group</b>.</p>
 * 
 * @author Abhishek Verma
 * @author Rahul Akolkar
 */

public class GroupModel extends BaseModel 
    implements Serializable{

    // Serial Version UID
    private static final long serialVersionUID = 1L;
    // The map of datamodel of child RDCs; keyed by id 
    protected Map localMap;
    // The object that group confirmation is outsourced to
    protected GroupConfirm groupConfirm;
    // The list of currently active children
    // An active child is defined as one that is neither DORMANT nor DONE
    protected List activeChildren;
    // Strategy specific instance data that needs to be cached
    protected transient Object instanceData;
    
    public GroupModel() {
        super();
        this.localMap = new LinkedHashMap();
        this.activeChildren = new ArrayList();
        this.instanceData = null;
    } // GroupModel constructor
   
    
    /** 
     * Get the map of child RDC datamodels
     * 
     * @return the map of child RDC datamodels
     */
    public Map getLocalMap() {
        return localMap;
    }
    
    /**
     * Set the map of child RDC datamodels
     * 
     * @param localMap The map of child RDC datamodels
     */
    public void setLocalMap(Map localMap) {
        this.localMap = localMap;
    }
  
    /**
     * Get the GroupConfirm object
     * 
     * @return groupConfirm the group confirmation object
     */
    public GroupConfirm getGroupConfirm() {
        return groupConfirm;
    }

    /**
     * Set the GroupConfirm
     * 
     * @param groupConfirm The confirmation setting for this group
     */
    public void setGroupConfirm(GroupConfirm groupConfirm) {
        this.groupConfirm = groupConfirm;
    }

    /**
     * Get the currently active children (not in dormant or done state)
     * 
     * @return activeChildren
     */
    public List getActiveChildren() {
        return activeChildren;
    }

    /**
     * Set the currently active children
     * 
     * @param list
     */
    public void setActiveChildren(List list) {
        activeChildren = list;
    }
    
    /**
     * Get the instance data
     * 
     * @return Returns the instanceData.
     */
    public Object getInstanceData() {
        return instanceData;
    }
    
    /**
     * Set the instance data
     * 
     * @param instanceData The instanceData to set.
     */
    public void setInstanceData(Object instanceData) {
        this.instanceData = instanceData;
    }
}