|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowStep
The WorkflowStep interface represents a Step in a Workflow. The interface provides methods to manipulate the design of that step.
Nested Class Summary | |
---|---|
static class |
WorkflowStep.Type
|
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
addPerformer(Performer performer)
Override/set the performer for this step |
void |
addPerformers(java.util.Collection<Performer> performers)
Override/set the list of performers for this step |
ExitValue |
createExitValue(ExitValue exitValue)
Add a new exit value, using the ExitValue object passed in, for this Workflow Step. |
ExitValue |
createExitValue(java.lang.String exitValue)
Add a new exit value, using the string passed in, for this Workflow Step. |
java.util.Collection<AttributeCollection> |
getAttributeCollections()
Get all attribute collections for this step. |
java.util.Collection<AttributeCollection> |
getAttributeCollections(Hierarchy locationHierarchy)
Get all attribute collections on the specified location hierarchy for this step. |
java.util.Collection<AttributeCollection> |
getAttributeCollections(ScreenType screenType)
Get all attribute collections for a given screen type on this step. |
boolean |
getCanModifyLocationHierarchyAvailability(Hierarchy locationHierarchy)
Get the "can modify availability" flag for a particular location hierarchy on this workflow. |
java.lang.String |
getDefaultStepScriptPath()
Get the default script path for this Workflow Step's Step Scripts |
java.lang.String |
getDescription()
Get the step name description. |
java.util.Collection<AttributeCollection> |
getEditableAttributeCollections()
Get the editable (but not required) attribute collections for this step. |
java.util.Collection<AttributeCollection> |
getEditableAttributeCollections(Hierarchy locationHierarchy)
Get the editable (but not required) attribute collections on the specified location hierarchy for this step. |
java.util.Collection<AttributeCollection> |
getEditableAttributeCollections(ScreenType screenType)
Get the editable (but not required) attribute collections for a given screen type on this step. |
java.util.Collection<java.lang.String> |
getEntranceNotificationAddresses()
Fetch a list of email addresses which will be notified when items/categories enter this Workflow Step. |
ExitValue |
getExitValue(java.lang.String exitValue)
Fetch an ExitValue object from this Workflow Step, identified by the String passed in. |
java.util.Collection<ExitValue> |
getExitValues()
Get all the possible exit values for items/categories leaving this Workflow Step. |
java.util.Collection<Hierarchy> |
getLocationHierarchiesWithCanModifyAvailabilitySettings()
Get the location hierarchies which have "can modify availability" settings for this workflow (This will affect whether user can modify availability of locations within those hierarchies, for items within the collaboration area based on this workflow) |
java.lang.String |
getName()
Get the step name. |
java.util.Collection<WorkflowStep> |
getNextSteps()
Fetch a collection of all next Workflow Steps for this Workflow Step, irrespective of exit value. |
java.util.Collection<WorkflowStep> |
getNextSteps(ExitValue exitValue)
Fetch the next Workflow Steps, for the specified ExitValue on this step |
java.util.Collection<WorkflowStep> |
getNextSteps(java.lang.String exitValue)
Fetch the next WorkflowSteps for the specified Exit Value on this step |
java.util.Collection<Performer> |
getPerformers()
Get the collection of all performers for this Workflow Step. |
java.util.Collection<AttributeCollection> |
getRequiredAttributeCollections()
Get the required & editable attribute collections for this step. |
java.util.Collection<AttributeCollection> |
getRequiredAttributeCollections(Hierarchy locationHierarchy)
Get the required & editable attribute collections on the specified location hierarchy for this step. |
java.util.Collection<AttributeCollection> |
getRequiredAttributeCollections(ScreenType screenType)
Get the required & editable attribute collections for a given screen type on this step. |
Document |
getStepScript()
Get the currently set step script path for this Workflow Step. |
java.util.Date |
getTimeoutDate()
Get the timeout for this step. |
int |
getTimeoutDuration()
Get the timeout duration. |
java.util.Collection<java.lang.String> |
getTimeoutNotificationAddresses()
Fetch a list of email addresses that will be notified as a result of timeout from this step |
WorkflowStep.Type |
getType()
Get the type of this Workflow Step |
java.util.Collection<AttributeCollection> |
getViewableAttributeCollections()
Get the viewable attribute collections for this step. |
java.util.Collection<AttributeCollection> |
getViewableAttributeCollections(Hierarchy locationHierarchy)
Get the viewable attribute collections on the specified location hierarchy for this step. |
java.util.Collection<AttributeCollection> |
getViewableAttributeCollections(ScreenType screenType)
Get the viewable attribute collections for a given screen type on this step. |
boolean |
hasExitValue(ExitValue exitValue)
Check if this Workflow Step has an exit value identified by the ExitValue object passed in. |
boolean |
hasExitValue(java.lang.String exitValue)
Check if this Workflow Step has an exit value identified by the String passed in. |
boolean |
isAutomatedStep()
Identifies if this Workflow Step is an automated Step (i.e. |
boolean |
isFailureStep()
Identifies if this Workflow Step is the Workflow's Failure Step. |
boolean |
isFixitStep()
Check if the WorkflowStep is a reference to Fixit |
boolean |
isImportAllowed()
Check if Allow Import into Step is enabled for this step |
boolean |
isInitialStep()
Check if this Workflow Step is the Workflow's Initial Step. |
boolean |
isNestedWorkflowStep()
Identifies if this Workflow Step is a Nested Workflow Step. |
boolean |
isRecategorizeEnabled()
Check if Allow Recategorization is enabled for this step |
boolean |
isReserveToEditEnabled()
Check if reserve to edit is enabled for this step |
boolean |
isSuccessStep()
Identifies if this Workflow Step is the Workflow's Success Step. |
void |
removeExitValue(ExitValue exitValue)
Remove an exit value, identified by the ExitValue object passed in, from this Workflow Step. |
void |
removeExitValue(java.lang.String exitValue)
Remove an exit value, with name identified by the String passed in, from this Workflow Step. |
void |
setAllowImportIntoStep(boolean allowImportIntoStep)
Set the allowImportIntoStep flag for this Workflow Step. |
void |
setCanModifyLocationHierarchyAvailability(Hierarchy locationHierarchy,
boolean modifiable)
Set the "can modify availability" flag for a particular location hierarchy in this workflow, This will affect whether user can modify availability of locations within that hierarchies, for items within the collaboration area based on this workflow This will also cause the location hierarchy to be returned from the getLocationHierarchiesWithCanModifyAvailabilitySettings() method. |
void |
setDescription(java.lang.String description)
Set the description of this Workflow Step. |
void |
setEditableAttributeCollections(java.util.Collection<AttributeCollection> editableAttributeCollections,
Hierarchy locationHierarchy)
Set/override the editable (but not required) attribute collections on the specified location hierarchy for this step. |
void |
setEditableAttributeCollections(java.util.Collection<AttributeCollection> editableAttributeCollections,
ScreenType screenType)
Set/override the editable (but not required) attribute collections for a given screen type on this step. |
void |
setEntranceNotificationAddresses(java.util.Collection<java.lang.String> entranceNotificationAddresses)
Set the email addresses that will be notified when items/categories enter this Workflow Step. |
void |
setNextStep(ExitValue exitValue,
WorkflowStep nextStep)
Override/set the next step for a particular exit value on this step |
void |
setNextStep(java.lang.String exitValue,
WorkflowStep nextStep)
Override/set the next step for a particular exit value |
void |
setNextSteps(ExitValue exitValue,
java.util.Collection<WorkflowStep> nextSteps)
Override/set the next steps for a particular exit value on this step |
void |
setNextSteps(java.lang.String exitValue,
java.util.Collection<WorkflowStep> nextSteps)
Override/set the next steps for a particular exit value |
void |
setRecategorize(boolean recategorize)
Set the recategorize flag for this Workflow Step. |
void |
setRequiredAttributeCollections(java.util.Collection<AttributeCollection> requiredAttributeCollections,
Hierarchy locationHierarchy)
Set/override the required & editable attribute collections on the specified location hierarchy for this step. |
void |
setRequiredAttributeCollections(java.util.Collection<AttributeCollection> requiredAttributeCollections,
ScreenType screenType)
Set/override the required & editable attribute collections for a given screen type on this step. |
void |
setReserveToEdit(boolean reserveToEdit)
Set the reserveToEdit flag for this Workflow Step. |
void |
setStepScript(Document docstorePath)
Set script path for this Workflow Step, overriding the current setting. |
void |
setTimeoutDate(java.util.Date timeoutDate)
Set the timeout for this step |
void |
setTimeoutDuration(int timeoutDuration)
Sets the timeout duration. |
void |
setTimeoutNotificationAddresses(java.util.Collection<java.lang.String> timeoutNotificationAddresses)
Set the email addresses that will be notified as a result of timeout from this step |
void |
setViewableAttributeCollections(java.util.Collection<AttributeCollection> viewableAttributeCollections,
Hierarchy locationHierarchy)
Set/override the viewable attribute collections on the specified location hierarchy for this step. |
void |
setViewableAttributeCollections(java.util.Collection<AttributeCollection> viewableAttributeCollections,
ScreenType screenType)
Set/override the viewable attribute collections for a given screen type on this step. |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String getName()
PIMInternalException
- If an internal error occursjava.lang.String getDescription()
PIMInternalException
- If an internal error occursvoid setDescription(java.lang.String description)
description
- the new step description
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null or empty string is passed
PIMAuthorizationException
- Reserved for future useboolean isFixitStep()
PIMInternalException
- If an internal error occurred.boolean isInitialStep()
PIMInternalException
- If an internal error occursWorkflowStep.Type getType()
PIMInternalException
- If an internal error occurs
java.lang.UnsupportedOperationException
- If WorkflowStep contains an invalid type. This should never
occur since all performers are roles or users.boolean isSuccessStep()
PIMInternalException
- If an internal error occursboolean isFailureStep()
PIMInternalException
- If an internal error occursboolean isAutomatedStep()
PIMInternalException
- If an internal error occursboolean isNestedWorkflowStep()
PIMInternalException
- If an internal error occursjava.util.Collection<ExitValue> getExitValues()
PIMInternalException
- If an internal error occursExitValue createExitValue(java.lang.String exitValue)
Note - After adding the exit value, one or more next steps must be associated with it, in order for the workflow to be able to be saved.
Use the WorkflowStep.setNextStep(String exVal, WorkflowStep wflStep)
method to associate the exit value with a Workflow Step or
WorkflowStep.setNextStep(String exVal, Collection
exitValue
- the string to identify the exit value
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty String is passed
PIMAuthorizationException
- Reserved for future use
ExitValue createExitValue(ExitValue exitValue)
Note - After adding the exit value, one or more next steps must be associated with it, in order for the workflow to be able to be saved.
Use the WorkflowStep.setNextStep(ExitValue exVal, WorkflowStep wflStep)
method to associate the exit value with a Workflow Step or
WorkflowStep.setNextStep(ExitValue exVal, Collection
exitValue
- an exit value from another workflow step whose name you wish
to use for the new exit value on this step
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null ExitValue is passed
PIMAuthorizationException
- Reserved for future use
void removeExitValue(ExitValue exitValue)
exitValue
- the exit value to be removed from this step. If the exit value
object belongs to a different WorkflowStep, its name will be
used to locate the corresponding exit value on this step.
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null ExitValue is passed
PIMAuthorizationException
- Reserved for future usevoid removeExitValue(java.lang.String exitValue)
exitValue
- the name of the exit value to be removed from this step.
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty String is passed
PIMAuthorizationException
- Reserved for future useboolean hasExitValue(java.lang.String exitValue)
exitValue
- the name of the exit value
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty String is passedboolean hasExitValue(ExitValue exitValue)
exitValue
- an exit value from another workflow step whose value will be
used to check for an equivalently named exit value on this
step
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null ExitValue is passedExitValue getExitValue(java.lang.String exitValue)
exitValue
- the name of the exit value
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty String is passedjava.util.Collection<WorkflowStep> getNextSteps()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usejava.util.Collection<WorkflowStep> getNextSteps(ExitValue exitValue)
exitValue
- an exit Value of this WorkflowStep that you wish to retrieve
the steps for. If this exitValue is derived from another step,
the equivalently named exitValue for this step is looked up.
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null ExitValue is passed
PIMAuthorizationException
- Reserved for future usejava.util.Collection<WorkflowStep> getNextSteps(java.lang.String exitValue)
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null or empty String is passed
PIMAuthorizationException
- Reserved for future useboolean isReserveToEditEnabled()
PIMInternalException
- If an internal error occursboolean isImportAllowed()
PIMInternalException
- If an internal error occursboolean isRecategorizeEnabled()
PIMInternalException
- If an internal error occursvoid setNextStep(ExitValue exitValue, WorkflowStep nextStep)
exitValue
- an exit Value of this WorkflowStep that you wish to retrieve
the steps for. If this exitValue is derived from another step,
the equivalently named exitValue for this step is lookednextStep
- the WorkflowStep for the step that will be the next step on
this exit value
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null ExitValue/WorkflowStep is passed
PIMAuthorizationException
- Reserved for future usevoid setNextSteps(ExitValue exitValue, java.util.Collection<WorkflowStep> nextSteps)
exitValue
- an exit Value of this WorkflowStep that you wish to retrieve
the steps for. If this exitValue is derived from another step,
the equivalently named exitValue for this step is looked up.nextSteps
- a Collection of next steps for this exit value
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null ExitValue/Collection is passed
PIMAuthorizationException
- Reserved for future usevoid setNextStep(java.lang.String exitValue, WorkflowStep nextStep)
exitValue
- the exitValue to set the next step fornextStep
- the WorkflowStep for the step that will be the next step on
this exit value
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null or empty String/WorkflowStep is passed
PIMAuthorizationException
- Reserved for future usevoid setNextSteps(java.lang.String exitValue, java.util.Collection<WorkflowStep> nextSteps)
exitValue
- the exitValue to set the next step fornextSteps
- a Collection of next steps for this exit value
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null or empty String/Collection is passed
PIMAuthorizationException
- Reserved for future usevoid addPerformer(Performer performer)
performer
- the user/role to set as performer for this step
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Performer is passed
PIMAuthorizationException
- Reserved for future usevoid addPerformers(java.util.Collection<Performer> performers)
performers
- a Collection of users/roles that are performers for this step
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passed
PIMAuthorizationException
- Reserved for future use
java.lang.UnsupportedOperationException
- If Performer is neither a user or role. This should never
occur since all performers are roles or usersjava.util.Collection<Performer> getPerformers()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid setReserveToEdit(boolean reserveToEdit)
reserveToEdit
- true to set reserve To Edit, false to clear it
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null boolean is passed
PIMAuthorizationException
- Reserved for future usevoid setAllowImportIntoStep(boolean allowImportIntoStep)
allowImportIntoStep
- true to set allow import into step, false to clear it
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null boolean is passed
PIMAuthorizationException
- Reserved for future usevoid setRecategorize(boolean recategorize)
recategorize
- true to set recategorize, false to clear it
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null boolean is passed
PIMAuthorizationException
- Reserved for future usejava.util.Collection<AttributeCollection> getEditableAttributeCollections()
In other words, (i), (ii) and (iii) will be the union of this collection and the getRequiredAttributeCollections collection.
PIMInternalException
- If an internal error occursjava.util.Collection<AttributeCollection> getEditableAttributeCollections(ScreenType screenType)
In other words, (i), (ii) and (iii) will be the union of this collection and the getRequiredAttributeCollections collection.
screenType
- This parameter specifies the type of Screen on the current workflow step
for which the current attribute collections are being referred to.
PIMInternalException
- If an internal error occursScreenType
java.util.Collection<AttributeCollection> getEditableAttributeCollections(Hierarchy locationHierarchy)
In other words, (i), (ii) and (iii) will be the union of this collection and the getRequiredAttributeCollections collection.
locationHierarchy
- the location hierarchy on which the attribute collections are determined.
PIMInternalException
- If an internal error occursjava.util.Collection<AttributeCollection> getRequiredAttributeCollections()
The attributes for these attribute collections will be used in conjunction with the editable attribute collections: (i) to determine which attributes are checked out for the workflow (ii) to determine which attributes can be edited on workflow edit screens (iii) to determine which attributes must be valid before items/categories can leave this step (iv) to determine which attributes must have a value before items/categories can leave this step
In other words, (i), (ii) and (iii) will be the union of this collection and the getEditableAttributeCollections collection, (iv) will be these required attribute collections only.
PIMInternalException
- If an internal error occursjava.util.Collection<AttributeCollection> getRequiredAttributeCollections(ScreenType screenType)
The attributes for these attribute collections will be used in conjunction with the editable attribute collections: (i) to determine which attributes are checked out for the workflow (ii) to determine which attributes can be edited on workflow edit screens (iii) to determine which attributes must be valid before items/categories can leave this step (iv) to determine which attributes must have a value before items/categories can leave this step
In other words, (i), (ii) and (iii) will be the union of this collection and the getEditableAttributeCollections collection, (iv) will be these required attribute collections only.
screenType
- This parameter specifies the type of Screen on the current workflow step
for which the current attribute collections are being referred to.
PIMInternalException
- If an internal error occursScreenType
java.util.Collection<AttributeCollection> getRequiredAttributeCollections(Hierarchy locationHierarchy)
The attributes for these attribute collections will be used in conjunction with the editable attribute collections: (i) to determine which attributes are checked out for the workflow (ii) to determine which attributes can be edited on workflow edit screens (iii) to determine which attributes must be valid before items/categories can leave this step (iv) to determine which attributes must have a value before items/categories can leave this step
In other words, (i), (ii) and (iii) will be the union of this collection and the getEditableAttributeCollections collection, (iv) will be these required attribute collections only.
locationHierarchy
- the location hierarchy on which the attribute collections are determined.
PIMInternalException
- If an internal error occursjava.util.Collection<AttributeCollection> getViewableAttributeCollections()
The attributes for these attribute collections will be used (i) to determine which attributes are displayed (but not editable) on workflow edit screens The attributes in these attribute collections will not be checked out and will not require validation or require a value to leave the step. However, it will be the value of these attributes at the time of checkout, that will be visible within the workflow edit screens.
PIMInternalException
- If an internal error occursjava.util.Collection<AttributeCollection> getViewableAttributeCollections(ScreenType screenType)
The attributes for these attribute collections will be used (i) to determine which attributes are displayed (but not editable) on workflow edit screens The attributes in these attribute collections will not be checked out and will not require validation or require a value to leave the step. However, it will be the value of these attributes at the time of checkout, that will be visible within the workflow edit screens.
screenType
- This parameter specifies the type of Screen on the current workflow step
for which the current attribute collections are being referred to.
PIMInternalException
- If an internal error occursScreenType
java.util.Collection<AttributeCollection> getViewableAttributeCollections(Hierarchy locationHierarchy)
The attributes for these attribute collections will be used (i) to determine which attributes are displayed (but not editable) on workflow edit screens The attributes in these attribute collections will not be checked out and will not require validation or require a value to leave the step. However, it will be the value of these attributes at the time of checkout, that will be visible within the workflow edit screens.
locationHierarchy
- the location hierarchy on which the attribute collections are determined.
PIMInternalException
- If an internal error occursjava.util.Collection<AttributeCollection> getAttributeCollections()
PIMInternalException
- If an internal error occursjava.util.Collection<AttributeCollection> getAttributeCollections(ScreenType screenType)
screenType
- This parameter specifies the type of Screen on the current workflow step
for which the current attribute collections are being referred to.
PIMInternalException
- If an internal error occursScreenType
java.util.Collection<AttributeCollection> getAttributeCollections(Hierarchy locationHierarchy)
locationHierarchy
- the location hierarchy on which the attribute collections are determined.
PIMInternalException
- If an internal error occursvoid setEditableAttributeCollections(java.util.Collection<AttributeCollection> editableAttributeCollections, ScreenType screenType)
The attributes for these attribute collections will be used in conjunction with the required attribute collections: (i) to determine which attributes are checked out for the workflow (ii) to determine which attributes can be edited on workflow edit screens (iii) to determine which attributes must be valid before items/categories can leave this step
In other words, (i), (ii) and (iii) will be the union of this collection and the getRequiredAttributeCollections collection.
screenType
- This parameter specifies the type of Screen on the current workflow step
for which the current attribute collections are being referred to.editableAttributeCollections
- a Collection of attribute collections editable for this step
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passedScreenType
void setEditableAttributeCollections(java.util.Collection<AttributeCollection> editableAttributeCollections, Hierarchy locationHierarchy)
The attributes for these attribute collections will be used in conjunction with the required attribute collections: (i) to determine which attributes are checked out for the workflow (ii) to determine which attributes can be edited on workflow edit screens (iii) to determine which attributes must be valid before items/categories can leave this step
In other words, (i), (ii) and (iii) will be the union of this collection and the getRequiredAttributeCollections collection.
editableAttributeCollections
- a Collection of attribute collections editable for this steplocationHierarchy
- the location hierarchy on which the attribute collections are set.
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passedvoid setRequiredAttributeCollections(java.util.Collection<AttributeCollection> requiredAttributeCollections, ScreenType screenType)
The attributes for these attribute collections will be used in conjunction with the editable attribute collections: (i) to determine which attributes are checked out for the workflow (ii) to determine which attributes can be edited on workflow edit screens (iii) to determine which attributes must be valid before items/categories can leave this step (iv) to determine which attributes must have a value before items/categories can leave this step
In other words, (i), (ii) and (iii) will be the union of this collection and the getEditableAttributeCollections collection, (iv) will be these required attribute collections only.
screenType
- This parameter specifies the type of Screen on the current workflow step
for which the current attribute collections are being referred to.requiredAttributeCollections
- a Collection of attribute collections required for this step
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null Collection is passedScreenType
void setRequiredAttributeCollections(java.util.Collection<AttributeCollection> requiredAttributeCollections, Hierarchy locationHierarchy)
The attributes for these attribute collections will be used in conjunction with the editable attribute collections: (i) to determine which attributes are checked out for the workflow (ii) to determine which attributes can be edited on workflow edit screens (iii) to determine which attributes must be valid before items/categories can leave this step (iv) to determine which attributes must have a value before items/categories can leave this step
In other words, (i), (ii) and (iii) will be the union of this collection and the getEditableAttributeCollections collection, (iv) will be these required attribute collections only.
requiredAttributeCollections
- a Collection of attribute collections required for this steplocationHierarchy
- the location hierarchy on which the attribute collections are set.
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If null Collection is passedvoid setViewableAttributeCollections(java.util.Collection<AttributeCollection> viewableAttributeCollections, ScreenType screenType)
The attributes for these attribute collections will be used (i) to determine which attributes are displayed (but not editable) on workflow edit screens The attributes in these attribute collections will not be checked out and will not require validation or require a value to leave the step. However, it will be the value of these attributes at the time of checkout, that will be visible within the workflow edit screens.
screenType
- This parameter specifies the type of Screen on the current workflow step
for which the current attribute collections are being referred to.viewableAttributeCollections
- a Collection of attribute collections viewable for this step
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passedScreenType
void setViewableAttributeCollections(java.util.Collection<AttributeCollection> viewableAttributeCollections, Hierarchy locationHierarchy)
The attributes for these attribute collections will be used (i) to determine which attributes are displayed (but not editable) on workflow edit screens The attributes in these attribute collections will not be checked out and will not require validation or require a value to leave the step. However, it will be the value of these attributes at the time of checkout, that will be visible within the workflow edit screens.
viewableAttributeCollections
- a Collection of attribute collections viewable for this steplocationHierarchy
- the location hierarchy on which the attribute collections are set.
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passedjava.util.Collection<java.lang.String> getEntranceNotificationAddresses()
PIMInternalException
- If an internal error occursvoid setEntranceNotificationAddresses(java.util.Collection<java.lang.String> entranceNotificationAddresses)
entranceNotificationAddresses
- a collection of e-mail addresses for entry notification This
will overwrite the existing list of addresses If the parameter
is null or an empty Collection, the address list will be
cleared.
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passed
PIMAuthorizationException
- Reserved for future usejava.util.Collection<java.lang.String> getTimeoutNotificationAddresses()
PIMInternalException
- If an internal error occursvoid setTimeoutNotificationAddresses(java.util.Collection<java.lang.String> timeoutNotificationAddresses)
timeoutNotificationAddresses
- a collection of e-mail addresses for timeout notification This
will overwrite the existing list of addresses If the parameter
is null or an empty list, the address list will be cleared.
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null Collection is passed
PIMAuthorizationException
- Reserved for future usejava.util.Date getTimeoutDate()
PIMInternalException
- If an internal error occurs or if there is no timeout datevoid setTimeoutDate(java.util.Date timeoutDate)
timeoutDate
- the timeout date to be set
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null boolean is passed
java.lang.IllegalArgumentException
- If null Date is passed
PIMAuthorizationException
- Reserved for future useint getTimeoutDuration()
PIMInternalException
- If an internal error occursvoid setTimeoutDuration(int timeoutDuration)
timeoutDuration
- the timeout duration in seconds
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If negative int is passed
PIMAuthorizationException
- Reserved for future usejava.lang.String getDefaultStepScriptPath()
PIMInternalException
- If an internal error occursDocument getStepScript()
PIMInternalException
- If an internal error occursvoid setStepScript(Document docstorePath)
docstorePath
- the script path in the docstore to be used for storing IN,
OUT, TIMEOUT user functions. Use getDefaultStepScriptPath() to
get a default value for use here.
PIMInternalException
- If an internal error occurs,
java.lang.IllegalArgumentException
- If null or empty String is passed
PIMAuthorizationException
- Reserved for future usejava.util.Collection<Hierarchy> getLocationHierarchiesWithCanModifyAvailabilitySettings()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid setCanModifyLocationHierarchyAvailability(Hierarchy locationHierarchy, boolean modifiable)
locationHierarchy
- the location hierarchy to set availability for.modifiable
- true to mark this location hierarchy as “availabilities can be
modified”, false to mark this location hierarchy as
“availabilities cannot be modified”
PIMInternalException
- If an internal error occurs,
PIMAuthorizationException
- Reserved for future useboolean getCanModifyLocationHierarchyAvailability(Hierarchy locationHierarchy)
locationHierarchy
- the location hierarchy to get availability for.
PIMInternalException
- If an internal error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |