|
| |
|
| de.danet.an.workflow.localapi.ActivityLocal
| Method Summary | |
| void | abandon(String exceptionName)
Force the completion of this activity, leaving it in state
"closed.completed.abandoned". | | Info | activityInfo()
This method returns all available information about the
activity in a single operation. | | String | blockActivity()
Returns the key of the "parent" block activity. | | void | changeAssignment(WfResource oldResource, WfResource newResource)
Change an assignment for enacting the activity. | | boolean | choose()
Makes this activity the chosen one in a set of activities
started by an AND split with the "deferred choice" option
set. | | DeadlineInfo[] | deadlines()
Returns the deadlines defined for this activity. | | Implementation | executor()
Returns the current executor. | | WfResource | getResource(WfAssignment asnmnt)
Get the resource associated with an Assignment. | | String[] | handledExceptions()
Returns the names of the exceptions handled by this activity. | | Implementation[] | implementation()
Returns the implementation of the activity as
de.danet.an.workflow.localapi.ActivityLocal.ImplementationImplementation s. | | JoinAndSplitMode | joinMode()
Returns the join mode. | | List | nextActivities()
Returns the list of activities that may follow this activity,
i.e. | | String | performer()
Returns the performer as string. | | void | removeAssignment(WfResource resource)
Removes an assignment for enacting the activity. | | JoinAndSplitMode | splitMode()
Returns the split mode. | | ActivityUniqueKey | uniqueKey()
Return a unique key for the activity. |
| abandon | | void abandon(String exceptionName) throws TransitionNotAllowedException(Code) | | Force the completion of this activity, leaving it in state
"closed.completed.abandoned". Does nothing if the activity is
in state "closed" already or has not been started
("open.not_running.not_started").
An abandoned activity is considered to be completed under
exceptional circumstances. Therefore only transitions with
conditions of type EXCEPTION or
DEFAULTEXCEPTION are considered when evaluating
the set of subsequent activities. The argument is the name of
the exception which may be used to distinguish different
exceptions in transition evaluation (see XPDL).
This method should be used with care. In general, exceptions
have a different level of abstraction in a workflow process
description than in Java programming. The author of a workflow
process should not have to know about e.g. a
"SAXException". But he may know what to do in case of a
"ResultInvalid" exception (though this kind of problem should
only arise during development anyway).
This method may only be called during tool execution. Note that
calling this method does not terminate tool execution, i.e. the
method will return. A tool agent should, however, not try to do
anything with the activity any more after calling this method.
Parameters:
exceptionName - the name of the exception
throws:
TransitionNotAllowedException - if the activity is notexecuting a tool |
| activityInfo | | Info activityInfo()(Code) | | This method returns all available information about the
activity in a single operation.
the resulting Activity.Info value |
| blockActivity | | String blockActivity()(Code) | | Returns the key of the "parent" block activity. All activities
implicitly created by a block activity share the same block
activity key.
Note that there need not be an activity with the returned key,
as an activity set is actually a template describing how to
implement block activities. The information obtained can mainly
be used to group all activities that have been instantiated as
part of an activity set.
an identification of the block activity that causedthis activity to be instantiated or null if thisactivity was not instantiated as part of an activity set |
| changeAssignment | | void changeAssignment(WfResource oldResource, WfResource newResource) throws InvalidResourceException, AlreadyAssignedException, NotAssignedException(Code) | | Change an assignment for enacting the activity. This method calls
the corresponding method of the resource assignment service and
creates the appropriate audit event.
This method is intended to be used by resource assignment
systems for implementing
de.danet.an.workflow.localcoreapi.WfAssignment.setAssigneeWfAssignment.setAssignee . Resource assignment
systems are responsible for implementing
WfAssignment and could therefore perform the
reassignment directly; this would, however, leave the
generation of notifications unexecuted.
Clients should not use this method but rather call
de.danet.an.workflow.localcoreapi.WfAssignment.setAssigneeWfAssignment.setAssignee .
Parameters:
oldResource - the resource that has its assignment removed
Parameters:
newResource - the resource to be assigned
throws:
InvalidResourceException - if the resource is invalid.As the environment is a concurrent multi user environment, WfResource objects may become invalid.
throws:
AlreadyAssignedException - if the assignment alreadyexists
throws:
NotAssignedException - if there is no assignment to theold resource |
| choose | | boolean choose() throws TransitionNotAllowedException(Code) | | Makes this activity the chosen one in a set of activities
started by an AND split with the "deferred choice" option
set. All other activities in the set are reset to their initial
state.
If the activity does not participate in a deferred choice,
this method does nothing and returns true.
true if the activity could be made theeffectively chosen one
throws:
TransitionNotAllowedException - if the activity isneither running nor suspended |
| deadlines | | DeadlineInfo[] deadlines()(Code) | | Returns the deadlines defined for this activity.
the deadlines |
| executor | | Implementation executor()(Code) | | Returns the current executor.
current executor or null if no executorrunning |
| getResource | | WfResource getResource(WfAssignment asnmnt)(Code) | | Get the resource associated with an Assignment. The method calls
the corresponding method of the resource assignment service.
This method is intended to be used by resource assignment
systems for implementing
de.danet.an.workflow.localcoreapi.WfAssignment.assigneeWfAssignment.assignee .
Clients should not use this method but rather call
de.danet.an.workflow.localcoreapi.WfAssignment.assigneeWfAssignment.assignee .
Parameters:
asnmnt - the assignment the resource |
| handledExceptions | | String[] handledExceptions()(Code) | | Returns the names of the exceptions handled by this activity.
handled exceptions |
| implementation | | Implementation[] implementation()(Code) | | Returns the implementation of the activity as
de.danet.an.workflow.localapi.ActivityLocal.ImplementationImplementation s.
an array of Implementation}s ornull if no implementation is defined |
| joinMode | | JoinAndSplitMode joinMode()(Code) | | Returns the join mode.
join mode |
| nextActivities | | List nextActivities()(Code) | | Returns the list of activities that may follow this activity,
i.e. to which transitions exist.
the list of ActivityLocal Activity objects. |
| performer | | String performer()(Code) | | Returns the performer as string.
performer as string |
| removeAssignment | | void removeAssignment(WfResource resource) throws InvalidResourceException, NotAssignedException(Code) | | Removes an assignment for enacting the activity. This method calls
the corresponding method of the resource assignment service and
creates the appropriate audit event.
This method is intended to be used by resource management
systems for implementing
WfResource.releaseWfResource.release .
Clients should not use this
method but rather call
WfResource.releaseWfResource.release .
Parameters:
resource - the resource whose assignment is to be canceled
throws:
InvalidResourceException - if the resource is invalid.As the environment is a concurrent multi user environment, WfResource objects may become invalid.
throws:
NotAssignedException - if there is no such assignment |
| splitMode | | JoinAndSplitMode splitMode()(Code) | | Returns the split mode.
split mode |
|
|
|