de.hybris.platform.workflow.model

Class AbstractWorkflowActionModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.workflow.model.AbstractWorkflowActionModel

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

WorkflowActionModel, WorkflowActionTemplateModel

public class AbstractWorkflowActionModel
extends ItemModel

Generated model class for type AbstractWorkflowAction first defined at extension workflow.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_TYPECODE Generated model type code constant.
static java.lang.String	_WORKFLOWACTIONORDERINGRELATION Generated relation code constant for relation WorkflowActionOrderingRelation defining source attribute predecessors in extension workflow.
static java.lang.String	ACTIONTYPE Generated constant - Attribute key of AbstractWorkflowAction.actionType attribute defined at extension workflow.
static java.lang.String	CODE Generated constant - Attribute key of AbstractWorkflowAction.code attribute defined at extension workflow.
static java.lang.String	DESCRIPTION Generated constant - Attribute key of AbstractWorkflowAction.description attribute defined at extension workflow.
static java.lang.String	EMAILADDRESS Generated constant - Attribute key of AbstractWorkflowAction.emailAddress attribute defined at extension workflow.
static java.lang.String	NAME Generated constant - Attribute key of AbstractWorkflowAction.name attribute defined at extension workflow.
static java.lang.String	PREDECESSORS Generated constant - Attribute key of AbstractWorkflowAction.predecessors attribute defined at extension workflow.
static java.lang.String	PREDECESSORSSTR Generated constant - Attribute key of AbstractWorkflowAction.predecessorsStr attribute defined at extension workflow.
static java.lang.String	PRINCIPALASSIGNED Generated constant - Attribute key of AbstractWorkflowAction.principalAssigned attribute defined at extension workflow.
static java.lang.String	QUALIFIER Generated constant - Attribute key of AbstractWorkflowAction.qualifier attribute defined at extension b2bapprovalprocess.
static java.lang.String	RENDERERTEMPLATE Generated constant - Attribute key of AbstractWorkflowAction.rendererTemplate attribute defined at extension workflow.
static java.lang.String	SENDEMAIL Generated constant - Attribute key of AbstractWorkflowAction.sendEmail attribute defined at extension workflow.
static java.lang.String	SUCCESSORS Generated constant - Attribute key of AbstractWorkflowAction.successors attribute defined at extension workflow.
static java.lang.String	WORKFLOWACTIONCOMMENTS Generated constant - Attribute key of AbstractWorkflowAction.workflowActionComments attribute defined at extension workflow.

Fields inherited from class de.hybris.platform.core.model.ItemModel

_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED

Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor and Description
AbstractWorkflowActionModel() Generated constructor - Default constructor for generic creation.
AbstractWorkflowActionModel(ItemModelContext ctx) Generated constructor - Default constructor for creation with existing context
AbstractWorkflowActionModel(WorkflowActionType _actionType, PrincipalModel _principalAssigned) Deprecated. since 4.1.1 Please use the default constructor without parameters
AbstractWorkflowActionModel(WorkflowActionType _actionType, java.lang.String _code, UserModel _owner, PrincipalModel _principalAssigned) Deprecated. since 4.1.1 Please use the default constructor without parameters

Method Summary

