All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.workflow.api.ProcessTemplate
- public interface ProcessTemplate
- Version:
- 3.2.0.2
-
auditMode()
- Returns the audit mode of
the process template.
-
category()
- Returns the category of the
process template.
-
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).
-
createAndStartInstance2(String, String, String, ReadWriteContainer, boolean)
-
See createAndStartInstance; additionally allows to pass an input
container.
-
createInstance(String, String, String, boolean)
-
This function/method creates a process instance from the specified process
template (action call).
-
creationTime()
- Returns the creation
time of the process template.
-
delete()
-
This function/method deletes the specified process template(s) from the
execution server (action call).
-
delete2(boolean, boolean, boolean)
-
See delete; additionally allows for specifying the versions to be
deleted.
-
description()
- Returns the description
of the process template.
-
documentation()
- Returns the
documentation of the process template.
-
icon()
- Returns the icon associated with
the process template.
-
inContainer()
-
This function/method retrieves the input container associated with the
process template from the MQ Workflow execution server (action
call).
-
inContainerName()
- Returns the name of
the input container of the process template.
-
inContainerNeeded()
- Indicates whether
an input container is needed to start an instance of the process
template.
-
isComplete()
- Indicates whether the
complete process template information is available.
-
isEmpty()
- Indicates whether no process
template information is available.
-
lastModificationTime()
- Returns the last
time a primary attribute of the process template was changed.
-
name()
- Returns the name of the process
template.
-
organizationName()
- Returns the name of
the organization of the process template.
-
outContainerName()
- Returns the name of
the output container of the process template.
-
persistentOid()
- Returns a
representation of the object identification of the process template.
-
processAdmin()
- Returns the user ID of
the process administrator of an instance of the process template.
-
refresh()
-
This function/method refreshes the process template from the MQ Workflow
execution server (action call).
-
roleName()
- Returns the name of the role
of the process template.
-
validFromTime()
- Returns the time when
the process template becomes valid.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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:
- You can specify a maximum of 63 characters.
- You can use any printable characters depending on your current locale,
except the following:
* ? " ; : . $
- You can use blanks with these restrictions: no leading blanks, no
trailing blanks, and no consecutive blanks.
If a unique name may be generated by MQ Workflow, the following
applies:
- If no name or an empty process instance name is provided, an instance is
created with a default name ProcessTemplateName$Oid, where
Oid is a printable version of the process instance object
identifier. Since the process instance name cannot be longer than 63
characters, the process template name can be shortened.
- If a process instance name is provided, that name is kept as long as it is
unique. If the provided process instance name is already used for
another instance, an instance is created with the name name$Oid,
where Oid is a printable version of the process instance object
identifier. Since the process instance name cannot be longer than 63
characters, the name can be shortened.
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.
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:
- You can specify a maximum of 63 characters.
- You can use any printable characters depending on your current locale,
except the following:
* ? " ; : . $
- You can use blanks with these restrictions: no leading blanks, no
trailing blanks, and no consecutive blanks.
If a unique name may be generated by MQ Workflow, the following
applies:
- If no or an empty process instance name is provided, an instance is
created with a default name ProcessTemplateName$Oid, where
Oid is a printable version of the process instance object
identifier. Since the process instance name cannot be longer than 63
characters, the process template name can be shortened.
- If a process instance name is provided, that name is kept as long as it is
unique. If the provided process instance name is already used for
another instance, an instance is created with the name name$Oid,
where Oid is a printable version of the process instance object
identifier. Since the process instance name cannot be longer than 63
characters, the name can be shortened.
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.
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.
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.
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.
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.
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