public interface IDfActivity extends IDfSysObject
Modifier and Type | Field and Description |
---|---|
static int |
EXEC_SUBTYPE_DEFAULT |
static int |
EXEC_SUBTYPE_INBOUND |
static int |
EXEC_SUBTYPE_INBOUND_INITIATE |
static int |
EXEC_SUBTYPE_MANUAL_INITIATE |
static int |
PACKAGE_CAN_BE_EMPTY
Flag bit used to indicate that this package can be empty at the end of this activity.
|
static int |
PACKAGE_IS_VISIBLE
Flag bit used to indicate that this package is visible to this activity.
|
static java.lang.String |
PORT_TYPE_EXCEPTION |
static java.lang.String |
PORT_TYPE_INPUT |
static java.lang.String |
PORT_TYPE_OUTPUT |
static java.lang.String |
PORT_TYPE_REVERT |
static java.lang.String |
USE_CONDITION_PERFORMER |
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
void |
addConditionRouteCase(java.lang.String routeCaseIdentifier,
IDfList conditions,
IDfList outputPorts)
Adds a route case to the activity.
|
void |
addPackageInfo(java.lang.String portName,
java.lang.String packageName,
java.lang.String packageType,
IDfId packageId,
java.lang.String packageLabel,
java.lang.String packageOperation)
Adds a package definition to a port in the activity.
|
void |
addPackageInfoEx(java.lang.String portName,
java.lang.String packageName,
java.lang.String packageType,
IDfId packageId,
java.lang.String packageLabel,
java.lang.String packageOperation,
int packageFlag)
Adds a package definition to a port in the activity.
|
void |
addPackageInfoEx(java.lang.String portName,
java.lang.String packageName,
java.lang.String packageType,
IDfId packageId,
java.lang.String packageLabel,
java.lang.String packageOperation,
int packageFlag,
int packageReportFlag)
Adds a package definition to a port in the activity.
|
void |
addPerformerCondition(java.lang.String conditionName,
java.lang.String condition,
IDfList performers)
Adds a performer case to the activity.
|
void |
addPort(java.lang.String portName,
java.lang.String portType)
Adds a port to the activity.
|
void |
addPostTimerAction(IDfId action,
int minutes)
Establishes a timer at the end of the series.
|
void |
addPreTimerAction(IDfId action,
int minutes)
Establishes a timer at the end of the series.
|
void |
addRouteCase(java.lang.String routeCaseIdentifier,
java.lang.String condition,
IDfList outputPorts)
Adds a route case to the activity.
|
int |
getConditionCount()
Returns the number of routing conditions in the activity.
|
IDfId |
getConditionId()
Returns the object ID of the repository object that stores
the route case conditions.
|
java.lang.String |
getConditionName(int index)
Returns the name of a route case.
|
java.lang.String |
getConditionPort(int index)
Returns the output ports associated with a specified route case.
|
IDfList |
getConditions(java.lang.String routeCaseIdentifier)
Returns the list (or list of lists) of transition condition definitions for the named route case.
|
int |
getControlFlag()
Returns the control flag attribute of the activity.
|
java.lang.String |
getDefinitionState()
Returns the state of the activity definition.
|
int |
getExecErrHandling()
Returns information about how the activity's runtime instance
handles execution failure.
|
IDfId |
getExecMethodId()
Returns the object ID of the method object that executes the
activity's actions.
|
int |
getExecRetryInterval()
Returns the retry interval if the method execution fails for
the activity
For more information about activity execution, refer to
Server Fundamentals.
|
int |
getExecRetryMax()
Returns the maximum retry number if the method execution fails for
the activity
For more information about activity execution, refer to
Server Fundamentals.
|
int |
getExecSubtype()
Returns the exec_subtype attribute of the activity.
|
int |
getExecTimeOut()
Returns the time-out period, in seconds, for the method that
executes the activity's actions.
|
int |
getExecType()
Returns the execution type of the activity.
|
int |
getPackageCount()
Returns the number of packages associated with the activity.
|
int |
getPackageFlag(int index)
Returns the flag of a specified package.
|
IDfId |
getPackageId(int index)
Returns the object ID of a specified package.
|
java.lang.String |
getPackageLabel(int index)
Returns the version label associated with the package.
|
java.lang.String |
getPackageName(int index)
Returns the name of a specified package.
|
java.lang.String |
getPackageOperation(int index)
Returns information about the operation to be performed on
a specified package.
|
int |
getPackageReportFlag(int index)
Returns the report flag of a specified package.
|
IDfCollection |
getPackagesMetaData()
Returns a query result collection containing the following attributes:
r_package_name String
r_package_type Int
r_package_label String
r_package_flag Int
The collection is the metadata for the packages defined on an OUTPUT port;
If there is no output port, it returns meta data of packages defined on an INPUT port.
|
java.lang.String |
getPackageType(int index)
Returns the type of a specified package.
|
int |
getPerfCondIndex(java.lang.String condName)
Returns the index position of the corresponding condition in the expression object for the given performer condition.
|
java.lang.String |
getPerformerCondition(java.lang.String condtionName)
For the given condition name, return the corresponding performer condition.
|
int |
getPerformerConditionCount()
Returns the number of performer conditions in the activity.
|
IDfId |
getPerformerConditionId()
Returns the object ID of the repository object that stores
the performer conditions.
|
java.lang.String |
getPerformerConditionName(int index)
Returns the name of a performer condition.
|
IDfList |
getPerformerConditionNames()
Return a String list that contains the name of the performer conditions.
|
java.lang.String |
getPerformerConditionUser(int index)
Returns the user associated with a specified performer condition.
|
int |
getPerformerFlag()
Indicates whether the activity's performer can delegate or extend
the activity.
|
java.lang.String |
getPerformerName()
Returns the name of the user or group intended to perform the activity.
|
int |
getPerformerNameCount()
Returns the number of values the performer name attribute has.
|
IDfList |
getPerformers(java.lang.String conditionName)
For the given condition name, return a String list of performers used for this condition.
|
int |
getPerformerType()
Returns the kind of user who can perform the activity.
|
int |
getPortCount()
Returns the number of ports in the activity.
|
java.lang.String |
getPortName(int index)
Returns the name of a specified port.
|
java.lang.String |
getPortType(int index)
Returns the type of a specified port.
|
int |
getPostTimer()
Returns the post-timer value defined for the activity.
|
IDfId |
getPostTimerAction(int index)
Returns the ID of a timer action object at the given index within a timer series.
|
int |
getPostTimerCount()
Returns the number of timer actions within the series.
|
int |
getPostTimerIncrement(int index)
Returns the interval in minutes that must pass before the timer is fired.
|
int |
getPreTimer()
Returns the pre-timer value for the activity.
|
IDfId |
getPreTimerAction(int index)
Returns the ID of a timer action object at the given index within a timer series.
|
int |
getPreTimerCount()
Returns the number of timer actions within the series.
|
int |
getPreTimerIncrement(int index)
Returns the interval in minutes that must pass before the timer is fired.
|
java.lang.String |
getRepeatingPerformerName(int index)
Returns the performer name attribute at the specified index.
|
java.lang.String |
getResolvePackageName()
Returns the package name used to resolve performer aliasing.
|
int |
getResolveType()
Returns the performer aliasing resolve type of the activity.
|
java.lang.String |
getRouteCaseCondition(java.lang.String RouteCaseIdentifier)
Returns the route case condition of the given route case identifier.
|
IDfList |
getRouteCaseIdentifiers()
Returns a String list that contains the name of the route case identifiers.
|
IDfList |
getRouteCasePorts(java.lang.String RouteCaseIdentifier)
Returns a String list that contains the output ports of the given route case identifier.
|
boolean |
getSignoffRequired()
Indicates whether the activity requires a sign off.
|
java.lang.String |
getTaskSubject()
Returns a subject for the task inbox item, the subject will be constructed at
the creation time of the inbox item
|
int |
getTransitionEvalCount()
Returns the number of completed tasks that are required to trigger
the next activities.
|
int |
getTransitionFlag()
Returns when and how to trigger the selected outgoing paths
when activity is manual transition
|
int |
getTransitionMaxOutputCount()
Returns the maximum number of output ports user can select at runtime
when activity is manual transition
|
int |
getTransitionType()
Returns the type of transition defined for the activity.
|
java.lang.String |
getTriggerEvent()
Returns the expected event type that can trigger the activity.
|
int |
getTriggerThreshold()
Returns the number of input ports in the activity that must be
triggered to start the activity.
|
boolean |
hasCompatibilityRouteCases()
Indicates whether or not this activity supports compatibility (pre-5.3) route cases.
|
void |
install()
Installs a validated activity.
|
void |
invalidate()
Moves a validated activity to the draft state.
|
boolean |
isExecSaveResults()
Indicates whether the results of the activity's actions are saved to a document.
|
boolean |
isPostTimerRepeatLastAction()
Indicates if the final timer in the series should repeat.
|
boolean |
isPreTimerRepeatLastAction()
Indicates if the final timer in the series should repeat.
|
boolean |
isPrivate()
Indicates whether the activity is a public or private activity.
|
boolean |
isRepeatableInvoke()
Indicates whether the activity can be invoked multiple times when the
workflow is running.
|
IDfAttributeValueCondition |
newAttributeValueCondition()
Factory method for attribute value transition conditions.
|
IDfXPathCondition |
newXPathCondition()
Factory method for XPath transition conditions.
|
void |
removePackageInfo(java.lang.String portName,
java.lang.String packageName)
Removes a package definition from the activity.
|
void |
removePerformerCondition(java.lang.String conditionName)
Removes a route case from the activity.
|
void |
removePort(java.lang.String portName)
Removes a port from the activity.
|
void |
removePostTimers()
Removes all pre-timers from this activity.
|
void |
removePreTimers()
Removes all pre-timers from this activity.
|
void |
removeRouteCase(java.lang.String routeCaseIdentifier)
Removes a route case from the activity.
|
void |
setControlFlag(int flag)
Sets the control flag attribute of the activity.
|
void |
setExecErrHandling(int execErrHandling)
Sets the failure-handling protocol for the activity's execution.
|
void |
setExecMethodId(IDfId execMethodId)
Identifies the method that executes the activity's actions.
|
void |
setExecRetryInterval(int execRetryInterval)
Sets the retry interval if the activity's execution fails.
|
void |
setExecRetryMax(int execRetryMax)
Sets the maximum retry number if the activity's execution fails.
|
void |
setExecSaveResults(boolean execSaveResults)
Defines whether to save the results of an automatic activity execution.
|
void |
setExecSubtype(int subType)
Defines the activity's exec_subtype.
|
void |
setExecTimeOut(int execTimeOut)
Sets the time-out period for the method that executes the
activity's actions.
|
void |
setExecType(int execType)
Defines the activity's execution type as manual or automatic.
|
void |
setPerformerFlag(int performerFlag)
Defines whether the activity's performer can delegate or extend the
activity.
|
void |
setPerformerName(java.lang.String performerName)
Defines the user or group you want to perform the activity.
|
void |
setPerformerType(int performerType)
Defines who can perform the activity.
|
void |
setPostTimer(int postTimer)
Defines the expected maximum number of hours to complete the activity.
|
void |
setPostTimerRepeatLastAction(boolean repeatLast)
Sets an indicator for whether or not the final timer in a series should repeat.
|
void |
setPreTimer(int preTimer)
Sets the pre-timer interval for the activity.
|
void |
setPreTimerRepeatLastAction(boolean repeatLast)
Sets an indicator for whether or not the final timer in a series should repeat.
|
void |
setPrivate(boolean isPrivate)
Defines the activity as public or private.
|
void |
setRepeatableInvoke(boolean repeatableInvoke)
Defines whether the activity can be invoked multiple times when the
workflow is running.
|
void |
setRepeatingPerformerName(int index,
java.lang.String name)
Sets the performer name attribute at a specified index.
|
void |
setResolvePackageName(java.lang.String resolvePkgName)
Sets the package name used to resolve performer aliasing.
|
void |
setResolveType(int resolveType)
Sets the performer aliasing resolve type of the activity.
|
void |
setSignoffRequired(boolean signoffRequired)
Defines whether the activity requires a sign off.
|
void |
setTaskSubject(java.lang.String name)
Set a subject for the task inbox item, the subject will be constructed at
the creation time of the inbox item
|
void |
setTransitionEvalCount(int count)
Set the number of completed tasks that are required to trigger
the next activities.
|
void |
setTransitionFlag(int flag)
Together with the transition eval count, set when and how to trigger
the selected outgoing paths when activity is manual transition
|
void |
setTransitionMaxOutputCount(int count)
Set the maximum number of output ports user can select at runtime
when activity is manual transition
|
void |
setTransitionType(int transitionType)
Defines the transition type for the activity.
|
void |
setTriggerEvent(java.lang.String triggerEvent)
Sets the event type that is expected to trigger the activity.
|
void |
setTriggerThreshold(int triggerThreshold)
Defines the trigger threshold for the activity.
|
void |
uninstall()
Uninstalls an activity.
|
void |
validate()
Validates the package definitions associated with the activity.
|
addDigitalSignature, addESignature, addNote, addReference, addRendition, addRenditionEx, addRenditionEx2, addRenditionEx3, appendContent, appendContentEx, appendFile, appendFileEx, appendPart, areAttributesModifiable, assemble, asVirtualDocument, attachPolicy, bindFile, branch, cancelCheckout, cancelCheckoutEx, cancelScheduledDemote, cancelScheduledPromote, cancelScheduledResume, cancelScheduledSuspend, canDemote, canPromote, canResume, canSuspend, checkin, checkinEx, checkout, checkoutEx, demote, destroyAllVersions, detachPolicy, disassemble, freeze, getAccessDate, getAccessorApplicationPermit, getAccessorCount, getAccessorName, getAccessorPermit, getAccessorPermitType, getAccessorXPermit, getAccessorXPermitNames, getACL, getACLDomain, getACLName, getAclRefValid, getAcsRequests, getAliasSet, getAliasSetId, getAntecedentId, getApplicationType, getAssembledFromId, getAuthors, getAuthorsCount, getBranchCount, getCabinetId, getChronicleId, getCollectionForContent, getCollectionForContentEx2, getCollectionForContentEx3, getCollectionForContentEx4, getComponentId, getComponentIdCount, getCompoundArchitecture, getContainId, getContainIdCount, getContent, getContentAvailability, getContentEx, getContentEx2, getContentEx3, getContentsId, getContentSize, getContentSize, getContentState, getContentStateCount, getContentType, getCreationDate, getCreatorName, getCurrentState, getCurrentStateName, getDirectDescendant, getDoubleContentAttr, getExceptionStateName, getFile, getFileEx, getFileEx2, getFolderId, getFolderIdCount, getFormat, getFrozenAssemblyCount, getFullText, getGroupName, getGroupPermit, getHasEvents, getHasFolder, getHasFrozenAssembly, getImplicitVersionLabel, getKeywords, getKeywordsCount, getLatestFlag, getLinkCount, getLinkHighCount, getLocations, getLockDate, getLockMachine, getLockOwner, getLogEntry, getMasterDocbase, getModifier, getModifyDate, getNextStateName, getObjectName, getOtherFileSize, getOwnerName, getOwnerPermit, getPageCount, getPath, getPathEx, getPathEx2, getPermissions, getPermit, getPermitEx, getPolicyId, getPolicyName, getPreviousStateName, getReferenceCount, getRemoteId, getRenditions, getResolutionLabel, getResumeState, getResumeStateName, getRetainerCount, getRetainerId, getRetainUntilDate, getRetentionDate, getRouters, getSpecialApp, getStatus, getStorageType, getStringContentAttr, getSubject, getTimeContentAttr, getTitle, getTypeName, getVdmPath, getVdmPathDQL, getVersionLabel, getVersionLabelCount, getVersionLabels, getVersionPolicy, getVersions, getWorkflows, getWorldPermit, getXPermit, getXPermitList, getXPermitNames, grant, grantPermit, hasPermission, insertContent, insertContentEx, insertFile, insertFileEx, insertPart, isArchived, isCheckedOut, isCheckedOutBy, isContentTransferCapabilityEnabled, isFrozen, isHidden, isImmutable, isLinkResolved, isPublic, isReference, isSuspended, isVirtualDocument, link, mark, mount, print, promote, prune, queue, refreshReference, removeContent, removeNote, removePart, removeRendition, removeRenditionEx, removeRenditionEx2, resolveAlias, resume, revertACL, revoke, revokePermit, saveAsNew, saveLock, scheduleDemote, schedulePromote, scheduleResume, scheduleSuspend, setACL, setACLDomain, setACLName, setApplicationType, setArchived, setAuthors, setCompoundArchitecture, setContent, setContentEx, setContentEx2, setContentType, setDoubleContentAttribute, setFile, setFileEx, setFullText, setGroupName, setGroupPermit, setHidden, setIsVirtualDocument, setKeywords, setLinkResolved, setLogEntry, setObjectName, setOwnerName, setOwnerPermit, setPath, setResolutionLabel, setSpecialApp, setStatus, setStorageType, setStringContentAttribute, setSubject, setTimeContentAttribute, setTitle, setWorldPermit, suspend, unfreeze, unlink, unmark, updatePart, updatePartEx, useACL, verifyESignature
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
static final int EXEC_SUBTYPE_DEFAULT
static final int EXEC_SUBTYPE_INBOUND
static final int EXEC_SUBTYPE_INBOUND_INITIATE
static final int EXEC_SUBTYPE_MANUAL_INITIATE
static final java.lang.String PORT_TYPE_INPUT
static final java.lang.String PORT_TYPE_OUTPUT
static final java.lang.String PORT_TYPE_REVERT
static final java.lang.String PORT_TYPE_EXCEPTION
static final java.lang.String USE_CONDITION_PERFORMER
static final int PACKAGE_IS_VISIBLE
static final int PACKAGE_CAN_BE_EMPTY
void validate() throws DfException
validate
requires Relate permission on the
activity or Sysadmin or Superuser privileges. If the method is
successful, it sets the activity's state to validated.DfException
- if the server returns an errorvoid invalidate() throws DfException
validate
requires Relate permission on the
activity or Sysadmin or Superuser privileges.DfException
- if the server returns an errorvoid install() throws DfException
install
requires Relate permission on the
activity or Sysadmin or Superuser privileges. If the method is
successful, it sets the activity's state to installed.DfException
- if the server returns an errorvoid uninstall() throws DfException
uninstall
moves an installed activity back to the validated
state. Any running workflows that reference the activity are halted. Any
installed process definitions that include the activity are set to the
uninstalled state.
Calling uninstall
requires Relate permission on the
activity or Sysadmin or Superuser privileges.DfException
- if the server returns an errorvoid addPort(java.lang.String portName, java.lang.String portType) throws DfException
addPackageInfo(java.lang.String, java.lang.String, java.lang.String, com.documentum.fc.common.IDfId, java.lang.String, java.lang.String)
or addPackageInfoEx(java.lang.String, java.lang.String, java.lang.String, com.documentum.fc.common.IDfId, java.lang.String, java.lang.String, int)
to add a package definition to the port.
For more information about workflows and defining activities,
refer to Server Fundamentals.portName
- a name for the new port. The name must be unique
among the port names in the activity.portType
- defines what kind of port this is. Valid values are:
INPUT, OUTPUT, and REVERT.DfException
- if the server returns an errorvoid removePort(java.lang.String portName) throws DfException
portName
- the name of the port you want to remove.DfException
- if the server returns an errorvoid addPackageInfo(java.lang.String portName, java.lang.String packageName, java.lang.String packageType, IDfId packageId, java.lang.String packageLabel, java.lang.String packageOperation) throws DfException
portName
must exist in the activity.
The package definition must be compatible with the definition of the package
defined for the port to which the port specified in portName
is linked. For example, if portName
represents an output
port, the definition must be compatible with the input port to which
portName
is linked. Refer to Content Server Fundamentals
for details about package compatability.
This method sets the r_package_flag attribute to 1, meaning the package
is visible and cannot be empty. If you want to set the behavior controlled by
this attribute differently, use addPackageInfoEx(java.lang.String, java.lang.String, java.lang.String, com.documentum.fc.common.IDfId, java.lang.String, java.lang.String, int)
.
For more information about packages and activities,
refer to Server Fundamentals.portName
- name of the port to which you are adding the packagepackageName
- name of the package. This must be unique among the
packages defined in the activity.packageType
- the object type of the packagepackageId
- an IDfID object that contains the package's object ID.
If you don't provide a
version label in the packageLabel
parameter, the object
identified by the object ID is bound to the port. If you include the
packageLabel
parameter, the method searches the version
tree to which the object belongs and binds the version
with the specified label to the port.packageLabel
- the version label of the package. This is an optional
argument. If you include this argument, the method binds the specified
version of the package to the port. If you don't include this argument,
the version identified by packageId
is bound to the port.packageOperation
- identifies the application that will be used to
perform the actions associated with the activity. This argument
is intended primarily for automatic activities.DfException
- if the server returns an errorvoid removePackageInfo(java.lang.String portName, java.lang.String packageName) throws DfException
portName
- the name of the port with which the package is associatedpackageName
- the name of the packageDfException
- if the server returns an errorvoid addRouteCase(java.lang.String routeCaseIdentifier, java.lang.String condition, IDfList outputPorts) throws DfException
String condition = "dm_workflow.object_name='test'"; act.addRouteCase("routecase1",condition,null);
If you reference dmi_workitem, Content Server interprets that to mean the work item referenced in the r_last_witem attribute of the workflow. If you reference dmi_package, Content Server uses the first component in the package to resolve the condition. Additionally, when you use dmi_package, the condition can only reference an attribute defined for the object type specified in the package definition. For example, if the package definition specifies dm_sysobject, but the package component is "my_sysObj_subtype", the condition must reference an attribute defined for dm_sysobject. It cannot reference an attribute defined for "my_sysobj_subtype".
For more information about route cases, refer to Server Fundamentals.routeCaseIdentifier
- the name of the route case or the keyword
exception
to identify an exception route case.condition
- the boolean condition for the route case. Specify this as
null
if the routeCaseIdentifier
is exception
if you want to change the output port list for the existing route case condition.outputPorts
- an IDfList interface that contains the names of
the selected output ports. These are the ports that will be selected if the
condition
evaluates to true
. This can be null
if you only want to change the condition associated with the route case.DfException
- if the server returns an errorvoid removeRouteCase(java.lang.String routeCaseIdentifier) throws DfException
routeCaseIdentifier
- the name of the route case. Use the keyword EXCEPTIONAL
to remove the exception route case.DfException
- if the server returns an errorIDfList getRouteCaseIdentifiers() throws DfException
DfException
java.lang.String getRouteCaseCondition(java.lang.String RouteCaseIdentifier) throws DfException
RouteCaseIdentifier
- the name of the route case or the keyword
EXCEPTIONAL
to identify an exception route case.DfException
IDfList getRouteCasePorts(java.lang.String RouteCaseIdentifier) throws DfException
RouteCaseIdentifier
- the name of the route case or the keyword
EXCEPTIONAL
to identify an exception route case.DfException
boolean isPrivate() throws DfException
true
if the activity is private; false
if the activity if publicDfException
- if the server returns an errorvoid setPrivate(boolean isPrivate) throws DfException
isPrivate
- set this to true
to define the
activity as private or false
to define the activity
as public.DfException
- if the server returns an errorjava.lang.String getDefinitionState() throws DfException
DfException
- if the server returns an errorint getTriggerThreshold() throws DfException
DfException
- if the server returns an errorvoid setTriggerThreshold(int triggerThreshold) throws DfException
triggerThreshold
- an integer number from 0 to the total number of
input ports in the activity. 0 is only valid for begin-type activities.DfException
- if the server returns an errorjava.lang.String getTriggerEvent() throws DfException
setTriggerEvent(java.lang.String)
). If an
activity has both a trigger event and a trigger threshold defined, both
most be met to start the activity. For more information about triggering
thresholds and events, refer to Server Fundamentals.DfException
- if the server returns an errorvoid setTriggerEvent(java.lang.String triggerEvent) throws DfException
triggerEvent
- an event name, in the format dm_eventname; for
example, dm_signoff or dm_lock.DfException
- if the server returns an errorint getPreTimer() throws DfException
DfException
- if a server error occursvoid setPreTimer(int preTimer) throws DfException
preTimer
- an integer value representing the maximum number
of expected hours between the start of the workflow and the start
of the activity. Setting this to 0 means that the timer is not in use.DfException
- if a server error occursint getPostTimer() throws DfException
DfException
- if the server returns an errorvoid setPostTimer(int postTimer) throws DfException
postTimer
- an integer reprenting the expected maximum number of hours
to complete the activity. Setting this to 0 means that
the timer is not in use.DfException
- if the server returns an errorboolean isRepeatableInvoke() throws DfException
true
if the activity can be invoked multiple times;
false
if the activity can be invoked only onceDfException
- if the server returns an errorvoid setRepeatableInvoke(boolean repeatableInvoke) throws DfException
repeatableInvoke
- set this to true
if the activity
can be invoked multiple times, or to false
if the activity
can be invoked only once.DfException
- if the server returns an errorint getExecType() throws DfException
DfException
- if the server returns an errorvoid setExecType(int execType) throws DfException
execType
- 0, to define the activity execution as manual; 1, to
define the execution as automatic.DfException
- if the server returns an errorIDfId getExecMethodId() throws DfException
getExecType()
.
For more information about manual and automatic execution,
refer to Server Fundamentals.DfException
- if the server returns an errorvoid setExecMethodId(IDfId execMethodId) throws DfException
execMethodId
- an IDfId interface to the method's object IDDfException
- if the server returns an errorboolean isExecSaveResults() throws DfException
IDfWorkitem.getExecResultId()
.true
if the results are saved to a document;
false
if the results are not savedDfException
- if the server returns an errorvoid setExecSaveResults(boolean execSaveResults) throws DfException
execSaveResults
- set this to true
if you want
to save the results of an automatic activity or to false
if you don't want to save the results.DfException
- if the server returns an errorIDfWorkitem.getExecResultId()
int getExecTimeOut() throws DfException
DfException
- if the server returns an errorvoid setExecTimeOut(int execTimeOut) throws DfException
execTimeOut
- the number of seconds in the time-out periodDfException
- if the server returns an errorint getExecErrHandling() throws DfException
DfException
- if the server returns an errorvoid setExecErrHandling(int execErrHandling) throws DfException
execErrHandling
- set this to 0 to stop the
execution if failure occurs or to 1 to proceed even
if failure occursDfException
- if the server returns an errorint getExecRetryMax() throws DfException
DfException
- if the server returns an errorvoid setExecRetryMax(int execRetryMax) throws DfException
execRetryMax
- set this to 0 if want no retry if execution fails.DfException
- if the server returns an errorint getExecRetryInterval() throws DfException
DfException
- if the server returns an errorvoid setExecRetryInterval(int execRetryInterval) throws DfException
execRetryInterval
- set this to 0 if want to retry immediately if execution fails.DfException
- if the server returns an errorint getExecSubtype() throws DfException
DfException
- if the server returns an errorvoid setExecSubtype(int subType) throws DfException
subType
- 0, to define the activity as outbound activity;
1, to define the activity as inbound activity.DfException
- if the server returns an errorint getPerformerType() throws DfException
Value Meaning 0 Workflow supervisor 1 Repository owner 2 Last performer of previous activity 3 A user 4 All members in a group 5 Any user in a group 6 Member of a group who has the least workload 7 One member of a group, selected in round-robin approach
DfException
- if the server returns an errorvoid setPerformerType(int performerType) throws DfException
performerType
- set this to the integer value that corresponds
to who can perform the activity. For manual activities, valid values and
their correspondences are:
Value Meaning 0 Workflow supervisor 1 Repository owner 2 Last performer of previous activity 3 A user 4 All members in a group 5 Any user in a group 6 Member of a group who has the least workload 7 One member of a group, selected in round-robin approachFor choices 4-7, the group name must be specified in performer_name.
Value Meaning 0 Workflow supervisor 1 Repository owner 2 Last performer of previous activity 3 A userYou must have Superuser privileges to assign values 1-3 for automatic activities.
DfException
- if the server returns an errorsetPerformerName(java.lang.String)
java.lang.String getPerformerName() throws DfException
DfException
- if the server returns an errorvoid setPerformerName(java.lang.String performerName) throws DfException
setPerformerType(int)
.
For information about the relationship of the performer type and
performer name, refer to Server Fundamentals.performerName
- the name of the user or group that you want
to perform the activity.DfException
- if the server returns an errorint getPerformerFlag() throws DfException
Value Meaning 0 No delegation and no extension 1 Delegation allowed 2 Extension allowed 3 Delegation and extension allowed
DfException
- if the server returns an errorvoid setPerformerFlag(int performerFlag) throws DfException
performerFlag
- set this to the integer value that corresponds
to the abilities you want to give the performer. Valid values
and their correspondences are:
Value Meaning 0 No delegation and no extension 1 Delegation allowed 2 Extension allowed 3 Delegation and extension allowed
DfException
- if the server returns an errorint getTransitionType() throws DfException
Value Meaning 0 Prescribed 1 Manual 2 Automatic
DfException
- if the server returns an errorvoid setTransitionType(int transitionType) throws DfException
prescribed
,
meaning that the package is sent to all output ports.
For more information, refer to Server Fundamentals.transitionType
- set this to the integer value that corresponds
to the kind of transition you want for the activity. Valid values
and their meanings are:
Value Meaning 0 Prescribed - package is forwarded to all output ports 1 Manual - activity performers choose the output ports 2 Automatic - route case conditional logic defines output ports
DfException
- if the server returns an errorIDfId getConditionId() throws DfException
DfException
- if the server returns an errorboolean getSignoffRequired() throws DfException
true
if the activity requires a sign off;
false
if it does notDfException
- if the server returns an errorvoid setSignoffRequired(boolean signoffRequired) throws DfException
signoffRequired
- set this to true
to require the
activity performer to sign off, or false
if no sign
off is required.DfException
- if the server returns an errorint getPortCount() throws DfException
DfException
- if the server returns an errorjava.lang.String getPortName(int index) throws DfException
getPortCount()
to retrieve the value of n.index
- the index position of the port name that you want
to retrieveDfException
- if the server returns an errorjava.lang.String getPortType(int index) throws DfException
getPortCount()
to retrieve the value of n.index
- the index position of the port whose type you want
to retrieveDfException
- if the server returns an errorint getPackageCount() throws DfException
DfException
- if the server returns an errorjava.lang.String getPackageName(int index) throws DfException
getPackageCount()
to retrieve the value of n.index
- the index position of the package whose name you
want to retrieveDfException
- if the server returns an errorjava.lang.String getPackageType(int index) throws DfException
getPackageCount()
to retrieve the value of n.index
- the index position of the package whose type you want to
retrieveDfException
- if the server returns an errorjava.lang.String getPackageOperation(int index) throws DfException
getPackageCount()
to retrieve the value of n.index
- the index position of the package whose operation information
you want to obtain.DfException
- if the server returns an errorIDfId getPackageId(int index) throws DfException
getPackageCount()
to retrieve the value of n.index
- the index position of the package whose ID you want to
obtainDfException
- if the server returns an errorjava.lang.String getPackageLabel(int index) throws DfException
getPackageCount()
to retrieve the value of n.index
- the index position of the package in the
repeating attributes that store package definitions.DfException
- if the server returns an errorint getConditionCount() throws DfException
DfException
- if the server returns an errorjava.lang.String getConditionName(int index) throws DfException
getConditionCount()
to retrieve the value of n.index
- the index position of the route case whose name you want to retrieveDfException
- if the server returns an errorjava.lang.String getConditionPort(int index) throws DfException
addRouteCase(java.lang.String, java.lang.String, com.documentum.fc.common.IDfList)
.
The output ports are stored in a repeating attribute. The ports in a
particular index position in the attribute are the ports associated
with the route case defined at the same index postion in r_condition_name.
Index positions begin at
0 and increment by 1 for each value in the attribute, up to n-1
where n is the total number of values in the attribute.
You can use getConditionCount()
to retrieve the value of n.index
- the index position of the route case whose output ports
you want to retrieve.DfException
- if the server returns an errorint getPerformerConditionCount() throws DfException
DfException
- if the server returns an errorjava.lang.String getPerformerConditionName(int index) throws DfException
getPerformerConditionCount()
to retrieve the value of n.index
- the index position of the performer condition whose name you want to retrieveDfException
- if the server returns an errorIDfId getPerformerConditionId() throws DfException
DfException
- if the server returns an errorjava.lang.String getPerformerConditionUser(int index) throws DfException
addRouteCase(java.lang.String, java.lang.String, com.documentum.fc.common.IDfList)
.
The output ports are stored in a repeating attribute. The ports in
particular index position in the attribute are the ports associated
with the route case defined at the same index postion in r_condition_name.
Index positions begin at
0 and increment by 1 for each value in the attribute, up to n-1
where n is the total number of values in the attribute.
You can use getConditionCount()
to retrieve the value of n.index
- the index position of the route case whose output ports
you want to retrieve.DfException
- if the server returns an errorint getResolveType() throws DfException
DfException
- if the server returns an errorvoid setResolveType(int resolveType) throws DfException
resolveType
- the resolve type for the performer aliasing of the activityDfException
- if the server returns an errorjava.lang.String getResolvePackageName() throws DfException
DfException
- if the server returns an errorvoid setResolvePackageName(java.lang.String resolvePkgName) throws DfException
resolvePkgName
- the package name used to resolve performer aliasing when
package is the resolve type for the activity.DfException
- if the server returns an errorint getPerformerNameCount() throws DfException
DfException
- if server error occursgetRepeatingPerformerName(int)
,
setRepeatingPerformerName(int, java.lang.String)
java.lang.String getRepeatingPerformerName(int index) throws DfException
index
- Index at which performer_name returnsDfException
- if server error occursgetPerformerNameCount()
,
setRepeatingPerformerName(int, java.lang.String)
void setRepeatingPerformerName(int index, java.lang.String name) throws DfException
index
- Index at which performer_name is setname
- Name set to performer_nameDfException
- if server error occursgetPerformerNameCount()
,
getRepeatingPerformerName(int)
int getControlFlag() throws DfException
DfException
- if server error occurssetControlFlag(int)
void setControlFlag(int flag) throws DfException
flag
- new control flag valueDfException
- if server error occursgetControlFlag()
int getTransitionMaxOutputCount() throws DfException
DfException
void setTransitionMaxOutputCount(int count) throws DfException
count
- DfException
int getTransitionEvalCount() throws DfException
DfException
void setTransitionEvalCount(int count) throws DfException
count
- DfException
int getTransitionFlag() throws DfException
DfException
void setTransitionFlag(int flag) throws DfException
flag
- DfException
java.lang.String getTaskSubject() throws DfException
DfException
void setTaskSubject(java.lang.String name) throws DfException
name
- DfException
void addPackageInfoEx(java.lang.String portName, java.lang.String packageName, java.lang.String packageType, IDfId packageId, java.lang.String packageLabel, java.lang.String packageOperation, int packageFlag) throws DfException
portName
is linked. For example, if portName
represents an output
port, the definition must be compatible with the input port to which
portName
is linked. Refer to Content Server Fundamentals
for details about package compatability.
The port identified in portName
must exist in the activity.
Setting the packageFlag
argument to make the package invisible to
this activity has the following behavioral consequences for the package:
removePackage
and appendNote
cannot be called against
an invisible package.addPackageInfoEx(java.lang.String, java.lang.String, java.lang.String, com.documentum.fc.common.IDfId, java.lang.String, java.lang.String, int)
.
For more information about packages and activities,
refer to Server Fundamentals.
For more information about packages and activities,
refer to Server Fundamentals.portName
- name of the port to which you are adding the packagepackageName
- name of the package. This must be unique among the
packages defined in the activity.packageType
- the object type of the packagepackageId
- an IDfID object that contains the package's object ID.
If you don't provide a
version label in the packageLabel
parameter, the object
identified by the object ID is bound to the port. If you include the
packageLabel
parameter, the method searches the version
tree to which the object belongs and binds the version
with the specified label to the port.packageLabel
- the version label of the package. This is an optional
argument. If you include this argument, the method binds the specified
version of the package to the port. If you don't include this argument,
the version identified by packageId
is bound to the port.packageOperation
- identifies the application that will be used to
perform the actions associated with the activity. This argument
is intended primarily for automatic activities.packageFlag
- identitifes whether this package is visible to this
activity and whether this package is allowed to be empty.
This is an optional flag. The default is 1, meaning the package
is visible but cannot be empty. Valid values are:
0: Not visible, cannot be empty
1: Visible, cannot be empty
2: Not visible, can be empty
3: Visible, can be emptyDfException
- if the server returns an errorvoid addPackageInfoEx(java.lang.String portName, java.lang.String packageName, java.lang.String packageType, IDfId packageId, java.lang.String packageLabel, java.lang.String packageOperation, int packageFlag, int packageReportFlag) throws DfException
portName
- name of the port to which you are adding the packagepackageName
- name of the package. This must be unique among the
packages defined in the activity.packageType
- the object type of the packagepackageId
- an IDfID object that contains the package's object ID.
If you don't provide a
version label in the packageLabel
parameter, the object
identified by the object ID is bound to the port. If you include the
packageLabel
parameter, the method searches the version
tree to which the object belongs and binds the version
with the specified label to the port.packageLabel
- the version label of the package. This is an optional
argument. If you include this argument, the method binds the specified
version of the package to the port. If you don't include this argument,
the version identified by packageId
is bound to the port.packageOperation
- identifies the application that will be used to
perform the actions associated with the activity. This argument
is intended primarily for automatic activities.packageFlag
- identitifes whether this package is visible to this
activity and whether this package is allowed to be empty.
This is an optional flag. The default is 1, meaning the package
is visible but cannot be empty. Valid values are:packageReportFlag
- indicates whether this package will be reported on this
activity at workflow runtime.
This is an optional flag. The default is false, meaning the package
will not be reported on this activity at runtime. Valid values are:
0: Not report
1: ReportDfException
- if the server returns an errorint getPackageFlag(int index) throws DfException
getPackageCount()
to retrieve the value of n.
The value representations are:
0: Not visible, can not be emptyindex
- the index position of the package whose flag you want to
retrieveDfException
- if the server returns an errorint getPackageReportFlag(int index) throws DfException
getPackageCount()
to retrieve the value of n.
The value representations are:
0: Not reportindex
- the index position of the package whose flag you want to
retrieveDfException
- if the server returns an errorvoid addConditionRouteCase(java.lang.String routeCaseIdentifier, IDfList conditions, IDfList outputPorts) throws DfException
IDfTransitionConditions to be ANDed.
Alternatively, the condition comprises a list of lists of IDfTransitionConditions.
In this case, the outermost list is considered to be one or more conditions to be ORed, each of which
comprises a list of one or more conditions to be ANDed. This effectively provides natural logical
precedence, but with no provision for bracketing.
routeCaseIdentifier
- the name of the route case or the keyword
exceptional
to identify an exception route case.conditions
- a list of IDfTransitionCondition instances that should be ANDed for the route case.
Specify this as null
if the routeCaseIdentifier
is exceptional
.outputPorts
- an IDfList interface that contains the names of
the selected output ports. These are the ports that will be selected if the
conditions
evaluate to true
.DfException
- if the server returns an errorIDfList getConditions(java.lang.String routeCaseIdentifier) throws DfException
routeCaseIdentifier
- the name of the route caseIDfTransitionConditions or a list of IDfLists
DfException
- if a server error occursIDfAttributeValueCondition newAttributeValueCondition() throws DfException
DfException
- if the server returns an errorIDfXPathCondition newXPathCondition() throws DfException
DfException
- if the server returns an errorboolean hasCompatibilityRouteCases() throws DfException
true
if the activity supports compatibility route cases, otherwise false
DfException
IDfId getPreTimerAction(int index) throws DfException
index
- the index of the timer within the timer seriesDfException
- if a server error occursint getPreTimerIncrement(int index) throws DfException
index
- the index of the timer within the timer seriesDfException
- if a server error occursboolean isPreTimerRepeatLastAction() throws DfException
true
if the final timer within the series should repeat, otherwise false
DfException
- if a server error occursvoid setPreTimerRepeatLastAction(boolean repeatLast) throws DfException
repeatLast
- true
if the final timer within the series should repeat, otherwise false
DfException
- if a server error occursvoid addPreTimerAction(IDfId action, int minutes) throws DfException
action
- the ID of the timer actionminutes
- the interval in minutes that must pass before the timer is firedDfException
- if a server error occursvoid removePreTimers() throws DfException
DfException
- if a server error occursint getPreTimerCount() throws DfException
DfException
IDfId getPostTimerAction(int index) throws DfException
index
- the index of the timer within the timer seriesDfException
- if a server error occursint getPostTimerIncrement(int index) throws DfException
index
- the index of the timer within the timer seriesDfException
- if a server error occursboolean isPostTimerRepeatLastAction() throws DfException
true
if the final timer within the series should repeat, otherwise false
DfException
- if a server error occursvoid setPostTimerRepeatLastAction(boolean repeatLast) throws DfException
repeatLast
- true
if the final timer within the series should repeat, otherwise false
DfException
- if a server error occursvoid addPostTimerAction(IDfId action, int minutes) throws DfException
action
- the ID of the timer actionminutes
- the interval in minutes that must pass before the timer is firedDfException
- if a server error occursvoid removePostTimers() throws DfException
DfException
- if a server error occursint getPostTimerCount() throws DfException
DfException
void addPerformerCondition(java.lang.String conditionName, java.lang.String condition, IDfList performers) throws DfException
conditionName
- the name of the route case or the keyword
exception
to identify an exception route case.condition
- the boolean condition for the route case. Specify this as
null
if the routeCaseIdentifier
is exception
.performers
- an IDfList interface that contains the names of
the selected output ports. These are the ports that will be selected if the
condition
evaluates to true
.DfException
- if the server returns an errorvoid removePerformerCondition(java.lang.String conditionName) throws DfException
conditionName
- the name of the route caseDfException
- if the server returns an errorIDfList getPerformerConditionNames() throws DfException
DfException
java.lang.String getPerformerCondition(java.lang.String condtionName) throws DfException
condtionName
- DfException
IDfList getPerformers(java.lang.String conditionName) throws DfException
conditionName
- DfException
IDfCollection getPackagesMetaData() throws DfException
r_package_name String r_package_type Int r_package_label String r_package_flag IntThe collection is the metadata for the packages defined on an OUTPUT port; If there is no output port, it returns meta data of packages defined on an INPUT port. Note 1: The function returns an empty collection if there are no packages defined.
IDfCollection col = activity.getPackagesMetaData(); try { while (col.next()) { String packageName = col.getString("r_package_name"); String packageType = col.getString("r_package_name"); String packageLabel = col.getString("r_package_label"); String packageFlag = col.getInt("r_package_flag"); ... ... } finally { if (col != null) col.close() }
DfException
- if the query failed or the session has timed out and cannot be reestablished.int getPerfCondIndex(java.lang.String condName) throws DfException
condName
- DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.