Modifier and Type	Method and Description
WorkflowActionType	getActionType() Generated method - Getter of the AbstractWorkflowAction.actionType attribute defined at extension workflow.
java.lang.String	getCode() Generated method - Getter of the AbstractWorkflowAction.code attribute defined at extension workflow.
java.lang.String	getDescription() Generated method - Getter of the AbstractWorkflowAction.description attribute defined at extension workflow.
java.lang.String	getDescription(java.util.Locale loc) Generated method - Getter of the AbstractWorkflowAction.description attribute defined at extension workflow.
java.lang.String	getEmailAddress() Generated method - Getter of the AbstractWorkflowAction.emailAddress attribute defined at extension workflow.
java.lang.String	getName() Generated method - Getter of the AbstractWorkflowAction.name attribute defined at extension workflow.
java.lang.String	getName(java.util.Locale loc) Generated method - Getter of the AbstractWorkflowAction.name attribute defined at extension workflow.
UserModel	getOwner() Generated method - Getter of the Item.owner attribute defined at extension core and redeclared at extension workflow.
java.util.List<AbstractWorkflowActionModel>	getPredecessors() Generated method - Getter of the AbstractWorkflowAction.predecessors attribute defined at extension workflow.
java.lang.String	getPredecessorsStr() Generated method - Getter of the AbstractWorkflowAction.predecessorsStr attribute defined at extension workflow.
PrincipalModel	getPrincipalAssigned() Generated method - Getter of the AbstractWorkflowAction.principalAssigned attribute defined at extension workflow.
java.lang.String	getQualifier() Generated method - Getter of the AbstractWorkflowAction.qualifier attribute defined at extension b2bapprovalprocess.
RendererTemplateModel	getRendererTemplate() Generated method - Getter of the AbstractWorkflowAction.rendererTemplate attribute defined at extension workflow.
java.lang.Boolean	getSendEmail() Generated method - Getter of the AbstractWorkflowAction.sendEmail attribute defined at extension workflow.
java.util.List<AbstractWorkflowActionModel>	getSuccessors() Generated method - Getter of the AbstractWorkflowAction.successors attribute defined at extension workflow.
java.util.Collection<WorkflowActionCommentModel>	getWorkflowActionComments() Generated method - Getter of the AbstractWorkflowAction.workflowActionComments attribute defined at extension workflow.
void	setActionType(WorkflowActionType value) Generated method - Setter of AbstractWorkflowAction.actionType attribute defined at extension workflow.
void	setCode(java.lang.String value) Generated method - Initial setter of AbstractWorkflowAction.code attribute defined at extension workflow.
void	setDescription(java.lang.String value) Generated method - Setter of AbstractWorkflowAction.description attribute defined at extension workflow.
void	setDescription(java.lang.String value, java.util.Locale loc) Generated method - Setter of AbstractWorkflowAction.description attribute defined at extension workflow.
void	setEmailAddress(java.lang.String value) Generated method - Setter of AbstractWorkflowAction.emailAddress attribute defined at extension workflow.
void	setName(java.lang.String value) Generated method - Setter of AbstractWorkflowAction.name attribute defined at extension workflow.
void	setName(java.lang.String value, java.util.Locale loc) Generated method - Setter of AbstractWorkflowAction.name attribute defined at extension workflow.
void	setOwner(ItemModel value) Generated method - Setter of Item.owner attribute defined at extension core and redeclared at extension workflow.
void	setPredecessors(java.util.List<AbstractWorkflowActionModel> value) Generated method - Setter of AbstractWorkflowAction.predecessors attribute defined at extension workflow.
void	setPrincipalAssigned(PrincipalModel value) Generated method - Setter of AbstractWorkflowAction.principalAssigned attribute defined at extension workflow.
void	setQualifier(java.lang.String value) Generated method - Setter of AbstractWorkflowAction.qualifier attribute defined at extension b2bapprovalprocess.
void	setRendererTemplate(RendererTemplateModel value) Generated method - Setter of AbstractWorkflowAction.rendererTemplate attribute defined at extension workflow.
void	setSendEmail(java.lang.Boolean value) Generated method - Setter of AbstractWorkflowAction.sendEmail attribute defined at extension workflow.
void	setSuccessors(java.util.List<AbstractWorkflowActionModel> value) Generated method - Setter of AbstractWorkflowAction.successors attribute defined at extension workflow.
void	setWorkflowActionComments(java.util.Collection<WorkflowActionCommentModel> value) Generated method - Setter of AbstractWorkflowAction.workflowActionComments attribute defined at extension workflow.

Methods inherited from class de.hybris.platform.core.model.ItemModel

getComments, getCreationtime, getModifiedtime, isSealed, setComments, setCreationtime, setModifiedtime

Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_TYPECODE

public static final java.lang.String _TYPECODE

Generated model type code constant.

See Also:

Constant Field Values

_WORKFLOWACTIONORDERINGRELATION

public static final java.lang.String _WORKFLOWACTIONORDERINGRELATION

Generated relation code constant for relation WorkflowActionOrderingRelation defining source attribute predecessors in extension workflow.

See Also:

Constant Field Values

ACTIONTYPE

public static final java.lang.String ACTIONTYPE

Generated constant - Attribute key of AbstractWorkflowAction.actionType attribute defined at extension workflow.

