public class EngineClient extends AbstractEngineClient
Modifier and Type | Field and Description |
---|---|
protected InterfaceBWebsideController |
_controller |
protected WorkletEventServer |
_server |
_defaultURI, _engineLogonName, _engineLogonPassword, _engineURI, _interfaceAClient, _interfaceBClient, _log, _serviceName, _serviceURI, _sessionHandle, ADMIN_STR, FAIL_STR, SUCCESS_STR, WORKITEM_ERR
Constructor and Description |
---|
EngineClient(java.lang.String logonName,
java.lang.String password,
InterfaceBWebsideController controller) |
Modifier and Type | Method and Description |
---|---|
void |
addIXListener() |
java.lang.String |
cancelWorkItem(java.lang.String wirID) |
boolean |
cancelWorkletCase(WorkletRunner runner)
Cancels an executing worklet process
|
void |
checkCacheForWorkItem(WorkItemRecord wir) |
protected java.util.Set<WorkItemRecord> |
checkOutChildren(WorkItemRecord wir)
Checks out all the child workitems of the parent item specified
|
WorkItemRecord |
checkOutFiredWorkItem(WorkItemRecord wir) |
java.util.Set<WorkItemRecord> |
checkOutItem(WorkItemRecord wir)
Manages the checking out of a workitem and its children
|
protected boolean |
checkOutWorkItem(WorkItemRecord wir)
Check the workitem out of the engine
|
WorkItemRecord |
continueWorkItem(java.lang.String wirID) |
boolean |
declineWorkItem(WorkItemRecord wir,
java.lang.String eventType) |
java.lang.String |
failWorkItem(WorkItemRecord wir) |
java.lang.String |
forceCompleteWorkItem(WorkItemRecord wir,
Element data) |
WorkItemRecord |
getEngineStoredWorkItem(java.lang.String wirID) |
WorkItemRecord |
getEngineStoredWorkItem(WorkItemRecord wir) |
java.util.List<YParameter> |
getInputParams(YSpecificationID specId)
get the list of input params for a specified specification
|
java.util.List<WorkItemRecord> |
getLiveWorkItemsForIdentifier(java.lang.String idType,
java.lang.String id)
Retrieves a List of live workitems for the case or spec id passed
|
java.util.List<WorkItemRecord> |
getLiveWorkItemsForSpec(YSpecificationID specID) |
WorkletEventServer |
getServer() |
SpecificationData |
getSpecData(YSpecificationID specID) |
YSpecificationID |
getSpecificationIDForCase(java.lang.String caseID) |
Element |
getStartingData(java.lang.String wirID) |
java.util.List<YParameter> |
getTaskInputParams(WorkItemRecord wir) |
protected WorkletRunner |
launchWorklet(WorkItemRecord wir,
YSpecificationID specID,
Element data,
RuleType ruleType)
Starts a worklet case executing in the engine
|
java.util.Set<WorkletRunner> |
launchWorkletList(WorkItemRecord wir,
Element data,
java.util.Set<WorkletSpecification> specs,
RuleType ruleType)
Launches each of the worklets listed in the wr for starting
|
java.lang.String |
mapItemParamsToWorkletCaseParams(WorkItemRecord wir,
Element itemData,
YSpecificationID workletSpecID)
Maps the values of the data attributes in the datalist of a
checked out workitem to the input params of the worklet case that will
run as a substitute for the checked out workitem.
|
void |
rejectAnnouncedEnabledTask(java.lang.String wirID) |
java.lang.String |
restartWorkItem(java.lang.String wirID) |
void |
setupIXClient() |
void |
undoCheckOutWorkItem(WorkItemRecord child)
Returns control of a workitem back to the engine for processing, in the event
that there is no matching rule found in the ruleset, given the context of the
item.
|
java.lang.String |
updateCaseData(java.lang.String caseID,
Element data) |
java.lang.String |
updateWorkItemData(WorkItemRecord wir,
Element data) |
java.lang.String |
uploadWorklet(java.lang.String workletXML) |
boolean |
uploadWorklet(WorkletSpecification worklet)
Uploads a worklet specification into the engine
|
addExternalClient, addRegisteredService, canAddNewInstance, cancelCase, connected, createNewWorkItemInstance, engineIsAvailable, fail, getAdminUserPassword, getAllLiveWorkItems, getAllRunningCaseIDs, getAllRunningCases, getCaseData, getCases, getEngineBuildProperties, getEngineLogonName, getEngineLogonPassword, getEngineURI, getExternalClients, getIABackendURI, getLiveWorkItemsForCase, getMITaskAttributes, getNamespace, getRegisteredServices, getRegisteredServicesAsXML, getRunningCases, getRunningCasesAsList, getServiceURI, getServiceURI, getSessionHandle, getSpecification, getSpecificationDataSchema, getTaskParamsAsXML, getWorkItemsForService, initEngineURI, isAdminSession, isRunningCaseID, launchCase, launchCase, launchCase, launchCase, reestablishClients, removeExternalClient, removeRegisteredService, setInterfaceBClient, setServiceURI, skipWorkItem, successful, suspendWorkItem, unloadSpecification, unsuspendWorkItem, updateExternalClient, uploadSpecification
protected final WorkletEventServer _server
protected final InterfaceBWebsideController _controller
public EngineClient(java.lang.String logonName, java.lang.String password, InterfaceBWebsideController controller)
public void setupIXClient()
public void addIXListener()
public java.lang.String uploadWorklet(java.lang.String workletXML)
public WorkletEventServer getServer()
public void rejectAnnouncedEnabledTask(java.lang.String wirID) throws java.io.IOException
java.io.IOException
public Element getStartingData(java.lang.String wirID) throws java.io.IOException
java.io.IOException
public java.lang.String cancelWorkItem(java.lang.String wirID) throws java.io.IOException
java.io.IOException
public java.lang.String failWorkItem(WorkItemRecord wir) throws java.io.IOException
java.io.IOException
public java.lang.String forceCompleteWorkItem(WorkItemRecord wir, Element data) throws java.io.IOException
java.io.IOException
public java.lang.String restartWorkItem(java.lang.String wirID) throws java.io.IOException
java.io.IOException
public WorkItemRecord continueWorkItem(java.lang.String wirID) throws java.io.IOException
java.io.IOException
public java.lang.String updateWorkItemData(WorkItemRecord wir, Element data) throws java.io.IOException
java.io.IOException
public java.lang.String updateCaseData(java.lang.String caseID, Element data) throws java.io.IOException
java.io.IOException
public java.util.List<WorkItemRecord> getLiveWorkItemsForSpec(YSpecificationID specID)
public java.util.List<WorkItemRecord> getLiveWorkItemsForIdentifier(java.lang.String idType, java.lang.String id)
getLiveWorkItemsForIdentifier
in class AbstractEngineClient
idType
- "case" for a case's workitems, "spec" for a specification's,
"task" for a specific taskIDid
- the identifier for the case/spec/taskpublic boolean declineWorkItem(WorkItemRecord wir, java.lang.String eventType)
public void undoCheckOutWorkItem(WorkItemRecord child)
child
- - the record for the child to undo the checkout forpublic boolean cancelWorkletCase(WorkletRunner runner)
runner
- - the id of the case to cancelpublic java.util.Set<WorkItemRecord> checkOutItem(WorkItemRecord wir)
wir
- - the WorkItemRecord of the workitem to check outprotected java.util.Set<WorkItemRecord> checkOutChildren(WorkItemRecord wir)
wir
- - the parent work itemprotected boolean checkOutWorkItem(WorkItemRecord wir)
wir
- - the workitem to check outpublic WorkItemRecord checkOutFiredWorkItem(WorkItemRecord wir)
public WorkItemRecord getEngineStoredWorkItem(WorkItemRecord wir) throws java.io.IOException
java.io.IOException
public WorkItemRecord getEngineStoredWorkItem(java.lang.String wirID) throws java.io.IOException
java.io.IOException
public SpecificationData getSpecData(YSpecificationID specID)
public YSpecificationID getSpecificationIDForCase(java.lang.String caseID)
public java.util.List<YParameter> getTaskInputParams(WorkItemRecord wir)
public java.util.List<YParameter> getInputParams(YSpecificationID specId)
public boolean uploadWorklet(WorkletSpecification worklet)
worklet
- - the id of the worklet specification to uploadpublic java.lang.String mapItemParamsToWorkletCaseParams(WorkItemRecord wir, Element itemData, YSpecificationID workletSpecID)
wir
- the checked out work itemprotected WorkletRunner launchWorklet(WorkItemRecord wir, YSpecificationID specID, Element data, RuleType ruleType)
wir
- - the checked out child item to start the worklet forpublic java.util.Set<WorkletRunner> launchWorkletList(WorkItemRecord wir, Element data, java.util.Set<WorkletSpecification> specs, RuleType ruleType)
wir
- - the child workitem to launch worklets forspecs
- - the ids of the worklets to launchpublic void checkCacheForWorkItem(WorkItemRecord wir)
Copyright © 2004-2014 The YAWL Foundation.