Class ApplicationAction
java.lang.Object
com.appiancorp.suiteapi.applications.ApplicationAction
- All Implemented Interfaces:
Serializable
,Cloneable
Represents an action that can be executed in the context of an
Application
. The action
is backed by a Process Model, which executes when the action is triggered.- See Also:
-
Constructor Summary
ConstructorDescriptionNo-args constructor necessary for Import/Export, since when importing the bean is reconstructed piece by piece.ApplicationAction
(String displayLabel, String processModelUuid) Creates a new Application Action with the given user friendly label, and process model UUID.ApplicationAction
(String displayLabel, String processModelUuid, String description) Creates a new Application Action with the given user friendly label, process model UUID, and description of the action.ApplicationAction
(String displayLabel, String processModelUuid, String description, String actionUuid) Creates a new Application Action with the given user friendly label, process model UUID, description, and action UUID of the action. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Retrieves the UUID of theApplicationAction
.Retrieves a description of this action.Retrieves the user friendly name for this action.Retrieves the UUID of theAbstractProcessModel
that executes the action.void
setActionUuid
(String actionUuid) Sets the UUID of theApplicationAction
.void
setDescription
(String description) Sets a description of this action.void
setDisplayLabel
(String displayLabel) Sets the user friendly name for this action.void
setProcessModelUuid
(String processModelUuid) Sets the UUID of theAbstractProcessModel
that executes the action.Constructs an ApplicationActionBean and returns itvoid
validate()
Validates that thisApplicationAction
is correct.
-
Constructor Details
-
ApplicationAction
public ApplicationAction()No-args constructor necessary for Import/Export, since when importing the bean is reconstructed piece by piece. A valid Application Action should have at least a display name and an associated process model UUID. Seevalidate()
. -
ApplicationAction
Creates a new Application Action with the given user friendly label, and process model UUID.- Parameters:
displayLabel
- The user friendly label to use when displaying this action.processModelUuid
- The UUID of the process model that executes as part of this action.
-
ApplicationAction
Creates a new Application Action with the given user friendly label, process model UUID, and description of the action.- Parameters:
displayLabel
- The user friendly label to use when displaying this action.processModelUuid
- The UUID of the process model that executes as part of this action.description
- The description of the action.
-
ApplicationAction
public ApplicationAction(String displayLabel, String processModelUuid, String description, String actionUuid) Creates a new Application Action with the given user friendly label, process model UUID, description, and action UUID of the action.- Parameters:
displayLabel
- The user friendly label to use when displaying this action.processModelUuid
- The UUID of the process model that executes as part of this action.description
- The description of the action.actionUuid
- The UUID of the application action.
-
-
Method Details
-
toApplicationActionBean
Constructs an ApplicationActionBean and returns it- Returns:
- the ApplicationActionBean
-
clone
-
validate
Validates that thisApplicationAction
is correct. A valid Action consists of a Non-empty associated process model UUID and action's display label.- Throws:
InvalidActionException
- If the action is invalid, per the description above.
-
getProcessModelUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getProcessModelUuid()Retrieves the UUID of theAbstractProcessModel
that executes the action.- Returns:
- The process model UUID.
-
setProcessModelUuid
Sets the UUID of theAbstractProcessModel
that executes the action.- Parameters:
processModelUuid
- The process model UUID that executes the action.
-
getActionUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getActionUuid()Retrieves the UUID of theApplicationAction
.- Returns:
- The action UUID.
-
setActionUuid
Sets the UUID of theApplicationAction
.- Parameters:
actionUuid
- The action UUID.
-
getDisplayLabel
Retrieves the user friendly name for this action.- Returns:
- The display name.
-
setDisplayLabel
Sets the user friendly name for this action.- Parameters:
displayLabel
- A user friendly name to use when displaying this action.
-
getDescription
Retrieves a description of this action.- Returns:
- The description of this action.
-
setDescription
Sets a description of this action.- Parameters:
description
- A description of this action.
-