|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
---|---|
AuditSetting |
auditMode()
Returns the audit mode of the process template. |
java.lang.String |
category()
Returns the category of the process template. |
ProcessInstance |
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 |
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 |
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 |
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). |
java.util.Calendar |
creationTime()
Returns the creation time of the process template. |
void |
delete()
This API call deletes the specified process template(s) from the execution server (action call). |
void |
delete2(boolean pastVersions,
boolean currentVersion,
boolean futureVersions)
See delete; additionally allows for specifying the versions to be deleted. |
java.lang.String |
description()
Returns the description of the process template. |
java.lang.String |
documentation()
Returns the documentation of the process template. |
ProcessInstance |
executeProcessInstance(ReadOnlyContainerHolder output,
java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
boolean keepName)
|
ProcessInstance |
executeProcessInstance2(ReadWriteContainer input,
ReadOnlyContainerHolder output,
java.lang.String instanceName,
java.lang.String reserved1,
java.lang.String reserved2,
boolean keepName)
|
ProcessInstance |
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. |
java.lang.String |
icon()
Returns the icon associated with the process template. |
java.lang.String |
inContainerName()
Returns the name of the input container of the process template. |
boolean |
inContainerNeeded()
Indicates whether an input container is needed to start an instance of the process template. |
ReadWriteContainer |
initialInContainer()
This API call retrieves the input container associated with the process template from the MQ Workflow execution server (action call). |
boolean |
isComplete()
Indicates whether the complete process template information is available. |
boolean |
isEmpty()
Indicates whether no process template information is available. |
java.util.Calendar |
lastModificationTime()
Returns the last time a primary attribute of the process template was changed. |
java.lang.String |
name()
Returns the name of the process template. |
java.lang.String |
organizationName()
Returns the name of the organization of the process template. |
java.lang.String |
outContainerName()
Returns the name of the output container of the process template. |
java.lang.String |
persistentOid()
Returns a representation of the object identification of the process template. |
java.lang.String |
processAdmin()
Returns the user ID of the process administrator of an instance of the process template. |
ProgramTemplate |
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 |
refresh()
This API call refreshes the process template from the MQ Workflow execution server (action call). |
java.lang.String |
roleName()
Returns the name of the role of the process template. |
java.util.Calendar |
validFromTime()
Returns the time when the process template becomes valid. |
Method Detail |
public boolean isEmpty() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isComplete() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public AuditSetting auditMode() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String category() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar creationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String description() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String documentation() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String icon() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String inContainerName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean inContainerNeeded() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar lastModificationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String name() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String organizationName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String outContainerName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String persistentOid() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processAdmin() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String roleName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar validFromTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ProcessInstance createInstance(java.lang.String instanceName, java.lang.String reserved1, java.lang.String reserved2, boolean keepName) throws FmcException
This API call creates a process instance from the specified process template (action call).
Depending on the keepName option, a process instance name must be provided. If the process instance name is to be kept as is, you cannot provide an empty string.
The following rules apply for specifying a process instance name:
* ? " ; : . $
If a unique name may be generated by MQ Workflow, the following applies:
The passed name parameter value remains unchanged; FmcjProcessInstance::Name() returns the actual name of the process instance created. The newly created process instance contains the primary attribute values only.
Pass null or an empty string for the reserved parameters.
FmcException
- thrown if an API error or a communication error occurred.public ProcessInstance createAndStartInstance(java.lang.String instanceName, java.lang.String reserved1, java.lang.String reserved2, boolean keepName) throws FmcException
This API call creates a process instance from the specified process template and starts the resulting process instance (action call). Optionally, context information meaningful to the caller can be provided. That information accompanies the started process instance throughout its lifetime and can be used when searching for process instances.
Depending on the keepName option, a process instance name must be provided. If the process instance name is to be kept as is, you cannot provide an empty string.
The following rules apply for specifying a process instance name:
* ? " ; : . $
If a unique name may be generated by MQ Workflow, the following applies:
The passed name parameter value remains unchanged; FmcjProcessInstance::Name() returns the actual name of the process instance created.
When initial values are to be passed to the process instance to be created and started, an input container can be provided - see also FmcjProcessTemplate::InitialInContainer(). When a process instance that requires input is started without specifying an input container, the input-container values are not set. When, for example, input-container values are queried from within an activity implementation, FMC_ERROR_MEMBER_NOT_SET is returned.
Pass null or an empty string for the reserved parameters.
When successfully executed, the starter of the process instance is set to the requestor of this action and the process administrator is determined, the starting activities are determined and maybe started or work items are created, and the global container is set when available.
FmcException
- thrown if an API error or a communication error occurred.public ProcessInstance createAndStartInstance2(java.lang.String instanceName, java.lang.String reserved1, java.lang.String reserved2, ReadWriteContainer input, boolean keepName) throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ProcessInstance createAndStartInstance3(java.lang.String instanceName, java.lang.String reserved1, java.lang.String reserved2, ReadWriteContainer inContainer, boolean keepName, java.lang.String processContext) throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ProcessInstance executeProcessInstance(ReadOnlyContainerHolder output, java.lang.String instanceName, java.lang.String reserved1, java.lang.String reserved2, boolean keepName) throws FmcException
public ProcessInstance executeProcessInstance2(ReadWriteContainer input, ReadOnlyContainerHolder output, java.lang.String instanceName, java.lang.String reserved1, java.lang.String reserved2, boolean keepName) throws FmcException
public ProcessInstance executeProcessInstance3(ReadWriteContainer inContainer, ReadOnlyContainerHolder output, java.lang.String instanceName, java.lang.String reserved1, java.lang.String reserved2, boolean keepName, java.lang.String processContext) throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public void delete() throws FmcException
This API call deletes the specified process template(s) from the execution server (action call).
As long as there are process instances that are derived from the process template, the process template is only marked for deletion. The process template is, however, no longer visible, that is, can no longer be retrieved, does no longer show up in a process template list, and new process instances cannot be created.
Since process templates are versioned, you can specify whether you want to delete the currently valid process template, the past versions of the process template, or the future versions of the process template. When all options are specified, all versions of the process template are deleted. Deletion always applies to the currently exisiting process templates only.
FmcException
- thrown if an API error or a communication error occurred.public void delete2(boolean pastVersions, boolean currentVersion, boolean futureVersions) throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ReadWriteContainer initialInContainer() throws FmcException
This API call retrieves the input container associated with the process template from the MQ Workflow execution server (action call).
FmcException
- thrown if an API error or a communication error occurred.public ProgramTemplate programTemplate(java.lang.String programName) throws FmcException
This API call retrieves the program template identified by the passed name from the MQ Workflow execution server (action call).
A program template comprises data about its associated input and output containers, implementation data for all specified platforms and various other properties. In case structures from activity was specified for the program during Buildtime, no input or output container information is available; any container can be passed to the program when executed.
When containers are provided for a program template, then they are initial containers. Such, no default values are set for data members. Also predefined data members are not set.
The result of calling this API call is dependent on the system where the request is executed because there are values returned that can be inherited from the system.
The program template is versioned within the context of the corresponding process template.
FmcException
- thrown if an API error or a communication error occurred.public void refresh() throws FmcException
This API call refreshes the process template from the MQ Workflow execution server (action call).
All information about the process template - primary and secondary - is retrieved.
FmcException
- thrown if an API error or a communication error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |