|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SharkConnection
Interface used to perform some administrative operations that concern execution engine objects.
The first method to be called by client application is the first method of this interface - connect(), and only if user authentication is OK, other methods can be used (otherwise, every method throws NotConnected exception).
Method Summary | |
---|---|
void |
attachToHandle(WMSessionHandle shandle)
|
void |
connect(WMConnectInfo connectInfo)
This is the first method to be called in order to communicate with the engine. |
void |
disconnect()
Disconnects from shark engine. |
WfActivityIterator |
get_iterator_activity()
|
WfAssignmentIterator |
get_iterator_assignment()
|
WfProcessIterator |
get_iterator_process()
|
WfProcessMgrIterator |
get_iterator_processmgr()
Returns an iterator that can be used to retrieve WfProcessMgr objects that represent appropriate XPDL process definitions, and are used to create new process instances. |
WfResourceIterator |
get_iterator_resource()
Returns an iterator that can be used to retrieve WfResource objects that represent appropriate shark users. |
WfProcessMgr[] |
get_sequence_processmgr(int max_number)
Returns an array of WfProcessMgr objects. |
WfResource[] |
get_sequence_resource(int max_number)
Returns an array of WfResource objects. |
WfActivity |
getActivity(java.lang.String procId,
java.lang.String actId)
Returns WfActivity object that has the given Id, or null if such doesn't exist. |
WfAssignment |
getAssignment(java.lang.String procId,
java.lang.String assId)
Returns WfAssignment object for given Id, or null if such doesn't exist. |
WfAssignment |
getAssignment(java.lang.String procId,
java.lang.String actId,
java.lang.String username)
Returns WfAssignment object for activity with given Id, and resource with the given username, or null if such doesn't exist. |
WfProcess |
getProcess(java.lang.String procId)
Returns WfProcess object that has the given Id, or null if such does not exist. |
WfProcessMgr |
getProcessMgr(java.lang.String name)
Returns WfProcessMgr object that has the given name, or null if such does not exist. |
WfResource |
getResource(java.lang.String username)
Returns WfResource object that has the given username, or null if such doesn't exist. |
WfResource |
getResourceObject()
Returns WfResource object belonging to the user that has been connected to shark through this interface. |
WMSessionHandle |
getSessionHandle()
|
Method Detail |
---|
void connect(WMConnectInfo connectInfo) throws java.lang.Exception
connectInfo
- structure holding connection request data
java.lang.Exception
- If something unexpected happens.void attachToHandle(WMSessionHandle shandle) throws java.lang.Exception
java.lang.Exception
void disconnect() throws java.lang.Exception
java.lang.Exception
- If something unexpected happens.WMSessionHandle getSessionHandle() throws java.lang.Exception
java.lang.Exception
WfResource getResourceObject() throws java.lang.Exception
java.lang.Exception
- If something unexpected happens.WfProcessMgrIterator get_iterator_processmgr() throws java.lang.Exception
java.lang.Exception
- If something unexpected happens.WfProcessMgr[] get_sequence_processmgr(int max_number) throws java.lang.Exception
max_number
- The maximum number of WfProcessMgr instances to be returned. If
set to 0, all existing instances will be returned (this will be equal to
the number of XPDL process definitions in all packages that are loaded
into engine).
java.lang.Exception
- If something unexpected happens.WfResourceIterator get_iterator_resource() throws java.lang.Exception
java.lang.Exception
- If something unexpected happens.WfResource[] get_sequence_resource(int max_number) throws java.lang.Exception
max_number
- The maximum number of WfResource instances to be returned. If set
to 0, all existing instances will be returned.
java.lang.Exception
- If something unexpected happens.WfProcessMgr getProcessMgr(java.lang.String name) throws java.lang.Exception
name
- WfProcessMgr object name.
java.lang.Exception
- If something unexpected happens.WfResource getResource(java.lang.String username) throws java.lang.Exception
username
- username of WfResource instance.
java.lang.Exception
- If something unexpected happens.WfProcess getProcess(java.lang.String procId) throws java.lang.Exception
procId
- process instance Id.
java.lang.Exception
- If something unexpected happens.WfActivity getActivity(java.lang.String procId, java.lang.String actId) throws java.lang.Exception
procId
- activity's process Id.actId
- activity instance Id.
java.lang.Exception
- If something unexpected happens.WfAssignment getAssignment(java.lang.String procId, java.lang.String actId, java.lang.String username) throws java.lang.Exception
procId
- the assignment's activity's process instance Id.actId
- the assignment's activity instance Id.username
- the assignement's username
java.lang.Exception
- If something unexpected happens.WfAssignment getAssignment(java.lang.String procId, java.lang.String assId) throws java.lang.Exception
procId
- the assignment's activity's process instance Id.assId
- the assignment Id.
java.lang.Exception
- If something unexpected happens.WfAssignmentIterator get_iterator_assignment() throws java.lang.Exception
java.lang.Exception
WfProcessIterator get_iterator_process() throws java.lang.Exception
java.lang.Exception
WfActivityIterator get_iterator_activity() throws java.lang.Exception
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |