All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.ProcessTemplate

public interface ProcessTemplate
Version:
3.2.0.2

Method Index

 o auditMode()
Returns the audit mode of the process template.
 o category()
Returns the category of the process template.
 o createAndStartInstance(String, String, String, boolean)

This function/method creates a process instance from the specified process template and starts the resulting process instance (action call).

 o createAndStartInstance2(String, String, String, ReadWriteContainer, boolean)

See createAndStartInstance; additionally allows to pass an input container.

 o createInstance(String, String, String, boolean)

This function/method creates a process instance from the specified process template (action call).

 o creationTime()
Returns the creation time of the process template.
 o delete()

This function/method deletes the specified process template(s) from the execution server (action call).

 o delete2(boolean, boolean, boolean)

See delete; additionally allows for specifying the versions to be deleted.

 o description()
Returns the description of the process template.
 o documentation()
Returns the documentation of the process template.
 o icon()
Returns the icon associated with the process template.
 o inContainer()

This function/method retrieves the input container associated with the process template from the MQ Workflow execution server (action call).

 o inContainerName()
Returns the name of the input container of the process template.
 o inContainerNeeded()
Indicates whether an input container is needed to start an instance of the process template.
 o isComplete()
Indicates whether the complete process template information is available.
 o isEmpty()
Indicates whether no process template information is available.
 o lastModificationTime()
Returns the last time a primary attribute of the process template was changed.
 o name()
Returns the name of the process template.
 o organizationName()
Returns the name of the organization of the process template.
 o outContainerName()
Returns the name of the output container of the process template.
 o persistentOid()
Returns a representation of the object identification of the process template.
 o processAdmin()
Returns the user ID of the process administrator of an instance of the process template.
 o refresh()

This function/method refreshes the process template from the MQ Workflow execution server (action call).

 o roleName()
Returns the name of the role of the process template.
 o validFromTime()
Returns the time when the process template becomes valid.

Methods

 o isEmpty
 public abstract boolean isEmpty() throws FmcException
Indicates whether no process template information is available.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o isComplete
 public abstract boolean isComplete() throws FmcException
Indicates whether the complete process template information is available.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o auditMode
 public abstract AuditSetting auditMode() throws FmcException
Returns the audit mode of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o category
 public abstract String category() throws FmcException
Returns the category of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o creationTime
 public abstract Calendar creationTime() throws FmcException
Returns the creation time of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o description
 public abstract String description() throws FmcException
Returns the description of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o documentation
 public abstract String documentation() throws FmcException
Returns the documentation of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o icon
 public abstract String icon() throws FmcException
Returns the icon associated with the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o inContainerName
 public abstract String inContainerName() throws FmcException
Returns the name of the input container of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o inContainerNeeded
 public abstract boolean inContainerNeeded() throws FmcException
Indicates whether an input container is needed to start an instance of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o lastModificationTime
 public abstract Calendar lastModificationTime() throws FmcException
Returns the last time a primary attribute of the process template was changed.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o name
 public abstract String name() throws FmcException
Returns the name of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o organizationName
 public abstract String organizationName() throws FmcException
Returns the name of the organization of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o outContainerName
 public abstract String outContainerName() throws FmcException
Returns the name of the output container of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o persistentOid
 public abstract String persistentOid() throws FmcException
Returns a representation of the object identification of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o processAdmin
 public abstract String processAdmin() throws FmcException
Returns the user ID of the process administrator of an instance of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o roleName
 public abstract String roleName() throws FmcException
Returns the name of the role of the process template.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o validFromTime
 public abstract Calendar validFromTime() throws FmcException
Returns the time when the process template becomes valid.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o createInstance
 public abstract ProcessInstance createInstance(String instanceName,
                                                String systemGroup,
                                                String system,
                                                boolean keepName) throws FmcException

This function/method 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 a NULL (0) pointer or an empty string for the reserved parameters.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o createAndStartInstance
 public abstract ProcessInstance createAndStartInstance(String instanceName,
                                                        String systemGroup,
                                                        String system,
                                                        boolean keepName) throws FmcException

This function/method creates a process instance from the specified process template and starts the resulting process instance (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.

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::InContainer(). 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 a NULL (0) pointer or an empty string for the reserved parameters.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o createAndStartInstance2
 public abstract ProcessInstance createAndStartInstance2(String instanceName,
                                                         String systemGroup,
                                                         String system,
                                                         ReadWriteContainer input,
                                                         boolean keepName) throws FmcException

See createAndStartInstance; additionally allows to pass an input container.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o delete
 public abstract void delete() throws FmcException

This function/method deletes the specified process template(s) from the execution server (action call).

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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o delete2
 public abstract void delete2(boolean pastVersions,
                              boolean currentVersion,
                              boolean futureVersions) throws FmcException

See delete; additionally allows for specifying the versions to be deleted.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o inContainer
 public abstract ReadWriteContainer inContainer() throws FmcException

This function/method retrieves the input container associated with the process template from the MQ Workflow execution server (action call).

Throws: FmcException
thrown if an API error or a communication error occurred.
 o refresh
 public abstract void refresh() throws FmcException

This function/method refreshes the process template from the MQ Workflow execution server (action call).

All information about the process template - primary and secondary - is retrieved.

Throws: FmcException
thrown if an API error or a communication error occurred.

All Packages  Class Hierarchy  This Package  Previous  Next  Index