com.appiancorp.suiteapi.applications

Class ApplicationAction

java.lang.Object

com.appiancorp.suiteapi.applications.ApplicationAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ApplicationAction
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationAction() No-args constructor necessary for Import/Export, since when importing the bean is reconstructed piece by piece.
ApplicationAction(java.lang.String displayLabel, java.lang.String processModelUuid) Creates a new Application Action with the given user friendly label, and process model UUID.
ApplicationAction(java.lang.String displayLabel, java.lang.String processModelUuid, java.lang.String description) Creates a new Application Action with the given user friendly label, process model UUID, and description of the action.
ApplicationAction(java.lang.String displayLabel, java.lang.String processModelUuid, java.lang.String description, java.lang.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 Type	Method and Description
ApplicationAction	clone()
java.lang.String	getActionUuid() Retrieves the UUID of the ApplicationAction.
java.lang.String	getDescription() Retrieves a description of this action.
java.lang.String	getDisplayLabel() Retrieves the user friendly name for this action.
java.lang.String	getProcessModelUuid() Retrieves the UUID of the AbstractProcessModel that executes the action.
void	setActionUuid(java.lang.String actionUuid) Sets the UUID of the ApplicationAction.
void	setDescription(java.lang.String description) Sets a description of this action.
void	setDisplayLabel(java.lang.String displayLabel) Sets the user friendly name for this action.
void	setProcessModelUuid(java.lang.String processModelUuid) Sets the UUID of the AbstractProcessModel that executes the action.
ApplicationActionBean	toApplicationActionBean() Constructs an ApplicationActionBean and returns it
void	validate() Validates that this ApplicationAction is correct.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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. See validate().

ApplicationAction

public ApplicationAction(java.lang.String displayLabel,
                         java.lang.String processModelUuid)

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

public ApplicationAction(java.lang.String displayLabel,
                         java.lang.String processModelUuid,
                         java.lang.String description)

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(java.lang.String displayLabel,
                         java.lang.String processModelUuid,
                         java.lang.String description,
                         java.lang.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 Detail

toApplicationActionBean

public ApplicationActionBean toApplicationActionBean()

Constructs an ApplicationActionBean and returns it

Returns:

the ApplicationActionBean

clone

public ApplicationAction clone()

Overrides:

clone in class java.lang.Object

validate

public void validate()
              throws InvalidActionException

Validates that this ApplicationAction 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(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.String getProcessModelUuid()

Retrieves the UUID of the AbstractProcessModel that executes the action.

Returns:

The process model UUID.

setProcessModelUuid

public void setProcessModelUuid(java.lang.String processModelUuid)

Sets the UUID of the AbstractProcessModel that executes the action.

Parameters:

processModelUuid - The process model UUID that executes the action.

getActionUuid

@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.String getActionUuid()

Retrieves the UUID of the ApplicationAction.

Returns:

The action UUID.

setActionUuid

public void setActionUuid(java.lang.String actionUuid)

Sets the UUID of the ApplicationAction.

Parameters:

actionUuid - The action UUID.

getDisplayLabel

public java.lang.String getDisplayLabel()

Retrieves the user friendly name for this action.

Returns:

The display name.

setDisplayLabel

public void setDisplayLabel(java.lang.String displayLabel)

Sets the user friendly name for this action.

Parameters:

displayLabel - A user friendly name to use when displaying this action.

getDescription

public java.lang.String getDescription()

Retrieves a description of this action.

Returns:

The description of this action.

setDescription

public void setDescription(java.lang.String description)

Sets a description of this action.

Parameters:

description - A description of this action.