See Also:

Constant Field Values

CODE

public static final java.lang.String CODE

Generated constant - Attribute key of AbstractWorkflowAction.code attribute defined at extension workflow.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Generated constant - Attribute key of AbstractWorkflowAction.name attribute defined at extension workflow.

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

Generated constant - Attribute key of AbstractWorkflowAction.description attribute defined at extension workflow.

See Also:

Constant Field Values

PRINCIPALASSIGNED

public static final java.lang.String PRINCIPALASSIGNED

Generated constant - Attribute key of AbstractWorkflowAction.principalAssigned attribute defined at extension workflow.

See Also:

Constant Field Values

SENDEMAIL

public static final java.lang.String SENDEMAIL

Generated constant - Attribute key of AbstractWorkflowAction.sendEmail attribute defined at extension workflow.

See Also:

Constant Field Values

EMAILADDRESS

public static final java.lang.String EMAILADDRESS

Generated constant - Attribute key of AbstractWorkflowAction.emailAddress attribute defined at extension workflow.

See Also:

Constant Field Values

PREDECESSORSSTR

public static final java.lang.String PREDECESSORSSTR

Generated constant - Attribute key of AbstractWorkflowAction.predecessorsStr attribute defined at extension workflow.

See Also:

Constant Field Values

RENDERERTEMPLATE

public static final java.lang.String RENDERERTEMPLATE

Generated constant - Attribute key of AbstractWorkflowAction.rendererTemplate attribute defined at extension workflow.

See Also:

Constant Field Values

PREDECESSORS

public static final java.lang.String PREDECESSORS

Generated constant - Attribute key of AbstractWorkflowAction.predecessors attribute defined at extension workflow.

See Also:

Constant Field Values

SUCCESSORS

public static final java.lang.String SUCCESSORS

Generated constant - Attribute key of AbstractWorkflowAction.successors attribute defined at extension workflow.

See Also:

Constant Field Values

WORKFLOWACTIONCOMMENTS

public static final java.lang.String WORKFLOWACTIONCOMMENTS

Generated constant - Attribute key of AbstractWorkflowAction.workflowActionComments attribute defined at extension workflow.

See Also:

Constant Field Values

QUALIFIER

public static final java.lang.String QUALIFIER

Generated constant - Attribute key of AbstractWorkflowAction.qualifier attribute defined at extension b2bapprovalprocess.

See Also:

Constant Field Values

Constructor Detail

AbstractWorkflowActionModel

public AbstractWorkflowActionModel()

Generated constructor - Default constructor for generic creation.

AbstractWorkflowActionModel

