|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use FmcException | |
---|---|
com.ibm.workflow.api | |
com.ibm.workflow.api.ProgramTemplatePackage |
Uses of FmcException in com.ibm.workflow.api |
---|
Methods in com.ibm.workflow.api that throw FmcException | |
ReadWriteContainer |
ReadOnlyContainer.asReadWriteContainer()
In the C-language and Java, converts the read-only container into a read/write container. |
boolean |
ProcessTemplate.isEmpty()
Indicates whether no process template information is available. |
boolean |
ProcessTemplate.isComplete()
Indicates whether the complete process template information is available. |
AuditSetting |
ProcessTemplate.auditMode()
Returns the audit mode of the process template. |
java.lang.String |
ProcessTemplate.category()
Returns the category of the process template. |
java.util.Calendar |
ProcessTemplate.creationTime()
Returns the creation time of the process template. |
java.lang.String |
ProcessTemplate.description()
Returns the description of the process template. |
java.lang.String |
ProcessTemplate.documentation()
Returns the documentation of the process template. |
java.lang.String |
ProcessTemplate.icon()
Returns the icon associated with the process template. |
java.lang.String |
ProcessTemplate.inContainerName()
Returns the name of the input container of the process template. |
boolean |
ProcessTemplate.inContainerNeeded()
Indicates whether an input container is needed to start an instance of the process template. |
java.util.Calendar |
ProcessTemplate.lastModificationTime()
Returns the last time a primary attribute of the process template was changed. |
java.lang.String |
ProcessTemplate.name()
Returns the name of the process template. |
java.lang.String |
ProcessTemplate.organizationName()
Returns the name of the organization of the process template. |
java.lang.String |
ProcessTemplate.outContainerName()
Returns the name of the output container of the process template. |
java.lang.String |
ProcessTemplate.persistentOid()
Returns a representation of the object identification of the process template. |
java.lang.String |
ProcessTemplate.processAdmin()
Returns the user ID of the process administrator of an instance of the process template. |
java.lang.String |
ProcessTemplate.roleName()
Returns the name of the role of the process template. |
java.util.Calendar |
ProcessTemplate.validFromTime()
Returns the time when the process template becomes valid. |
ProcessInstance |
ProcessTemplate.createInstance(java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
boolean keepName)
This API call creates a process instance from the specified process template (action call). |
ProcessInstance |
ProcessTemplate.createAndStartInstance(java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
boolean keepName)
This API call creates a process instance from the specified process template and starts the resulting process instance (action call). |
ProcessInstance |
ProcessTemplate.createAndStartInstance2(java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
ReadWriteContainer input,
boolean keepName)
See createAndStartInstance; additionally allows to pass an input container. |
ProcessInstance |
ProcessTemplate.createAndStartInstance3(java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
ReadWriteContainer inContainer,
boolean keepName,
java.lang.String processContext)
See createAndStartInstance; additionally allows to pass an input container and a process context. |
ProcessInstance |
ProcessTemplate.executeProcessInstance(ReadOnlyContainerHolder output,
java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
boolean keepName)
|
ProcessInstance |
ProcessTemplate.executeProcessInstance2(ReadWriteContainer input,
ReadOnlyContainerHolder output,
java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
boolean keepName)
|
ProcessInstance |
ProcessTemplate.executeProcessInstance3(ReadWriteContainer inContainer,
ReadOnlyContainerHolder output,
java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
boolean keepName,
java.lang.String processContext)
See executeProcessInstance; additionally allows to pass an input container and a process context. |
void |
ProcessTemplate.delete()
This API call deletes the specified process template(s) from the execution server (action call). |
void |
ProcessTemplate.delete2(boolean pastVersions,
boolean currentVersion,
boolean futureVersions)
See delete; additionally allows for specifying the versions to be deleted. |
ReadWriteContainer |
ProcessTemplate.initialInContainer()
This API call retrieves the input container associated with the process template from the MQ Workflow execution server (action call). |
ProgramTemplate |
ProcessTemplate.programTemplate(java.lang.String programName)
This API call retrieves the program template identified by the passed name from the MQ Workflow execution server (action call). |
void |
ProcessTemplate.refresh()
This API call refreshes the process template from the MQ Workflow execution server (action call). |
java.lang.String |
ExecutionService.sessionID()
Returns a string representation of the session. |
ActivityInstanceList |
ExecutionService.createActivityInstanceList(java.lang.String name,
TypeOfList type,
java.lang.String owner,
java.lang.String description,
java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call creates an activity instance list on the MQ Workflow execution server so that activity instances can be grouped to one's own taste or for a group of users (action call). |
ProcessInstanceList |
ExecutionService.createProcessInstanceList(java.lang.String name,
TypeOfList type,
java.lang.String owner,
java.lang.String description,
java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call creates a process instance list on the MQ Workflow execution server so that process instances can be grouped to one's own taste or for a group of users (action call). |
ProcessTemplateList |
ExecutionService.createProcessTemplateList(java.lang.String name,
TypeOfList type,
java.lang.String owner,
java.lang.String description,
java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call creates a process template list on the MQ Workflow execution server so that process templates can be grouped to one's own taste or for a group of users (action call). |
WorkList |
ExecutionService.createWorkList(java.lang.String name,
TypeOfList type,
java.lang.String owner,
java.lang.String description,
java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call creates a worklist on the MQ Workflow execution server so that work items or notifications can be grouped to one's own taste or for a group of users (action call). |
void |
ExecutionService.forceLogoff(java.lang.String userID)
This API call allows an administrator to finish all sessions of the specified user with an MQ Workflow execution server (action call). |
void |
ExecutionService.forceProgramExecutionAgentShutDown(java.lang.String userID)
This API call allows an administrator to terminate the PEA sessions of the specified user with an MQ Workflow execution server (action call). |
void |
ExecutionService.logoff()
This API call allows the application to finish the specified user session with an MQ Workflow execution server (action call). |
void |
ExecutionService.logon(java.lang.String userID,
java.lang.String password)
This API call allows an application to establish a user session with an MQ Workflow execution server (action call). |
void |
ExecutionService.logon2(java.lang.String userID,
java.lang.String password,
SessionMode mode,
AbsenceIndicator absenceIndicator)
See ExecutionService.logon(java.lang.String, java.lang.String) ;
allows for the specification of the session mode and absence setting. |
void |
ExecutionService.logon3(byte[] userCredentials)
See ExecutionService.logon(java.lang.String, java.lang.String) ;
allows for logging on with user credentials. |
void |
ExecutionService.logon4(byte[] userCredentials,
SessionMode mode,
AbsenceIndicator absenceIndicator,
java.lang.String userName)
See ExecutionService.logon(java.lang.String, java.lang.String) ;
allows for logging on with user credentials and for the specification of the
session mode and absence setting. |
void |
ExecutionService.passthrough()
The native implementation of the Java API does not support this method. |
ActivityInstance |
ExecutionService.persistentActivityInstance(java.lang.String oid)
Constructs a transient activity instance object representing the persistent object identified by the passed object identification; does not contact the server. |
ActivityInstanceList |
ExecutionService.persistentActivityInstanceList(java.lang.String oid)
Documentation for method not yet available |
ActivityInstanceNotification |
ExecutionService.persistentActivityInstanceNotification(java.lang.String oid)
Constructs a transient activity instance notification object representing the persistent object identified by the passed object identification; does not contact the server. |
InstanceMonitor |
ExecutionService.persistentInstanceMonitor(java.lang.String oid)
Constructs a transient instance monitor object representing the persistent object identified by the passed object identification; does not contact the server. |
Person |
ExecutionService.persistentPerson(java.lang.String userID)
Constructs a transient person object representing the persistent object identified by the passed user identification; does not contact the server. |
ProcessInstance |
ExecutionService.persistentProcessInstance(java.lang.String oid)
Constructs a transient process instance object representing the persistent object identified by the passed object identification; does not contact the server. |
ProcessInstanceList |
ExecutionService.persistentProcessInstanceList(java.lang.String oid)
Constructs a transient process instance list object representing the persistent object identified by the passed object identification; does not contact the server. |
ProcessInstanceNotification |
ExecutionService.persistentProcessInstanceNotification(java.lang.String oid)
Constructs a transient process instance notification object representing the persistent object identified by the passed object identification; does not contact the server. |
ProcessTemplate |
ExecutionService.persistentProcessTemplate(java.lang.String oid)
Constructs a transient process template object representing the persistent object identified by the passed object identification; does not contact the server. |
ProcessTemplateList |
ExecutionService.persistentProcessTemplateList(java.lang.String oid)
Constructs a transient process template list object representing the persistent object identified by the passed object identification; does not contact the server. |
WorkItem |
ExecutionService.persistentWorkItem(java.lang.String oid)
Constructs a transient work item object representing the persistent object identified by the passed object identification; does not contact the server. |
WorkList |
ExecutionService.persistentWorkList(java.lang.String oid)
Constructs a transient worklist object representing the persistent object identified by the passed object identification; does not contact the server. |
ProgramData |
ExecutionService.programDataFromStream(byte[] stream)
Constructs a transient program data object from the stream passed. |
void |
ExecutionService.programExecutionAgentShutDown()
This API call allows to shut down the program execution agent associated to the logged on user (program execution management API call call). |
void |
ExecutionService.programExecutionAgentStartUp()
This API call is used to start a program execution agent associated to the logged-on user (program-execution-management call). |
ProgramTemplate |
ExecutionService.programTemplateFromStream(byte[] stream)
Constructs a transient program template object from the stream passed. |
ActivityInstanceList[] |
ExecutionService.queryActivityInstanceLists()
This API call retrieves the activity instance lists the user has access to from the MQ Workflow execution server (action call). |
ProcessInstanceList[] |
ExecutionService.queryProcessInstanceLists()
This API call retrieves the process instance lists the user has access to from the MQ Workflow execution server (action call). |
ProcessTemplateList[] |
ExecutionService.queryProcessTemplateLists()
This API call retrieves the current process template lists the user has access to from the MQ Workflow execution server (action call). |
WorkList[] |
ExecutionService.queryWorkLists()
This API call retrieves the worklists the user has access to from the MQ Workflow execution server (action call). |
ActivityInstance[] |
ExecutionService.queryActivityInstances(java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call retrieves the current activity instances the user has access to from the MQ Workflow execution server (action call). |
ProcessInstance[] |
ExecutionService.queryProcessInstances(java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call retrieves the current process instances the user has access to from the MQ Workflow execution server (action call). |
ProcessTemplate[] |
ExecutionService.queryProcessTemplates(java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call retrieves the current process templates from the MQ Workflow execution server (action call). |
Item[] |
ExecutionService.queryItems(java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call retrieves the work items or notifications the user has access to from the MQ Workflow execution server (action call). |
WorkItem[] |
ExecutionService.queryWorkItems(java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call retrieves the work items the user has access to from the MQ Workflow execution server (action call). |
ActivityInstanceNotification[] |
ExecutionService.queryActivityInstanceNotifications(java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call retrieves the activity instance notifications the user has access to from the MQ Workflow execution server (action call). |
ProcessInstanceNotification[] |
ExecutionService.queryProcessInstanceNotifications(java.lang.String filter,
java.lang.String sortCriteria,
java.lang.Integer threshold)
This API call retrieves the process instance notifications the user has access to from the MQ Workflow execution server (action call). |
int |
ExecutionService.queryActivityInstancesResultSize(java.lang.String filter)
This API call retrieves the number of current activity instances the user has access to from the MQ Workflow execution server (action call). |
int |
ExecutionService.queryProcessInstancesResultSize(java.lang.String filter)
This API call retrieves the number of current process instances the user has access to from the MQ Workflow execution server (action call). |
int |
ExecutionService.queryProcessTemplatesResultSize(java.lang.String filter)
This API call retrieves the number of current process templates the user has access to from the MQ Workflow execution server (action call). |
int |
ExecutionService.queryItemsResultSize(java.lang.String filter)
This API call retrieves the number of current work items or notifications the user has access to from the MQ Workflow execution server (action call). |
int |
ExecutionService.queryWorkItemsResultSize(java.lang.String filter)
This API call retrieves the number of current work items the user has access to from the MQ Workflow execution server (action call). |
int |
ExecutionService.queryActivityInstanceNotificationsResultSize(java.lang.String filter)
This API call retrieves the number of current activity instance notifications the user has access to from the MQ Workflow execution server (action call). |
int |
ExecutionService.queryProcessInstanceNotificationsResultSize(java.lang.String filter)
This API call retrieves the number of current process instance notifications the user has access to from the MQ Workflow execution server (action call). |
ReadOnlyContainer |
ExecutionService.readOnlyContainerFromStream(byte[] stream)
Constructs a transient read-only container object from the stream passed. |
ReadWriteContainer |
ExecutionService.readWriteContainerFromStream(byte[] stream)
Constructs a transient read/write container object from the stream passed. |
void |
ExecutionService.remotePassthrough(java.lang.String programID)
The native implementation of the Java API does not support this method. |
void |
ExecutionService.setPersonAbsent()
This API call sets the absence indication of the specified user to the specified value (action call). |
void |
ExecutionService.setPersonAbsent2(java.lang.String userID,
boolean newValue)
|
void |
ExecutionService.setSessionContext(java.lang.String userID,
java.lang.String sessionID)
Associates the execution service object with the session identified by the passed session identification. |
boolean |
Item.isEmpty()
Indicates whether no item information is available. |
boolean |
Item.isComplete()
Indicates whether the complete item information is available. |
java.lang.String |
Item.category()
Returns the process category of the item. |
java.util.Calendar |
Item.creationTime()
Returns the creation time |
java.lang.String |
Item.description()
Returns the description of the item. |
java.lang.String |
Item.documentation()
Returns the documentation of the item. |
java.util.Calendar |
Item.endTime()
Returns the ending time of the item. |
java.lang.String |
Item.icon()
Returns the icon associated with the item. |
java.lang.String |
Item.inContainerName()
Returns the name of the input container |
ItemType |
Item.kind()
States the actual kind of the item, whether it is a work item or some kind of notification. |
java.util.Calendar |
Item.lastModificationTime()
Returns the last time a primary attribute of the item was changed. |
java.lang.String |
Item.name()
Returns the name of the item. |
java.lang.String |
Item.outContainerName()
Returns the name of the output container of the item. |
java.lang.String |
Item.owner()
Returns the user ID of the owner of the item. |
java.lang.String |
Item.persistentOid()
Returns a representation of the object identification of the item. |
java.lang.String |
Item.persistentOidOfProcessInstance()
Returns the object ID |
java.lang.String |
Item.processAdmin()
Returns the user ID of the process administrator |
java.lang.String |
Item.processInstanceName()
Returns the name |
ExecutionState |
Item.processInstanceState()
Returns the state of the process instance the item is part of. |
java.lang.String |
Item.processInstanceSystemGroupName()
Returns the name of the system group of the process instance the item is part of. |
java.lang.String |
Item.processInstanceSystemName()
Returns the name of the system of the process instance the item is part of. |
AssignReason |
Item.receivedAs()
Returns the reason why the item was received. |
java.util.Calendar |
Item.receivedTime()
Returns the time when the item was received by the current owner. |
java.util.Calendar |
Item.startTime()
Returns the start time of the item. |
void |
Item.delete()
This API call deletes the specified item from the MQ Workflow execution server (action call). |
InstanceMonitor |
Item.obtainProcessMonitor(boolean deep)
This API call retrieves the instance monitor for the process instance the item is part of from the MQ Workflow execution server (action call). |
ProcessInstance |
Item.processInstance()
This API call retrieves the process instance the item is a part of from the MQ Workflow execution server (action call). |
void |
Item.refresh()
This API call refreshes the item from the MQ Workflow execution server (action call). |
void |
Item.setName(java.lang.String name)
This API call sets the name of the item (action call). |
void |
Item.setDescription(java.lang.String description)
This API call sets the description of the item to the specified value (action call). |
void |
Item.transfer(java.lang.String userID)
This API call transfers an item to the specified user (action call). |
boolean |
ContainerElement.isEmpty()
Indicates whether no container element information is available. |
ContainerElement[] |
ContainerElement.arrayElements()
Returns the array elements of the container element. |
int |
ContainerElement.cardinality()
Returns the number of array elements of the container element. |
java.lang.String |
ContainerElement.fullName()
Returns the fully-qualified dotted name of the container element. |
boolean |
ContainerElement.isArray()
Indicates whether the container element is an array. |
boolean |
ContainerElement.isLeaf()
Indicates whether the container element is a leaf. |
boolean |
ContainerElement.isStruct()
Indicates whether the container element is a structure itself. |
int |
ContainerElement.leafCount()
Returns the number of leaf elements of the container element. |
ContainerElement[] |
ContainerElement.leaves()
Returns all leaf elements of the container element. |
int |
ContainerElement.memberCount()
Returns the number of structural members in the container element. |
java.lang.String |
ContainerElement.name()
Returns the name of the container element. |
ContainerElement[] |
ContainerElement.structMembers()
Returns the structural members of the container element. |
java.lang.String |
ContainerElement.type()
Returns the type of the container element, that is, the data structure name. |
byte[] |
ContainerElement.getBuffer()
Returns the value of the specified container element leaf element in Java. |
byte[] |
ContainerElement.getBuffer2(int index)
Returns the value of the specified container element leaf element in Java. |
double |
ContainerElement.getDouble()
Returns the value of the specified container element leaf element in Java. |
double |
ContainerElement.getDouble2(int index)
Returns the value of the specified container element leaf element in Java. |
ContainerElement |
ContainerElement.getElement(java.lang.String qualifiedName)
Provides access to an element of the container element. |
int |
ContainerElement.getLong()
Returns the value of the specified container element leaf element in Java. |
int |
ContainerElement.getLong2(int index)
Returns the value of the specified container element leaf element in Java. |
java.lang.String |
ContainerElement.getString()
Returns the value of the specified container element leaf element in Java. |
java.lang.String |
ContainerElement.getString2(int index)
Returns the value of the specified container element leaf element in Java. |
boolean |
ActivityInstance.isComplete()
Indicates whether the complete activity instance information is available. |
boolean |
ActivityInstance.isEmpty()
Indicates whether no activity instance information is available. |
Type |
ActivityInstance.kind()
States the kind of the activity instance, whether it is a program, a process, or a block. |
java.util.Calendar |
ActivityInstance.activationTime()
Returns the activation time of the activity instance. |
java.lang.String |
ActivityInstance.category()
Returns the process category of the activity instance. |
java.lang.String |
ActivityInstance.description()
Returns the description of the activity instance. |
java.lang.String |
ActivityInstance.documentation()
Returns the documentation of the activity instance. |
java.util.Calendar |
ActivityInstance.endTime()
Returns the ending time of the activity instance. |
FmcError |
ActivityInstance.errorReason()
Returns an error object describing the reason why the activity instance is in state InError. |
java.lang.String |
ActivityInstance.exitCondition()
Returns the exit condition of the activity instance. |
java.util.Calendar |
ActivityInstance.expirationTime()
Returns the expiration time of the activity instance. |
java.util.Calendar |
ActivityInstance.firstNotificationTime()
Returns the time the first notification for the activity instance is to occur or has occurred. |
java.lang.String[] |
ActivityInstance.firstNotifiedPersons()
Returns the persons who received a first notification for the activity instance. |
java.lang.String |
ActivityInstance.fullName()
Returns the fully qualified name of the activity instance (dot notation). |
java.lang.String |
ActivityInstance.icon()
Returns the icon associated with the activity instance. |
java.lang.String |
ActivityInstance.implementation()
Returns the name of the implementing program of the activity instance. |
java.lang.String |
ActivityInstance.inContainerName()
Returns the name of the input container of the activity instance. |
java.util.Calendar |
ActivityInstance.lastModificationTime()
Returns the last time a primary attribute of the activity instance was changed. |
java.util.Calendar |
ActivityInstance.lastStateChangeTime()
Returns the last time the state of the activity instance changed. |
boolean |
ActivityInstance.manualExitMode()
Returns whether the exit mode of the activity instance is manual. |
boolean |
ActivityInstance.manualStartMode()
Returns whether the start mode of the activity instance is manual. |
java.lang.String |
ActivityInstance.name()
Returns the name of the activity instance. |
java.lang.String |
ActivityInstance.outContainerName()
Returns the name of the output container of the activity instance. |
java.lang.String |
ActivityInstance.persistentOid()
Returns a representation of the object identification of the activity instance. |
java.lang.Integer |
ActivityInstance.priority()
Returns the priority of the activity instance. |
java.lang.String |
ActivityInstance.processAdmin()
Returns the process administrator of the activity instance. |
java.lang.String |
ActivityInstance.processInstanceName()
Returns the name of the process instance the activity instance is part of. |
ExecutionState |
ActivityInstance.processInstanceState()
Returns the state of the process instance the activity instance is part of. |
java.lang.String |
ActivityInstance.processInstanceSystemGroupName()
Returns the name of the system group of the process instance the item is part of. |
java.lang.String |
ActivityInstance.processInstanceSystemName()
Returns the name of the system of the process instance the activity instance is part of. |
java.util.Calendar |
ActivityInstance.secondNotificationTime()
Returns the time the second notification for the activity instance is to occur or has occurred. |
java.lang.String[] |
ActivityInstance.secondNotifiedPersons()
Returns the persons |
java.lang.String[] |
ActivityInstance.staff()
Returns all persons a work item for the activity instance is assigned to. |
java.lang.String |
ActivityInstance.startCondition()
Returns the start condition of the activity instance. |
java.lang.String |
ActivityInstance.starter()
Returns the starter of the activity instance or the requestor of a ForceFinish action. |
java.util.Calendar |
ActivityInstance.startTime()
Returns the start time of the activity instance. |
ExecutionState |
ActivityInstance.state()
Returns the state of the activity instance. |
Escalation |
ActivityInstance.stateOfNotification()
Returns the notification state of the activity instance. |
java.lang.String[] |
ActivityInstance.supportTools()
Returns the support tools associated with the activity instance. |
SymbolLayout |
ActivityInstance.symbolLayout()
Returns the symbol layout of the activity instance. |
ReadOnlyContainer |
ActivityInstance.inContainer()
This API call retrieves the input container associated with the activity instance from the MQ Workflow execution server (action call). |
void |
ActivityInstance.forceFinish()
This API call ends the execution of the specified activity instance because it is known to have completed (action call). |
void |
ActivityInstance.forceFinish2(Container outputContainer)
See ActivityInstance.forceFinish() ; allows for the specification of an output
container. |
void |
ActivityInstance.forceRestart()
This API call forces MQ Workflow to enable the restart of the specified activity instance (action call). |
void |
ActivityInstance.forceRestart2(Container inputContainer)
See ActivityInstance.forceRestart() ; allows for the specification of an input
container. |
InstanceMonitor |
ActivityInstance.obtainProcessMonitor(boolean deep)
This API call retrieves a monitor for the process instance the activity instance is part of from the MQ Workflow execution server (action call). |
ReadOnlyContainer |
ActivityInstance.outContainer()
This API call retrieves the output container associated with the activity instance from the MQ Workflow execution server (action call). |
void |
ActivityInstance.refresh()
This API call refreshes the activity instance from the MQ Workflow execution server (action call). |
ProcessInstance |
ActivityInstance.subProcessInstance()
This API call retrieves the process instance which is implementing the activity instance from the MQ Workflow execution server (action call). |
void |
ActivityInstance.terminate()
This API call terminates an activity instance implemented by a program or process (action call). |
ProcessTemplate[] |
ProcessTemplateList.queryProcessTemplates()
This API call retrieves the primary information for all process templates characterized by the specified process template list from the MQ Workflow execution server (action call). |
int |
ProcessTemplateList.queryProcessTemplatesResultSize()
This API call returns the number of qualifying process templates characterized by the specified process template list from the MQ Workflow execution server (action call). |
ExecutionService |
Agent.locate(java.lang.String group,
java.lang.String system)
Locates the ExecutionService in the given system group and system. |
ExecutionAgent |
Agent.getExecutionAgent()
Returns an ExecutionAgent. |
VersionInfo |
Agent.versionInfo()
Returns information about version, release, modification level, and driver build of the agent. |
java.lang.String |
Agent.getConfigurationID()
Returns the configuration to be used for profile accesses. |
Type |
ActivityInstanceNotification.activityKind()
Returns the kind of the associated activity instance, whether it is a program or process and so on. |
FmcError |
ActivityInstanceNotification.errorReason()
Returns an error object describing the reason |
java.lang.String |
ActivityInstanceNotification.exitCondition()
Returns the exit condition of the associated activity instance. |
java.util.Calendar |
ActivityInstanceNotification.expirationTime()
Returns the expiration time of the associated activity instance. |
java.util.Calendar |
ActivityInstanceNotification.firstNotificationTime()
Returns the first notification time of the activity instance, that is, the time when this notification has been created. |
java.lang.String |
ActivityInstanceNotification.implementation()
Returns the implementing program or process name of the associated activity instance. |
boolean |
ActivityInstanceNotification.manualExitMode()
Returns whether the exit mode of the associated activity instance is manual. |
boolean |
ActivityInstanceNotification.manualStartMode()
Returns whether the start mode of the associated activity instance is manual. |
java.lang.String |
ActivityInstanceNotification.persistentOidOfActivityInstance()
Returns the object ID of the associated activity instance. |
int |
ActivityInstanceNotification.priority()
Returns the priority of the associated activity instance. |
java.util.Calendar |
ActivityInstanceNotification.secondNotificationTime()
Returns the second notification time of the associated activity instance. |
java.lang.String[] |
ActivityInstanceNotification.staff()
Returns all persons owning a work item for the associated activity instance. |
java.lang.String |
ActivityInstanceNotification.startCondition()
Returns the start condition of the associated activity instance. |
ExecutionState |
ActivityInstanceNotification.state()
Returns the state of the associated activity instance. |
Escalation |
ActivityInstanceNotification.stateOfNotification()
Returns the notification state of the associated activity instance. |
java.lang.String[] |
ActivityInstanceNotification.supportTools()
Returns the support tools associated with the activity instance. |
ActivityInstance |
ActivityInstanceNotification.activityInstance()
This API call retrieves the activity instance the activity instance notification is associated to from the MQ Workflow execution server (action call). |
void |
ActivityInstanceNotification.startTool(java.lang.String toolName)
This API call starts the specified support tool (action call). |
java.lang.String |
ProgramTemplate.description()
Returns the description of the implementing program. |
ExeMode |
ProgramTemplate.executionMode()
States whether the program can participate in global transactions or not. |
ExeUser |
ProgramTemplate.executionUser()
Returns the user on whose behalf the program is to be executed. |
java.lang.String |
ProgramTemplate.icon()
Returns the icon associated with the implementing program. |
ImplementationData[] |
ProgramTemplate.implementations()
Returns the implementation definitions of the program. |
boolean |
ProgramTemplate.inContainerAccess()
States whether the input container is accessed by the program. |
ReadWriteContainer |
ProgramTemplate.initialInContainer()
Returns the initially defined input container of the program. |
ReadWriteContainer |
ProgramTemplate.initialOutContainer()
Returns the initially defined output container of the program. |
boolean |
ProgramTemplate.isEmpty()
Indicates whether no program template information is available yet. |
boolean |
ProgramTemplate.isUnattended()
States whether the program can run unattended. |
boolean |
ProgramTemplate.outContainerAccess()
States whether the output container is accessed by the program. |
boolean |
ProgramTemplate.programTrusted()
States whether the program can be trusted. |
boolean |
ProgramTemplate.structuresFromActivity()
States whether the program can handle any container passed to it. |
java.util.Calendar |
ProgramTemplate.validFromTime()
Returns the time when the process template and thus the program template becomes valid. |
byte[] |
ProgramTemplate.asStream()
Returns the program template as a binary stream. |
ReadWriteContainer |
ProgramTemplate.execute()
The native implementation of the Java API cannot communicate with the Program Execution Agent. |
ReadWriteContainer |
ProgramTemplate.execute2(ReadWriteContainer initialInContainer,
ReadWriteContainer initialOutContainer,
int priority)
|
ReadOnlyContainer |
ReadWriteContainer.asReadOnlyContainer()
In the C-language and Java, converts the read/write container into a read-only container. |
void |
ReadWriteContainer.setBuffer(java.lang.String qualifiedName,
byte[] value)
Sets the value of the specified container leaf element in Java. |
void |
ReadWriteContainer.setBuffer2(java.lang.String qualifiedName,
int index,
byte[] value)
Sets the value of the specified container leaf element in Java. |
void |
ReadWriteContainer.setDouble(java.lang.String qualifiedName,
double value)
Sets the value of the specified container leaf element in Java. |
void |
ReadWriteContainer.setDouble2(java.lang.String qualifiedName,
int index,
double value)
Sets the value of the specified container leaf element in Java. |
void |
ReadWriteContainer.setLong(java.lang.String qualifiedName,
int value)
Sets the value of the specified container leaf element in Java. |
void |
ReadWriteContainer.setLong2(java.lang.String qualifiedName,
int index,
int value)
Sets the value of the specified container leaf element in Java. |
void |
ReadWriteContainer.setString(java.lang.String qualifiedName,
java.lang.String value)
Sets the value of the specified container leaf element in Java. |
void |
ReadWriteContainer.setString2(java.lang.String qualifiedName,
int index,
java.lang.String value)
Sets the value of the specified container leaf element in Java. |
boolean |
Person.isEmpty()
Indicates whether no person information is available. |
boolean |
Person.isComplete()
Indicates whether the complete person information is available. |
java.lang.String[] |
Person.categoriesAuthorizedFor()
Returns the categories the person is authorized for with basic or with administration rights. |
java.lang.String[] |
Person.categoriesAuthorizedForAsAdmin()
Returns the categories the person is authorized for with administration rights. |
java.lang.String |
Person.description()
Returns the description of the person. |
java.lang.String |
Person.firstName()
Returns the first name of the person. |
boolean |
Person.isAbsent()
Indicates whether the person is absent. |
boolean |
Person.isAdministrator()
Indicates whether the person is an administrator. |
boolean |
Person.isAuthorizedForAllCategories()
Indicates whether the person is said to be authorized for all categories either with basic and/or administration rights. |
boolean |
Person.isAuthorizedForAllCategoriesAsAdmin()
Indicates whether the person is said to be authorized for all categories as administrator. |
boolean |
Person.isAuthorizedForAllPersons()
Indicates whether the person is authorized to see the items of all persons. |
boolean |
Person.isAuthorizedForAuthorizationDefinition()
Indicates whether the person is authorized to define authorizations. |
boolean |
Person.isAuthorizedForOperationAdministration()
Indicates whether the person is authorized for operational administrations. |
boolean |
Person.isAuthorizedForProcessDefinition()
Indicates whether the person is authorized to define process models. |
boolean |
Person.isAuthorizedForStaffDefinition()
Indicates whether the person is authorized to define persons. |
boolean |
Person.isAuthorizedForTopologyDefinition()
Indicates whether the person is authorized to define topological data. |
boolean |
Person.isManager()
Indicates whether the person is a manager. |
boolean |
Person.isResetAbsence()
Indicates whether the absence flag should be reset when the person logs on. |
java.lang.String |
Person.lastName()
Returns the last name of the person. |
int |
Person.level()
Returns the level of the person. |
java.lang.String |
Person.manager()
Returns the user identification of the person's manager. |
java.lang.String |
Person.middleName()
Returns the middle name of the person. |
java.lang.String[] |
Person.namesOfManagedOrganizations()
Returns the names of organizations the person manages. |
java.lang.String[] |
Person.namesOfRoles()
Returns the names of roles the person belongs to. |
java.lang.String[] |
Person.namesOfRolesToCoordinate()
Returns the names of roles the person can coordinate. |
java.lang.String |
Person.organizationName()
Returns the name of the organization the person belongs to. |
java.lang.String |
Person.personID()
Returns the person ID of the person. |
java.lang.String[] |
Person.personsAuthorizedFor()
Returns the persons for whom this person is authorized either explicitly or by being a substitute. |
java.lang.String[] |
Person.personsAuthorizedForMe()
Returns the persons who are authorized for this person. |
java.lang.String[] |
Person.personsToStandInFor()
Returns the persons for whom this person stands in. |
java.lang.String |
Person.phone()
Returns the phone number of the person. |
java.lang.String |
Person.secondPhone()
Returns the alternate phone number of the person. |
java.lang.String |
Person.substitute()
Returns the substitute of the person. |
java.lang.String |
Person.systemName()
Returns the home system of the person. |
java.lang.String |
Person.userID()
Returns the user identification of the person. |
boolean |
Person.isAdminForCategory(java.lang.String category)
Indicates whether the person has administrator rights for the specified category. |
void |
Person.refresh()
This API call refreshes the person from the MQ Workflow execution server (action call). |
void |
Person.setAbsence(boolean value)
This API call sets the absence indication of the logged-on user to the specified value (action call). |
void |
Person.setSubstitute(java.lang.String substitute)
This API call sets the substitute of the logged-on user (action call). |
boolean |
ControlConnectorInstance.isEmpty()
Indicates whether no control connector instance information is available. |
Type |
ControlConnectorInstance.kind()
States the kind of the control connector instance, whether it is a transition condition or the "otherwise" connector. |
Point[] |
ControlConnectorInstance.bendPoints()
Returns the bend points of the control connector instance. |
java.lang.String |
ControlConnectorInstance.name()
Returns the name associated with the control connector instance. |
java.lang.String |
ControlConnectorInstance.persistentOidOfSourceActivity()
Returns the object ID of the activity instance which is the source of this control connector instance. |
java.lang.String |
ControlConnectorInstance.persistentOidOfTargetActivity()
Returns the object ID of the activity instance which is the target of this control connector instance. |
EvaluationState |
ControlConnectorInstance.state()
Returns the state of the control connector instance, whether it is evaluated, and the result of evaluation. |
java.lang.String |
ControlConnectorInstance.transitionCondition()
Returns the transition condition of the control connector instance. |
ActivityInstance[] |
InstanceMonitor.activityInstances()
Returns the activity instances which are represented by the instance monitor. |
ControlConnectorInstance[] |
InstanceMonitor.controlConnectorInstances()
Returns the control connector instances which are represented by the instance monitor. |
java.lang.String |
InstanceMonitor.persistentOid()
Returns a representation of the object identification of the instance monitor. |
InstanceMonitor |
InstanceMonitor.obtainBlockMonitor(ActivityInstance activity)
This API call retrieves the instance monitor for the specified activity instance from the MQ Workflow execution server (action call). |
InstanceMonitor |
InstanceMonitor.obtainProcessMonitor(ActivityInstance activity,
boolean deep)
See InstanceMonitor.obtainBlockMonitor(com.ibm.workflow.api.ActivityInstance) ; obtains the monitor for an activity of type
Process. |
void |
InstanceMonitor.refresh(boolean deep)
This API call refreshes the instance monitor from the MQ Workflow execution server (action call). |
ExecutionService |
AgentExtension.locate(java.lang.String group,
java.lang.String system)
Locates the ExecutionService in the given system group and system. |
VersionInfo |
AgentExtension.versionInfo()
Returns information about version, release, modification level, and driver build of the agent. |
java.lang.String |
AgentExtension.getConfigurationID()
Returns the configuration to be used for profile accesses. |
ExecutionAgent |
AgentExtension.getExecutionAgent()
Returns an ExecutionAgent. |
java.util.Calendar |
ProcessInstanceNotification.notificationTime()
Returns the notification time of the process instance. |
java.lang.String |
ProgramData.description()
Returns the description of the implementing program. |
ExeMode |
ProgramData.executionMode()
States whether the program can participate in global transactions or not. |
ExeUser |
ProgramData.executionUser()
Returns the user on whose behalf the program is to be executed. |
java.lang.String |
ProgramData.icon()
Returns the icon associated with the implementing program. |
ImplementationData[] |
ProgramData.implementations()
Returns the implementation definitions of the program. |
ReadOnlyContainer |
ProgramData.inContainer()
Returns the input container of the program. |
boolean |
ProgramData.isEmpty()
Indicates whether no program data information is available yet. |
boolean |
ProgramData.isUnattended()
States whether the program can run unattended. |
ReadWriteContainer |
ProgramData.outContainer()
Returns the output container of the program. |
boolean |
ProgramData.programTrusted()
States whether the program can be trusted. |
byte[] |
ProgramData.asStream()
Returns the program data as a binary stream. |
ActivityInstance[] |
ActivityInstanceList.queryActivityInstances()
This API call retrieves the primary information for all activity instances characterized by the specified activity instance list from the MQ Workflow execution server (action call). |
int |
ActivityInstanceList.queryActivityInstancesResultSize()
This API call returns the number of qualifying activity instances characterized by the specified activity instance list from the MQ Workflow execution server (action call). |
ExecutionService |
MQWFAgent.locate(java.lang.String group,
java.lang.String system)
Locates the ExecutionService in the given system group and system. |
ExecutionAgent |
MQWFAgent.getExecutionAgent()
Not implemented. |
VersionInfo |
MQWFAgent.versionInfo()
Returns information about version, release, modification level, and driver build of the agent. |
java.lang.String |
MQWFAgent.getConfigurationID()
Returns the configuration to be used for profile accesses. |
java.lang.String |
ExecutionAgent.persistentOidOfActivityInstance()
The native implementation of the Java API does not support this method. |
java.lang.String |
ExecutionAgent.processContext()
The native implementation of the Java API does not support this method. |
java.lang.String |
ExecutionAgent.userID()
The native implementation of the Java API does not support this method. |
ReadOnlyContainer |
ExecutionAgent.inContainer()
The native implementation of the Java API does not support this method. |
ReadWriteContainer |
ExecutionAgent.outContainer()
The native implementation of the Java API does not support this method. |
java.lang.String |
ExecutionAgent.programID()
The native implementation of the Java API does not support this method. |
ReadOnlyContainer |
ExecutionAgent.remoteInContainer(java.lang.String programID)
The native implementation of the Java API does not support this method. |
ReadWriteContainer |
ExecutionAgent.remoteOutContainer(java.lang.String programID)
The native implementation of the Java API does not support this method. |
java.lang.String |
ExecutionAgent.remotePersistentOidOfActivityInstance(java.lang.String programID)
The native implementation of the Java API does not support this method. |
java.lang.String |
ExecutionAgent.remoteProcessContext(java.lang.String programID)
|
java.lang.String |
ExecutionAgent.remoteUserID(java.lang.String programID)
The native implementation of the Java API does not support this method. |
void |
ExecutionAgent.setOutContainer(ReadWriteContainer outContainer)
The native implementation of the Java API does not support this method. |
void |
ExecutionAgent.setRemoteOutContainer(java.lang.String programID,
ReadWriteContainer container)
The native implementation of the Java API does not support this method. |
ProcessInstance[] |
ProcessInstanceList.queryProcessInstances()
This API call retrieves the primary information for all process instances characterized by the specified process instance list from the MQ Workflow execution server (action call). |
int |
ProcessInstanceList.queryProcessInstancesResultSize()
This API call returns the number of qualifying process instances characterized by the specified process instance list from the MQ Workflow execution server (action call). |
boolean |
Service.isLoggedOn()
Indicates whether a user logged on via this service object. |
int |
Service.reconnectCount()
Returns the number of times the client tries to reconnect to a server in cases where the client connection is lost. |
java.lang.String |
Service.systemName()
Returns the name of the system where the server resides. |
java.lang.String |
Service.systemGroupName()
Returns the name of the system group where the server resides. |
int |
Service.timeout()
Returns the time the client will wait for a server to answer. |
java.lang.String |
Service.userID()
Returns the user identification of the logged-on user. |
void |
Service.refresh()
This API call refreshes the logon status from the server (action call). |
void |
Service.setReconnectCount(int count)
Sets the number of times |
void |
Service.setPassword(java.lang.String newPassword)
This API call allows a user's password to be changed (action call). |
void |
Service.setTimeout(int timeout)
Sets the time |
Person |
Service.userSettings()
This API call returns all settings of the logged on user (action call). |
Type |
WorkItem.activityKind()
Returns the kind of the associated activity instance, whether it is a program or process and so on. |
FmcError |
WorkItem.errorReason()
Returns an error object describing the reason why the associated activity instance is in state InError. |
java.lang.String |
WorkItem.exitCondition()
Returns the exit condition of the work item. |
java.util.Calendar |
WorkItem.expirationTime()
Returns the expiration time of the work item. |
java.util.Calendar |
WorkItem.firstNotificationTime()
Returns the time the first notification for the work item is to occur or has occurred. |
java.lang.String |
WorkItem.implementation()
Returns the name of the implementing program of the associated activity instance. |
boolean |
WorkItem.manualExitMode()
Returns whether the exit mode |
boolean |
WorkItem.manualStartMode()
Returns whether the start mode of the work item is manual. |
java.lang.String |
WorkItem.persistentOidOfActivityInstance()
Returns the object ID of the associated activity instance. |
int |
WorkItem.priority()
Returns the priority of the work item. |
java.util.Calendar |
WorkItem.secondNotificationTime()
Returns the time the second notification for the work item is to occur or has occurred. |
java.lang.String[] |
WorkItem.staff()
Returns all persons owning a work item |
java.lang.String |
WorkItem.startCondition()
Returns the start condition of the work item. |
ExecutionState |
WorkItem.state()
Returns the state of the work item. |
Escalation |
WorkItem.stateOfNotification()
Returns the notification state of the work item. |
java.lang.String[] |
WorkItem.supportTools()
Returns the support tools associated with the work item. |
ActivityInstance |
WorkItem.activityInstance()
This API call retrieves the activity instance the work item is associated to from the MQ Workflow execution server (action call). |
void |
WorkItem.cancelCheckOut()
This API call cancels the checkout of the work item (action call). |
void |
WorkItem.checkIn(ReadWriteContainer outContainer,
int returnCode)
This API call allows for the check in of a work item that was previously checked out for user processing (action call). |
ReadOnlyContainer |
WorkItem.checkOut()
This API call checks out a ready work item for user processing (action call). |
ProgramData |
WorkItem.checkOut2(ProgramRetrieval requestedData,
Basis platform)
See checkOut; additionally allows for specifying which program definitions to retrieve. |
void |
WorkItem.finish()
This API call ends the execution of a manual-exit work item (action call). |
void |
WorkItem.forceFinish()
This API call ends the execution of a work item which is known to have completed (action call). |
void |
WorkItem.forceFinish2(Container outputContainer)
See WorkItem.forceFinish() ;
allows for the specification of an output container. |
void |
WorkItem.forceRestart()
This API call forces MQ Workflow to enable the restart of a work item (action call). |
void |
WorkItem.forceRestart2(Container inputContainer)
See WorkItem.forceRestart() ; allows for the specification of an input
container. |
ReadOnlyContainer |
WorkItem.inContainer()
This API call retrieves the input container associated with the work item from the MQ Workflow execution server (action call). |
ReadWriteContainer |
WorkItem.outContainer()
This API call retrieves the output container associated with the work item from the MQ Workflow execution server (action call). |
void |
WorkItem.restart()
This API call asks MQ Workflow to enable the restart of a work item (action call). |
void |
WorkItem.start()
This API call starts a ready work item (action call). |
void |
WorkItem.startTool(java.lang.String toolName)
This API call starts the specified support tool (action call). |
void |
WorkItem.terminate()
This API call terminates a work item implemented by a program or process (action call). |
boolean |
WorkList.beepOption()
Indicates whether a beep should sound when the contents of the worklist changes. |
ActivityInstanceNotification[] |
WorkList.queryActivityInstanceNotifications()
This API call retrieves the primary information for all activity instance notifications characterized by the specified worklist from the MQ Workflow execution server (action call). |
Item[] |
WorkList.queryItems()
This API call retrieves the primary information for all items characterized by the specified worklist from the MQ Workflow execution server (action call). |
ProcessInstanceNotification[] |
WorkList.queryProcessInstanceNotifications()
This API call retrieves the primary information for all process instance notifications characterized by the specified worklist from the MQ Workflow execution server (action call). |
WorkItem[] |
WorkList.queryWorkItems()
This API call retrieves the primary information for all work items characterized by the specified worklist from the MQ Workflow execution server (action call). |
int |
WorkList.queryActivityInstanceNotificationsResultSize()
This API call returns the number of qualifying activity instance notification characterized by the specified worklist from the MQ Workflow execution server (action call). |
int |
WorkList.queryItemsResultSize()
This API call returns the number of qualifying items characterized by the specified worklist from the MQ Workflow execution server (action call). |
int |
WorkList.queryProcessInstanceNotificationsResultSize()
This API call returns the number of qualifying process instance notification characterized by the specified worklist from the MQ Workflow execution server (action call). |
int |
WorkList.queryWorkItemsResultSize()
This API call returns the number of qualifying work items characterized by the specified worklist from the MQ Workflow execution server (action call). |
boolean |
ProcessInstance.isEmpty()
Indicates whether no process instance information is available. |
boolean |
ProcessInstance.isComplete()
Indicates whether the complete process instance information is available. |
AuditSetting |
ProcessInstance.auditMode()
Returns the audit mode of the process instance. |
java.lang.String |
ProcessInstance.category()
Returns the category of the process instance. |
java.util.Calendar |
ProcessInstance.creationTime()
Returns the creation time of the process instance. |
java.lang.String |
ProcessInstance.creator()
Returns the creator of the process instance. |
java.lang.String |
ProcessInstance.description()
Returns the description of the process instance. |
java.lang.String |
ProcessInstance.documentation()
Returns the documentation of the process instance. |
java.util.Calendar |
ProcessInstance.endTime()
Returns the end time of the process instance. |
java.lang.String |
ProcessInstance.icon()
Returns the icon associated with the process instance. |
java.lang.String |
ProcessInstance.inContainerName()
Returns the name of the input container of the process instance. |
boolean |
ProcessInstance.inContainerNeeded()
Indicates whether an input container is needed to start the process instance. |
java.util.Calendar |
ProcessInstance.lastModificationTime()
Returns the last time a primary attribute of the process instance was changed. |
java.util.Calendar |
ProcessInstance.lastStateChangeTime()
Returns the last time the state of the process instance was changed. |
java.lang.String |
ProcessInstance.name()
Returns the name of the process instance. |
java.util.Calendar |
ProcessInstance.notificationTime()
Returns the notification time of the process instance. |
java.lang.String |
ProcessInstance.notifiedPerson()
Returns the person who received the notification. |
java.lang.String |
ProcessInstance.organizationName()
Returns the name of the organization of the process instance. |
java.lang.String |
ProcessInstance.outContainerName()
Returns the name of the output container of the process instance. |
java.lang.String |
ProcessInstance.parentName()
Returns the name of the parent process instance of this process instance. |
java.lang.String |
ProcessInstance.persistentOid()
Returns a representation of the object identification of the process instance. |
java.lang.String |
ProcessInstance.persistentOidOfProcessTemplate()
Returns a representation of the object identification of the process template the process instance is derived from. |
java.lang.String |
ProcessInstance.processAdmin()
Returns the user ID of the process administrator of the process instance. |
java.lang.String |
ProcessInstance.processContext()
Returns the user-specified context of the process instance. |
java.lang.String |
ProcessInstance.processTemplateName()
Returns the name of the process template the process instance is derived from. |
java.lang.String |
ProcessInstance.roleName()
Returns the name of the role of the process instance. |
java.lang.String |
ProcessInstance.starter()
Returns the starter of the process instance. |
java.util.Calendar |
ProcessInstance.startTime()
Returns the start time of the process instance. |
ExecutionState |
ProcessInstance.state()
Returns the state of the process instance. |
Escalation |
ProcessInstance.stateOfNotification()
Returns the notification state of the process instance. |
java.util.Calendar |
ProcessInstance.suspensionExpirationTime()
Returns the suspension expiration time of the process instance. |
java.util.Calendar |
ProcessInstance.suspensionTime()
Returns the time the process instance was suspended. |
java.lang.String |
ProcessInstance.systemGroupName()
Returns the name of the system group where the process instance runs. |
java.lang.String |
ProcessInstance.systemName()
Returns the name of the system where the process instance runs. |
java.lang.String |
ProcessInstance.topLevelName()
Returns the name of the top level process instance of this process instance. |
java.util.Calendar |
ProcessInstance.validFromTime()
Returns the time from when on the associated process template is valid. |
void |
ProcessInstance.delete()
This API call deletes the specified process instance from the MQ Workflow execution server (action call). |
ReadOnlyContainer |
ProcessInstance.globalContainer()
This API call retrieves the global container associated with the process instance from the MQ Workflow execution server (action call). |
ReadWriteContainer |
ProcessInstance.inContainer()
This API call retrieves the input container associated with the process instance from the MQ Workflow execution server (action call). |
InstanceMonitor |
ProcessInstance.obtainProcessMonitor(boolean deep)
This API call obtains a monitor for the process instance from the MQ Workflow execution server (action call). |
ReadOnlyContainer |
ProcessInstance.outContainer()
This API call retrieves the output container associated with the process instance from the MQ Workflow execution server (action call). |
void |
ProcessInstance.refresh()
This API call refreshes the process instance from the MQ Workflow execution server (action call). |
void |
ProcessInstance.restart()
This API call restarts the process instance on the MQ Workflow execution server (action call). |
void |
ProcessInstance.resume(boolean deep)
This API call resumes processing of a suspended or suspending process instance (action call). |
void |
ProcessInstance.setDescription(java.lang.String description)
This API call sets the description of the process instance to the specified value (action call). |
void |
ProcessInstance.setName(java.lang.String name)
This API call sets the name of the process instance to the specified value (action call). |
void |
ProcessInstance.setProcessAdmin(java.lang.String administrator)
This API call sets the process administrator to the specified user ID (action call). |
void |
ProcessInstance.start()
This API call starts a ready process instance (action call). |
void |
ProcessInstance.start2(ReadWriteContainer input)
See start; additionally allows to pass an input container. |
void |
ProcessInstance.start3(ReadWriteContainer inContainer,
java.lang.String processContext)
See start; additionally allows to pass an input container and a process context. |
void |
ProcessInstance.suspend(boolean deep)
This API call suspends (temporarily stops) the process instance (action call). |
void |
ProcessInstance.suspend2(java.util.Calendar time,
boolean deep)
See suspend; additionally allows to provide a date at which the process instance is automatically resumed. |
void |
ProcessInstance.terminate()
This API call terminates a process instance and all of its non-autonomous subprocesses (action call). |
boolean |
Container.isEmpty()
Indicates whether no container information is available. |
int |
Container.allLeafCount()
Returns the number of leaf elements of the container including the MQ Workflow predefined members. |
ContainerElement[] |
Container.allLeaves()
Returns all leaf elements of the container including the MQ Workflow predefined members. |
int |
Container.leafCount()
Returns the number of user-defined leaf elements of the container. |
ContainerElement[] |
Container.leaves()
Returns all user-defined leaf elements of the container. |
int |
Container.memberCount()
Returns the number of structural members in the container. |
ContainerElement[] |
Container.structMembers()
Returns the structural members of the container. |
java.lang.String |
Container.type()
Returns the type of the container, that is, the data structure name. |
byte[] |
Container.asStream()
Returns the container as a binary stream of data. |
byte[] |
Container.getBuffer(java.lang.String qualifiedName)
Returns the value of the specified container leaf element in Java. |
byte[] |
Container.getBuffer2(java.lang.String qualifiedName,
int index)
Returns the value of the specified container leaf element in Java. |
double |
Container.getDouble(java.lang.String qualifiedName)
Returns the value of the specified container leaf element in Java. |
double |
Container.getDouble2(java.lang.String qualifiedName,
int index)
Returns the value of the specified container leaf element in Java. |
ContainerElement |
Container.getElement(java.lang.String qualifiedName)
Provides access to a container element. |
int |
Container.getLong(java.lang.String qualifiedName)
Returns the value of the specified container leaf element in Java. |
int |
Container.getLong2(java.lang.String qualifiedName,
int index)
Returns the value of the specified container leaf element in Java. |
java.lang.String |
Container.getString(java.lang.String qualifiedName)
Returns the value of the specified container leaf element in Java. |
java.lang.String |
Container.getString2(java.lang.String qualifiedName,
int index)
Returns the value of the specified container leaf element in Java. |
boolean |
PersistentList.isEmpty()
Indicates whether no persistent list information is available. |
java.lang.String |
PersistentList.description()
Returns the description of the persistent list. |
java.lang.String |
PersistentList.filter()
Returns the filter of the persistent list. |
java.lang.String |
PersistentList.name()
Returns the name of the persistent list. |
java.lang.String |
PersistentList.ownerOfList()
Returns the user ID of the owner of the persistent list. |
java.lang.String |
PersistentList.persistentOid()
Returns a representation of the object identification of the persistent list. |
java.lang.String |
PersistentList.sortCriteria()
Returns the sort criteria of the persistent list. |
java.lang.Integer |
PersistentList.threshold()
Returns the threshold of the persistent list. |
TypeOfList |
PersistentList.type()
Returns the type of the persistent list, whether it is a public or private list. |
void |
PersistentList.delete()
This API call deletes the specified persistent list from the MQ Workflow execution server (action call). |
void |
PersistentList.refresh()
This API call refreshes the persistent list from the MQ Workflow execution server (action call). |
void |
PersistentList.setDescription(java.lang.String description)
This API call sets the description of the persistent list to the specified value (action call). |
void |
PersistentList.setFilter(java.lang.String newFilter)
This API call sets the filter of the persistent list to the specified value (action call). |
void |
PersistentList.setSortCriteria(java.lang.String sortCriteria)
This API call sets the sort criteria of the persistent list to the specified value (action call). |
void |
PersistentList.setThreshold(java.lang.Integer threshold)
This API call sets the threshold of the persistent list to the specified value (action call). |
Constructors in com.ibm.workflow.api with parameters of type FmcException | |
FmcException(FmcException le)
Used internally to construct an exception. |
Uses of FmcException in com.ibm.workflow.api.ProgramTemplatePackage |
---|
Methods in com.ibm.workflow.api.ProgramTemplatePackage that throw FmcException | |
DllOptions |
Options.dllOptions()
|
ExeOptions |
Options.exeOptions()
|
ExternalOptions |
Options.externalOptions()
|
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |