Package de.hybris.platform.workflow.model

Class WorkflowModel

java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.cronjob.model.CronJobModel
de.hybris.platform.workflow.model.WorkflowModel
All Implemented Interfaces:
Serializable
public class WorkflowModel extends CronJobModel
Generated model class for type Workflow first defined at extension workflow.
See Also:

  • Field Details

    • _TYPECODE

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

    • _JOBCRONJOBRELATION

      public static final String _JOBCRONJOBRELATION
      Generated relation code constant for relation JobCronJobRelation defining source attribute job in extension processing.
      See Also:

    • NAME

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

    • DESCRIPTION

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

    • ACTIONS

      public static final String ACTIONS
      Generated constant - Attribute key of Workflow.actions attribute defined at extension workflow.
      See Also:

    • ATTACHMENTS

      public static final String ATTACHMENTS
      Generated constant - Attribute key of Workflow.attachments attribute defined at extension workflow.
      See Also:

  • Constructor Details

    • WorkflowModel

      public WorkflowModel()
      Generated constructor - Default constructor for generic creation.

    • WorkflowModel

      public WorkflowModel(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      Parameters:
      ctx - the model context to be injected, must not be null

    • WorkflowModel

      @Deprecated(since="4.1.1", forRemoval=true) public WorkflowModel(WorkflowTemplateModel _job)
      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:
      _job - initial attribute declared by type Workflow at extension workflow

    • WorkflowModel

      @Deprecated(since="4.1.1", forRemoval=true) public WorkflowModel(WorkflowTemplateModel _job, UserModel _owner)
      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:
      _job - initial attribute declared by type Workflow at extension workflow
      _owner - initial attribute declared by type Workflow at extension workflow

  • Method Details

    • getActions

      @Accessor(qualifier="actions", type=GETTER) public List<WorkflowActionModel> getActions()
      Generated method - Getter of the Workflow.actions attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the actions

    • getAttachments

      @Accessor(qualifier="attachments", type=GETTER) public List<WorkflowItemAttachmentModel> getAttachments()
      Generated method - Getter of the Workflow.attachments attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the attachments - n-part of the WorkflowItemAttachmentRelation; holds a set of attachments (item references) belonging to the topic of workflow

    • getDescription

      @Accessor(qualifier="description", type=GETTER) public String getDescription()
      Generated method - Getter of the Workflow.description attribute defined at extension workflow.
      Returns:
      the description - global description of the workflow while each action has its own description

    • getDescription

      @Accessor(qualifier="description", type=GETTER) public String getDescription(Locale loc)
      Generated method - Getter of the Workflow.description attribute defined at extension workflow.
      Parameters:
      loc - the value localization key
      Returns:
      the description - global description of the workflow while each action has its own description
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • getJob

      @Accessor(qualifier="job", type=GETTER) public WorkflowTemplateModel getJob()
      Generated method - Getter of the CronJob.job attribute defined at extension processing and redeclared at extension workflow.
      Overrides:
      getJob in class CronJobModel
      Returns:
      the job - related workflow template this workflow is created from (never changable)

    • getName

      @Accessor(qualifier="name", type=GETTER) public String getName()
      Generated method - Getter of the Workflow.name attribute defined at extension workflow.
      Returns:
      the name - name of the workflow

    • getName

      @Accessor(qualifier="name", type=GETTER) public String getName(Locale loc)
      Generated method - Getter of the Workflow.name attribute defined at extension workflow.
      Parameters:
      loc - the value localization key
      Returns:
      the name - name of the workflow
      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 - user responsible for this workflow

    • setActions

      @Accessor(qualifier="actions", type=SETTER) public void setActions(List<WorkflowActionModel> value)
      Generated method - Setter of Workflow.actions attribute defined at extension workflow.
      Parameters:
      value - the actions

    • setAttachments

      @Accessor(qualifier="attachments", type=SETTER) public void setAttachments(List<WorkflowItemAttachmentModel> value)
      Generated method - Setter of Workflow.attachments attribute defined at extension workflow.
      Parameters:
      value - the attachments - n-part of the WorkflowItemAttachmentRelation; holds a set of attachments (item references) belonging to the topic of workflow

    • setDescription

      @Accessor(qualifier="description", type=SETTER) public void setDescription(String value)
      Generated method - Setter of Workflow.description attribute defined at extension workflow.
      Parameters:
      value - the description - global description of the workflow while each action has its own description

    • setDescription

      @Accessor(qualifier="description", type=SETTER) public void setDescription(String value, Locale loc)
      Generated method - Setter of Workflow.description attribute defined at extension workflow.
      Parameters:
      value - the description - global description of the workflow while each action has its own description
      loc - the value localization key
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language

    • setJob

      @Accessor(qualifier="job", type=SETTER) public void setJob(JobModel value)
      Generated method - Initial setter of CronJob.job attribute defined at extension processing and redeclared at extension workflow. Can only be used at creation of model - before first save. Will only accept values of type WorkflowTemplateModel.
      Overrides:
      setJob in class CronJobModel
      Parameters:
      value - the job - related workflow template this workflow is created from (never changable)

    • setName

      @Accessor(qualifier="name", type=SETTER) public void setName(String value)
      Generated method - Setter of Workflow.name attribute defined at extension workflow.
      Parameters:
      value - the name - name of the workflow

    • setName

      @Accessor(qualifier="name", type=SETTER) public void setName(String value, Locale loc)
      Generated method - Setter of Workflow.name attribute defined at extension workflow.
      Parameters:
      value - the name - name of the workflow
      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 - user responsible for this workflow