| java.lang.Object
 com.bigbross.bossa.wfnet.Case
| Case | | public class Case implements Serializable(Code) | | This class represents a specific instance of a case type. It
holds the current state of a case.
author:
BigBross Team |
| Constructor Summary | |
| | Case(CaseType caseType, Map state, Map attributes)
Creates a new case, using the provided token count and attributes.
Appropriate work items are activated according to the provided
data. |
| Method Summary | |
| boolean | cancel(Activity activity)
Cancel an activity. | | boolean | close(Activity activity, Map newAttributes)
Closes and finishes an activity. | | public boolean | closeCase()
Closes this case. | | void | declare(String id, Object value)
Declares an attribute to be used at expression evaluation. | | void | declare(Map attributes)
Declares all the attributes to be used at expression evaluation. | | int | eval(String expression)
Evaluates an integer expression using the local attributes of this
case. | | public List | getActivities()
Returns a list of activities associated with this case. | | public Activity | getActivity(int id)
Returns a specific activity, selected by its id. | | public Map | getAttributes()
Returns the current attributes of this case. | | Bossa | getBossa()
Returns the bossa engine this case is part, if any. | | public CaseType | getCaseType()
Returns the case type of this case. | | public int | getId()
Returns the id of this case. | | ResourceRegistry | getResourceRegistry()
Returns the resource registry with the local resources of this
case. | | public List | getResources()
Returns all local resources of this case. | | public Map | getState()
Returns the state of the case, that is, how many tokens are in each
place. | | public WorkItem | getWorkItem(String id)
Returns a specific work item, selected by its id. | | public List | getWorkItems()
Returns the list of currently fireable work items associated
with this case. | | boolean | isFireable(Transition t)
Indicates if a transition is fireable, that is, if it is an actual
work item. | | boolean | isTemplate()
Indicates if this case is a template case of some case type. | | int | nextActivityId()
Returns the next activity id for this case. | | Activity | open(WorkItem wi, Resource resource)
Opens a work item. | | public void | setState(Map state)
Changes the state of the case, that is, how many tokens are in each
place. | | void | setStateImpl(Map state)
Changes the state of the case, that is, how many tokens are in each
place. |
| Case | | Case(CaseType caseType, Map state, Map attributes) throws BossaException(Code) | | Creates a new case, using the provided token count and attributes.
Appropriate work items are activated according to the provided
data.
Parameters:
caseType - the case type of this case.
Parameters:
state - the initial token count as a map (String, Integer), indexed by the place id.This state map must have a token count for every place.
Parameters:
attributes - the initial attributes as a map (String,Object) of variables names (as used inedge weight expressions) and Java objects. The Javaobjects should be understandable by the underlyingBSF engine being used.
exception:
SetAttributeException - if the underlying expressionevaluation system has problems setting an attribute.
exception:
EvaluationException - if an expression evaluation erroroccurs. |
| cancel | | boolean cancel(Activity activity) throws EvaluationException(Code) | | Cancel an activity. Call this method if the activity could not
be completed. The related work item will return to the list of
available work items and can be opened again.
This method will not persist the result of its activation and should
be used only internally as a part of a persistent transaction.
Parameters:
activity - the activity to be canceled. true if the activity is succesfully canceled,false otherwise.
exception:
EvaluationException - if an expression evaluation erroroccurs. If this exception is thrown the state of this casemay be left inconsistent. |
| close | | boolean close(Activity activity, Map newAttributes) throws BossaException(Code) | | Closes and finishes an activity. Call this method when the
activity is successfully completed.
Closes the Case when the last activity is closed, that is,
no work items to open nor open activities remain.
An attribute mapping should be passed when this method is called.
This is a (String, Object) mapping of
variables names (as used in edge weight expressions) and Java objects.
The Java objects should be understandable by the underlying BSF
engine being used (for JavaScript, Boolean,
Integer and String are known to work).
The attributes provided will overwrite current set attributes and
the value of these attributes will be used when evaluating edge
weights. If you do not want to set any new attribute, use
null as the attribute mapping.
This method will not persist the result of its activation and should
be used only internally as a part of a persistent transaction.
Parameters:
activity - the activity to be closed.
Parameters:
newAttributes - the attributes mapping. true if the activity is succesfully opened,false otherwise.
exception:
SetAttributeException - if the underlying expressionevaluation system has problems setting an attribute.
exception:
EvaluationException - if an expression evaluation erroroccurs. If this exception is thrown the state of this casemay be left inconsistent. |
| closeCase | | public boolean closeCase() throws BossaException(Code) | | Closes this case. A case will close automatically when there are no
active work items. This method should only be used to override
the normal case closing procedure and prematurely abort a case.
true if the case could be closed,false otherwise.
exception:
PersistenceException - if an error occours when making theexecution of this method persistent. |
| declare | | void declare(String id, Object value) throws SetAttributeException(Code) | | Declares an attribute to be used at expression evaluation.
Parameters:
id - the attribute identifier.
Parameters:
value - a Java object with the attribute value. This objectshould be understandable by the underlyingBSF engine being used.
exception:
SetAttributeException - if the underlying expressionevaluation system has problems setting an attribute. |
| declare | | void declare(Map attributes) throws SetAttributeException(Code) | | Declares all the attributes to be used at expression evaluation.
Parameters:
attributes - the attributes to be declared as a map(String, Object) ofvariables names (as used in edge weight expressions)and Java objects. The Java objects should beunderstandable by the underlying BSF engine being used.
exception:
SetAttributeException - if the underlying expressionevaluation system has problems setting an attribute. |
| eval | | int eval(String expression) throws EvaluationException(Code) | | Evaluates an integer expression using the local attributes of this
case.
Parameters:
expression - the expression to be evaluated. The expression result.
exception:
EvaluationException - if an evaluation error occurs. |
| getActivities | | public List getActivities()(Code) | | Returns a list of activities associated with this case.
The list of activities of this case. |
| getActivity | | public Activity getActivity(int id)(Code) | | Returns a specific activity, selected by its id.
Parameters:
id - the activity id. the activity, null if there is no activitywith this id. |
| getAttributes | | public Map getAttributes()(Code) | | Returns the current attributes of this case.
the attributes as an unmodifiable map (String,Object) of variables names (as used inedge weight expressions) and Java objects. |
| getBossa | | Bossa getBossa()(Code) | | Returns the bossa engine this case is part, if any.
the bossa engine this case is part, null if notpart of a bossa engine. |
| getCaseType | | public CaseType getCaseType()(Code) | | Returns the case type of this case.
the case type of this case. |
| getId | | public int getId()(Code) | | Returns the id of this case.
the id of this case. |
| getResourceRegistry | | ResourceRegistry getResourceRegistry()(Code) | | Returns the resource registry with the local resources of this
case.
the resource registry with the local resources of thiscase. |
| getResources | | public List getResources()(Code) | | Returns all local resources of this case.
a list of all local resources of this case. |
| getState | | public Map getState()(Code) | | Returns the state of the case, that is, how many tokens are in each
place.
the token count as a map (String, Integer), indexed by the place id. |
| getWorkItem | | public WorkItem getWorkItem(String id)(Code) | | Returns a specific work item, selected by its id.
Parameters:
id - the work item id. the work item, null if there is no work itemwith this id. |
| getWorkItems | | public List getWorkItems()(Code) | | Returns the list of currently fireable work items associated
with this case.
A list with the fireable work items of this case. |
| isFireable | | boolean isFireable(Transition t) throws EvaluationException(Code) | | Indicates if a transition is fireable, that is, if it is an actual
work item.
Parameters:
t - the transition. true if the transition is fireable;false otherwise.
exception:
EvaluationException - if an expression evaluation erroroccurs. |
| isTemplate | | boolean isTemplate()(Code) | | Indicates if this case is a template case of some case type.
true is this case is a template,false otherwise. |
| nextActivityId | | int nextActivityId()(Code) | | Returns the next activity id for this case.
the next activity id. |
| open | | Activity open(WorkItem wi, Resource resource) throws BossaException(Code) | | Opens a work item. A open work item is represented by
an activity and is locked to the resource who opened it. The actual
completion of the work item in handled by the created activity.
This method will not persist the result of its activation and should
be used only internally as a part of a persistent transaction.
Parameters:
wi - the work item to be opened.
Parameters:
resource - the resource that is opening the work item. The activity created by the opening of this work item,null if the work item could not be opened.
exception:
EvaluationException - if an expression evaluation erroroccurs. If this exception is thrown the state of this casemay be left inconsistent. |
| setState | | public void setState(Map state) throws BossaException(Code) | | Changes the state of the case, that is, how many tokens are in each
place. This method bypasses the usual transition firing process and
should be used with caution to override the normal sequence of
activities.
Parameters:
state - the token count as a map (String, Integer), indexed by the place id. Only theplaces present in this map have their token count modified,the others are unchanged.
exception:
EvaluationException - if an expression evaluation erroroccurs. If this exception is thrown the state of this casemay be left inconsistent. |
| setStateImpl | | void setStateImpl(Map state) throws BossaException(Code) | | Changes the state of the case, that is, how many tokens are in each
place. This method bypasses the usual transition firing process and
should be used with caution to override the normal sequence of
activities.
This method will not persist the result of its activation and should
be used only internally as a part of a persistent transaction.
Parameters:
state - the token count as a map (String, Integer), indexed by the place id. Only theplaces present in this map have their token count modified,the others are unchanged.
exception:
EvaluationException - if an expression evaluation erroroccurs. If this exception is thrown the state of this casemay be left inconsistent. |
|
|