001: package org.tigris.scarab.workflow;
002:
003: /* ================================================================
004: * Copyright (c) 2000-2002 CollabNet. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: import java.util.Map;
050: import java.util.List;
051:
052: import org.apache.torque.TorqueException;
053: import org.tigris.scarab.om.ScarabUser;
054: import org.tigris.scarab.om.Issue;
055: import org.tigris.scarab.om.Module;
056: import org.tigris.scarab.om.IssueType;
057: import org.tigris.scarab.om.AttributeOption;
058: import org.tigris.scarab.om.OptionWorkflow;
059: import org.tigris.scarab.om.Attribute;
060: import org.tigris.scarab.om.WorkflowRules;
061: import org.tigris.scarab.util.ScarabException;
062:
063: /**
064: * This is the primary interface for workflow within Scarab.
065: * Implementations of this interface are loaded through the
066: * WorkflowFactory interface. It gets which class to load
067: * from the Scarab.properties file.
068: *
069: * @author <a href="mailto:elicia@tigris.org">Elicia David</a>
070: * @version $Id: Workflow.java 10144 2006-06-05 18:36:19Z dabbous $
071: */
072: public interface Workflow {
073: boolean canMakeTransition(ScarabUser user,
074: AttributeOption fromOption, AttributeOption toOption,
075: Issue issue) throws ScarabException;
076:
077: /**
078: * Returns the list of transitions allowed for the current user
079: * in the current module/issueType/attribute combination
080: * @throws TorqueException
081: */
082: public List getTransitions(ScarabUser user, IssueType issueType,
083: Attribute attribute) throws ScarabException;
084:
085: /**
086: * Returns the tree of transitions
087: * in the current module/issueType/attribute combination.
088: * @throws TorqueException
089: */
090: public TransitionNode getTransitionTree(ScarabUser user,
091: IssueType issueType, Attribute attribute)
092: throws ScarabException;
093:
094: /**
095: * Returns the list of transitions allowed for the current user
096: * in the current module/issueType/attribute combination
097: * starting from fromOption.
098: * @throws TorqueException
099: */
100: public List getTransitionsFrom(ScarabUser user,
101: IssueType issueType, Attribute attribute,
102: AttributeOption fromOption) throws ScarabException;
103:
104: public boolean canMakeTransitionsFrom(ScarabUser user,
105: IssueType issueType, Attribute attribute,
106: AttributeOption fromOption) throws ScarabException;
107:
108: String checkTransition(AttributeOption fromOption,
109: AttributeOption toOption, Issue issue, Map newAttVals,
110: ScarabUser user) throws ScarabException;
111:
112: String checkInitialTransition(AttributeOption toOption,
113: Issue issue, Map newAttVals, ScarabUser user)
114: throws ScarabException;
115:
116: OptionWorkflow getWorkflowForRole(AttributeOption fromOption,
117: AttributeOption toOption, String roleName, Module module,
118: IssueType issueType) throws ScarabException;
119:
120: List getWorkflowsForRoleList(AttributeOption fromOption,
121: AttributeOption toOption, List roleNames, Module module,
122: IssueType issueType) throws ScarabException;
123:
124: List getWorkflowsForIssueType(IssueType issueType)
125: throws ScarabException;
126:
127: void saveWorkflow(AttributeOption fromOption,
128: AttributeOption toOption, String roleName, Module module,
129: IssueType issueType, WorkflowRules workflowRule)
130: throws ScarabException;
131:
132: OptionWorkflow inherit(AttributeOption fromOption,
133: AttributeOption toOption, String roleName, Module module,
134: IssueType issueType) throws ScarabException;
135:
136: void resetWorkflow(AttributeOption fromOption,
137: AttributeOption toOption, String roleName, Module module,
138: IssueType issueType) throws ScarabException;
139:
140: void resetWorkflows(String roleName, Module module,
141: IssueType issueType, boolean initial)
142: throws ScarabException;
143:
144: void deleteWorkflowsForOption(AttributeOption option,
145: Module module, IssueType issueType) throws ScarabException;
146:
147: void deleteWorkflowsForAttribute(Attribute attr, Module module,
148: IssueType issueType) throws ScarabException;
149:
150: void addIssueTypeWorkflowToModule(Module module, IssueType issueType)
151: throws ScarabException;
152:
153: void copyIssueTypeWorkflows(IssueType issueType,
154: IssueType newIssueType) throws ScarabException;
155:
156: void resetAllWorkflowsForIssueType(Module module,
157: IssueType issueType) throws ScarabException;
158:
159: }
|