001: /*
002: * $Id: WfActivity.java,v 1.1 2003/08/17 09:29:33 ajzeneski Exp $
003: *
004: * Copyright (c) 2001, 2002 The Open For Business Project - www.ofbiz.org
005: *
006: * Permission is hereby granted, free of charge, to any person obtaining a
007: * copy of this software and associated documentation files (the "Software"),
008: * to deal in the Software without restriction, including without limitation
009: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
010: * and/or sell copies of the Software, and to permit persons to whom the
011: * Software is furnished to do so, subject to the following conditions:
012: *
013: * The above copyright notice and this permission notice shall be included
014: * in all copies or substantial portions of the Software.
015: *
016: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
017: * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
018: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
019: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
020: * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
021: * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
022: * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
023: *
024: */
025: package org.ofbiz.workflow;
026:
027: import java.util.List;
028: import java.util.Iterator;
029: import java.util.Map;
030:
031: /**
032: * WfActivity - Workflow Activity Interface
033: *
034: * @author <a href="mailto:jaz@ofbiz.org">Andy Zeneski</a>
035: * @version $Revision: 1.1 $
036: * @since 2.0
037: */
038: public interface WfActivity extends WfExecutionObject {
039:
040: /**
041: * Retrieve amount of Assignment objects.
042: * @throws WfException General workflow exception.
043: * @return Amount of current assignments.
044: */
045: public int howManyAssignment() throws WfException;
046:
047: /**
048: * Retrieve the Iterator of Assignments objects.
049: * @throws WfException General workflow exception.
050: * @return Assignment Iterator.
051: */
052: public Iterator getIteratorAssignment() throws WfException;
053:
054: /**
055: * Retrieve all assignments of this activity.
056: * @param maxNumber the high limit of number of assignment in result set (0 for all).
057: * @throws WfException General workflow exception.
058: * @return List of WfAssignment objects.
059: */
060: public List getSequenceAssignment(int maxNumber) throws WfException;
061:
062: /**
063: * Check if a specific assignment is a member of this activity.
064: * @param member Assignment object.
065: * @throws WfException General workflow exception.
066: * @return true if the assignment is a member of this activity.
067: */
068: public boolean isMemberOfAssignment(WfAssignment member)
069: throws WfException;
070:
071: /**
072: * Getter for the process of this activity.
073: * @throws WfException General workflow exception.
074: * @return WfProcess Process to which this activity belong.
075: */
076: public WfProcess container() throws WfException;
077:
078: /**
079: * Retrieve the Result map of this activity.
080: * @throws WfException General workflow exception.
081: * @throws ResultNotAvailable No result is available.
082: * @return Map of results from this activity
083: */
084: public Map result() throws WfException, ResultNotAvailable;
085:
086: /**
087: * Assign Result for this activity.
088: * @param newResult New result.
089: * @throws WfException General workflow exception.
090: * @throws InvalidData Data is invalid
091: */
092: public void setResult(Map result) throws WfException, InvalidData;
093:
094: /**
095: * Complete this activity.
096: * @throws WfException General workflow exception.
097: * @throws CannotComplete Cannot complete the activity
098: */
099: public void complete() throws WfException, CannotComplete;
100:
101: /**
102: * Activates this activity.
103: * @throws WfException
104: * @throws CannotStart
105: * @throws AlreadyRunning
106: */
107: public void activate() throws WfException, CannotStart,
108: AlreadyRunning;
109:
110: } // interface WfActivity
|