public AbstractWorkflowActionModel(ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

ctx - the model context to be injected, must not be null

AbstractWorkflowActionModel

@Deprecated
public AbstractWorkflowActionModel(WorkflowActionType _actionType,
                                               PrincipalModel _principalAssigned)

Deprecated. since 4.1.1 Please use the default constructor without parameters

Generated constructor - Constructor with all mandatory attributes.

Parameters:

_actionType - initial attribute declared by type AbstractWorkflowAction at extension workflow

_principalAssigned - initial attribute declared by type AbstractWorkflowAction at extension workflow

AbstractWorkflowActionModel

@Deprecated
public AbstractWorkflowActionModel(WorkflowActionType _actionType,
                                               java.lang.String _code,
                                               UserModel _owner,
                                               PrincipalModel _principalAssigned)

Deprecated. since 4.1.1 Please use the default constructor without parameters

Generated constructor - for all mandatory and initial attributes.

Parameters:

_actionType - initial attribute declared by type AbstractWorkflowAction at extension workflow

_code - initial attribute declared by type AbstractWorkflowAction at extension workflow

_owner - initial attribute declared by type AbstractWorkflowAction at extension workflow

_principalAssigned - initial attribute declared by type AbstractWorkflowAction at extension workflow

Method Detail

getActionType

@Accessor(qualifier="actionType",
          type=GETTER)
public WorkflowActionType getActionType()

Generated method - Getter of the AbstractWorkflowAction.actionType attribute defined at extension workflow.

Returns:

the actionType - marker for the type of an action (start, end, normal)

getCode

@Accessor(qualifier="code",
          type=GETTER)
public java.lang.String getCode()

Generated method - Getter of the AbstractWorkflowAction.code attribute defined at extension workflow.

Returns:

the code - unique identifier of the action

getDescription

@Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription()

Generated method - Getter of the AbstractWorkflowAction.description attribute defined at extension workflow.

Returns:

the description - description of the action; should contain the steps the assigned principal has to perform

getDescription

@Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription(java.util.Locale loc)

Generated method - Getter of the AbstractWorkflowAction.description attribute defined at extension workflow.

Parameters:

loc - the value localization key

Returns:

the description - description of the action; should contain the steps the assigned principal has to perform

Throws:

java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

getEmailAddress

@Accessor(qualifier="emailAddress",
          type=GETTER)
public java.lang.String getEmailAddress()

Generated method - Getter of the AbstractWorkflowAction.emailAddress attribute defined at extension workflow.

Returns:

the emailAddress - e-mail address where notification e-mail will be sent to

getName

@Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName()

Generated method - Getter of the AbstractWorkflowAction.name attribute defined at extension workflow.

Returns:

the name - name of the action

getName

@Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName(java.util.Locale loc)

Generated method - Getter of the AbstractWorkflowAction.name attribute defined at extension workflow.

Parameters:

loc - the value localization key

Returns:

the name - name of the action

Throws:

java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

getOwner

@Accessor(qualifier="owner",
          type=GETTER)
public UserModel getOwner()

Generated method - Getter of the Item.owner attribute defined at extension core and redeclared at extension workflow.

Overrides:

getOwner in class ItemModel

Returns:

the owner

getPredecessors

@Accessor(qualifier="predecessors",
          type=GETTER)
public java.util.List<AbstractWorkflowActionModel> getPredecessors()

Generated method - Getter of the AbstractWorkflowAction.predecessors attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the predecessors

getPredecessorsStr

@Accessor(qualifier="predecessorsStr",
          type=GETTER)
public java.lang.String getPredecessorsStr()

Generated method - Getter of the AbstractWorkflowAction.predecessorsStr attribute defined at extension workflow.

Returns:

the predecessorsStr

getPrincipalAssigned

@Accessor(qualifier="principalAssigned",
          type=GETTER)
public PrincipalModel getPrincipalAssigned()

Generated method - Getter of the AbstractWorkflowAction.principalAssigned attribute defined at extension workflow.

Returns:

the principalAssigned - assigned principal who has to assure the completion (can also be a principal group where any member of the group can process the action)

getQualifier

@Accessor(qualifier="qualifier",
          type=GETTER)
public java.lang.String getQualifier()

Generated method - Getter of the AbstractWorkflowAction.qualifier attribute defined at extension b2bapprovalprocess.

Returns:

the qualifier - Used to qualify an action by a unique name within a context of a workflow

getRendererTemplate

@Accessor(qualifier="rendererTemplate",
          type=GETTER)
public RendererTemplateModel getRendererTemplate()

Generated method - Getter of the AbstractWorkflowAction.rendererTemplate attribute defined at extension workflow.

Returns:

the rendererTemplate

getSendEmail

@Accessor(qualifier="sendEmail",
          type=GETTER)
public java.lang.Boolean getSendEmail()

Generated method - Getter of the AbstractWorkflowAction.sendEmail attribute defined at extension workflow.

Returns:

the sendEmail - if activated a notification e-mail will be sent when action gets active

getSuccessors

@Accessor(qualifier="successors",
          type=GETTER)
public java.util.List<AbstractWorkflowActionModel> getSuccessors()

Generated method - Getter of the AbstractWorkflowAction.successors attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the successors

getWorkflowActionComments

@Accessor(qualifier="workflowActionComments",
          type=GETTER)
public java.util.Collection<WorkflowActionCommentModel> getWorkflowActionComments()

Generated method - Getter of the AbstractWorkflowAction.workflowActionComments attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the workflowActionComments

setActionType

@Accessor(qualifier="actionType",
          type=SETTER)
public void setActionType(WorkflowActionType value)

Generated method - Setter of AbstractWorkflowAction.actionType attribute defined at extension workflow.

Parameters:

value - the actionType - marker for the type of an action (start, end, normal)

setCode

@Accessor(qualifier="code",
          type=SETTER)
public void setCode(java.lang.String value)

Generated method - Initial setter of AbstractWorkflowAction.code attribute defined at extension workflow. Can only be used at creation of model - before first save.

Parameters:

value - the code - unique identifier of the action

setDescription

@Accessor(qualifier="description",
          type=SETTER)
public void setDescription(java.lang.String value)

Generated method - Setter of AbstractWorkflowAction.description attribute defined at extension workflow.

Parameters:

value - the description - description of the action; should contain the steps the assigned principal has to perform

setDescription

@Accessor(qualifier="description",
          type=SETTER)
public void setDescription(java.lang.String value,
                                                                                     java.util.Locale loc)

Generated method - Setter of AbstractWorkflowAction.description attribute defined at extension workflow.

Parameters:

value - the description - description of the action; should contain the steps the assigned principal has to perform

loc - the value localization key

Throws:

java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

setEmailAddress

@Accessor(qualifier="emailAddress",
          type=SETTER)
public void setEmailAddress(java.lang.String value)

Generated method - Setter of AbstractWorkflowAction.emailAddress attribute defined at extension workflow.

Parameters:

value - the emailAddress - e-mail address where notification e-mail will be sent to

setName

@Accessor(qualifier="name",
          type=SETTER)
public void setName(java.lang.String value)

Generated method - Setter of AbstractWorkflowAction.name attribute defined at extension workflow.

Parameters:

value - the name - name of the action

setName

@Accessor(qualifier="name",
          type=SETTER)
public void setName(java.lang.String value,
                                                                       java.util.Locale loc)

Generated method - Setter of AbstractWorkflowAction.name attribute defined at extension workflow.

Parameters:

value - the name - name of the action

loc - the value localization key

Throws:

java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

setOwner

@Accessor(qualifier="owner",
          type=SETTER)
public void setOwner(ItemModel value)

Generated method - Setter of Item.owner attribute defined at extension core and redeclared at extension workflow. Will only accept values of type UserModel.

Overrides:

setOwner in class ItemModel

Parameters:

value - the owner

setPredecessors

@Accessor(qualifier="predecessors",
          type=SETTER)
public void setPredecessors(java.util.List<AbstractWorkflowActionModel> value)

Generated method - Setter of AbstractWorkflowAction.predecessors attribute defined at extension workflow.

Parameters:

value - the predecessors

setPrincipalAssigned

@Accessor(qualifier="principalAssigned",
          type=SETTER)
public void setPrincipalAssigned(PrincipalModel value)

Generated method - Setter of AbstractWorkflowAction.principalAssigned attribute defined at extension workflow.

Parameters:

value - the principalAssigned - assigned principal who has to assure the completion (can also be a principal group where any member of the group can process the action)

setQualifier

@Accessor(qualifier="qualifier",
          type=SETTER)
public void setQualifier(java.lang.String value)

Generated method - Setter of AbstractWorkflowAction.qualifier attribute defined at extension b2bapprovalprocess.

Parameters:

value - the qualifier - Used to qualify an action by a unique name within a context of a workflow

setRendererTemplate

@Accessor(qualifier="rendererTemplate",
          type=SETTER)
public void setRendererTemplate(RendererTemplateModel value)

Generated method - Setter of AbstractWorkflowAction.rendererTemplate attribute defined at extension workflow.

Parameters:

value - the rendererTemplate

setSendEmail

@Accessor(qualifier="sendEmail",
          type=SETTER)
public void setSendEmail(java.lang.Boolean value)

Generated method - Setter of AbstractWorkflowAction.sendEmail attribute defined at extension workflow.

Parameters:

value - the sendEmail - if activated a notification e-mail will be sent when action gets active

setSuccessors

@Accessor(qualifier="successors",
          type=SETTER)
public void setSuccessors(java.util.List<AbstractWorkflowActionModel> value)

Generated method - Setter of AbstractWorkflowAction.successors attribute defined at extension workflow.

Parameters:

value - the successors

setWorkflowActionComments

@Accessor(qualifier="workflowActionComments",
          type=SETTER)
public void setWorkflowActionComments(java.util.Collection<WorkflowActionCommentModel> value)

Generated method - Setter of AbstractWorkflowAction.workflowActionComments attribute defined at extension workflow.

Parameters:

value - the workflowActionComments