Package 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:
Serializable
Direct Known Subclasses:
WorkflowActionModel, WorkflowActionTemplateModel
public class AbstractWorkflowActionModel extends ItemModel
Generated model class for type AbstractWorkflowAction first defined at extension workflow.
See Also:

  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:

    • _WORKFLOWACTIONORDERINGRELATION

      public static final String _WORKFLOWACTIONORDERINGRELATION
      Generated relation code constant for relation WorkflowActionOrderingRelation defining source attribute predecessors in extension workflow.
      See Also:

    • ACTIONTYPE

      public static final String ACTIONTYPE
      Generated constant - Attribute key of AbstractWorkflowAction.actionType attribute defined at extension workflow.
      See Also:

    • CODE

      public static final String CODE
      Generated constant - Attribute key of AbstractWorkflowAction.code attribute defined at extension workflow.
      See Also:

    • NAME

      public static final String NAME
      Generated constant - Attribute key of AbstractWorkflowAction.name attribute defined at extension workflow.
      See Also:

    • DESCRIPTION

      public static final String DESCRIPTION
      Generated constant - Attribute key of AbstractWorkflowAction.description attribute defined at extension workflow.
      See Also:

    • PRINCIPALASSIGNED

      public static final String PRINCIPALASSIGNED
      Generated constant - Attribute key of AbstractWorkflowAction.principalAssigned attribute defined at extension workflow.
      See Also:

    • SENDEMAIL

      public static final String SENDEMAIL
      Generated constant - Attribute key of AbstractWorkflowAction.sendEmail attribute defined at extension workflow.
      See Also:

    • EMAILADDRESS

      public static final String EMAILADDRESS
      Generated constant - Attribute key of AbstractWorkflowAction.emailAddress attribute defined at extension workflow.
      See Also:

    • PREDECESSORSSTR

      public static final String PREDECESSORSSTR
      Generated constant - Attribute key of AbstractWorkflowAction.predecessorsStr attribute defined at extension workflow.
      See Also:

    • RENDERERTEMPLATE

      public static final String RENDERERTEMPLATE
      Generated constant - Attribute key of AbstractWorkflowAction.rendererTemplate attribute defined at extension workflow.
      See Also:

    • PREDECESSORS

      public static final String PREDECESSORS
      Generated constant - Attribute key of AbstractWorkflowAction.predecessors attribute defined at extension workflow.
      See Also:

    • SUCCESSORS

      public static final String SUCCESSORS
      Generated constant - Attribute key of AbstractWorkflowAction.successors attribute defined at extension workflow.
      See Also:

    • WORKFLOWACTIONCOMMENTS

      public static final String WORKFLOWACTIONCOMMENTS
      Generated constant - Attribute key of AbstractWorkflowAction.workflowActionComments attribute defined at extension workflow.
      See Also:

    • VISUALISATIONX

      public static final String VISUALISATIONX
      Generated constant - Attribute key of AbstractWorkflowAction.visualisationX attribute defined at extension backoffice.
      See Also:

    • VISUALISATIONY

      public static final String VISUALISATIONY
      Generated constant - Attribute key of AbstractWorkflowAction.visualisationY attribute defined at extension backoffice.
      See Also:

    • QUALIFIER

      public static final String QUALIFIER
      Generated constant - Attribute key of AbstractWorkflowAction.qualifier attribute defined at extension b2bapprovalprocess.
      See Also:

  • Constructor Details

    • 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(since="4.1.1", forRemoval=true) public AbstractWorkflowActionModel(WorkflowActionType _actionType, PrincipalModel _principalAssigned)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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(since="4.1.1", forRemoval=true) public AbstractWorkflowActionModel(WorkflowActionType _actionType, String _code, UserModel _owner, PrincipalModel _principalAssigned)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 Details

    • 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 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 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 String getDescription(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:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • getEmailAddress

      @Accessor(qualifier="emailAddress", type=GETTER) public 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 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 String getName(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:
      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 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 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 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 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 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

    • getVisualisationX

      @Accessor(qualifier="visualisationX", type=GETTER) public Integer getVisualisationX()
      Generated method - Getter of the AbstractWorkflowAction.visualisationX attribute defined at extension backoffice.
      Returns:
      the visualisationX

    • getVisualisationY

      @Accessor(qualifier="visualisationY", type=GETTER) public Integer getVisualisationY()
      Generated method - Getter of the AbstractWorkflowAction.visualisationY attribute defined at extension backoffice.
      Returns:
      the visualisationY

    • getWorkflowActionComments

      @Accessor(qualifier="workflowActionComments", type=GETTER) public 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(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(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(String value, 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:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • setEmailAddress

      @Accessor(qualifier="emailAddress", type=SETTER) public void setEmailAddress(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(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(String value, 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:
      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(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(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(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(List<AbstractWorkflowActionModel> value)
      Generated method - Setter of AbstractWorkflowAction.successors attribute defined at extension workflow.
      Parameters:
      value - the successors

    • setVisualisationX

      @Accessor(qualifier="visualisationX", type=SETTER) public void setVisualisationX(Integer value)
      Generated method - Setter of AbstractWorkflowAction.visualisationX attribute defined at extension backoffice.
      Parameters:
      value - the visualisationX

    • setVisualisationY

      @Accessor(qualifier="visualisationY", type=SETTER) public void setVisualisationY(Integer value)
      Generated method - Setter of AbstractWorkflowAction.visualisationY attribute defined at extension backoffice.
      Parameters:
      value - the visualisationY

    • setWorkflowActionComments

      @Accessor(qualifier="workflowActionComments", type=SETTER) public void setWorkflowActionComments(Collection<WorkflowActionCommentModel> value)
      Generated method - Setter of AbstractWorkflowAction.workflowActionComments attribute defined at extension workflow.
      Parameters:
      value - the workflowActionComments