Package de.hybris.platform.workflow.model

Class WorkflowTemplateModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class WorkflowTemplateModel
extends JobModel
    Generated model class for type WorkflowTemplate first defined at extension workflow.
    See Also:
    Serialized Form

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • _WORKFLOWTEMPLATEFORCATALOGVERSION

        public static final java.lang.String _WORKFLOWTEMPLATEFORCATALOGVERSION
        Generated relation code constant for relation WorkflowTemplateForCatalogVersion defining source attribute catalogVersions in extension cms2.
        See Also:
        Constant Field Values

      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of WorkflowTemplate.name attribute defined at extension workflow.
        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of WorkflowTemplate.description attribute defined at extension workflow.
        See Also:
        Constant Field Values

      • ACTIVATIONSCRIPT

        public static final java.lang.String ACTIVATIONSCRIPT
        Generated constant - Attribute key of WorkflowTemplate.activationScript attribute defined at extension workflow.
        See Also:
        Constant Field Values

      • ACTIONS

        public static final java.lang.String ACTIONS
        Generated constant - Attribute key of WorkflowTemplate.actions attribute defined at extension workflow.
        See Also:
        Constant Field Values

      • VISIBLEFORPRINCIPALS

        public static final java.lang.String VISIBLEFORPRINCIPALS
        Generated constant - Attribute key of WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow.
        See Also:
        Constant Field Values

      • CATALOGVERSIONS

        public static final java.lang.String CATALOGVERSIONS
        Generated constant - Attribute key of WorkflowTemplate.catalogVersions attribute defined at extension cms2.
        See Also:
        Constant Field Values

    • Constructor Detail

      • WorkflowTemplateModel

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

      • WorkflowTemplateModel

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

      • WorkflowTemplateModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public WorkflowTemplateModel​(java.lang.String _code)
        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:
        _code - initial attribute declared by type WorkflowTemplate at extension workflow

      • WorkflowTemplateModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public WorkflowTemplateModel​(java.lang.String _code,
                             java.lang.Integer _nodeID,
                             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:
        _code - initial attribute declared by type WorkflowTemplate at extension workflow
        _nodeID - initial attribute declared by type Job at extension processing
        _owner - initial attribute declared by type WorkflowTemplate at extension workflow

    • Method Detail

      • getActions

        @Accessor(qualifier="actions",
          type=GETTER)
public java.util.List<WorkflowActionTemplateModel> getActions()
        Generated method - Getter of the WorkflowTemplate.actions attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the actions - n-part of the WorkflowTemplateActionTemplateRelation; set of action templates from which a action will be created and set to the workflow created by the workflow template each

      • getActivationScript

        @Accessor(qualifier="activationScript",
          type=GETTER)
public java.lang.String getActivationScript()
        Generated method - Getter of the WorkflowTemplate.activationScript attribute defined at extension workflow.
        Returns:
        the activationScript - Java code used to automatically trigger a Workflow

      • getCatalogVersions

        @Accessor(qualifier="catalogVersions",
          type=GETTER)
public java.util.Collection<CatalogVersionModel> getCatalogVersions()
        Generated method - Getter of the WorkflowTemplate.catalogVersions attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the catalogVersions

      • getDescription

        @Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription()
        Generated method - Getter of the WorkflowTemplate.description attribute defined at extension workflow.
        Returns:
        the description - description of the workflows created by the template; will be copied to a created workflow initially

      • getDescription

        @Accessor(qualifier="description",
          type=GETTER)
public java.lang.String getDescription​(java.util.Locale loc)
        Generated method - Getter of the WorkflowTemplate.description attribute defined at extension workflow.
        Parameters:
        loc - the value localization key
        Returns:
        the description - description of the workflows created by the template; will be copied to a created workflow initially
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName()
        Generated method - Getter of the WorkflowTemplate.name attribute defined at extension workflow.
        Returns:
        the name - name of the workflows created by the template; will be copied to a created workflow initially

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName​(java.util.Locale loc)
        Generated method - Getter of the WorkflowTemplate.name attribute defined at extension workflow.
        Parameters:
        loc - the value localization key
        Returns:
        the name - name of the workflows created by the template; will be copied to a created workflow initially
        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 - responsible user for this template

      • getVisibleForPrincipals

        @Accessor(qualifier="visibleForPrincipals",
          type=GETTER)
public java.util.Collection<PrincipalModel> getVisibleForPrincipals()
        Generated method - Getter of the WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the visibleForPrincipals

      • setActions

        @Accessor(qualifier="actions",
          type=SETTER)
public void setActions​(java.util.List<WorkflowActionTemplateModel> value)
        Generated method - Setter of WorkflowTemplate.actions attribute defined at extension workflow.
        Parameters:
        value - the actions - n-part of the WorkflowTemplateActionTemplateRelation; set of action templates from which a action will be created and set to the workflow created by the workflow template each

      • setActivationScript

        @Accessor(qualifier="activationScript",
          type=SETTER)
public void setActivationScript​(java.lang.String value)
        Generated method - Setter of WorkflowTemplate.activationScript attribute defined at extension workflow.
        Parameters:
        value - the activationScript - Java code used to automatically trigger a Workflow

      • setCatalogVersions

        @Accessor(qualifier="catalogVersions",
          type=SETTER)
public void setCatalogVersions​(java.util.Collection<CatalogVersionModel> value)
        Generated method - Setter of WorkflowTemplate.catalogVersions attribute defined at extension cms2.
        Parameters:
        value - the catalogVersions

      • setDescription

        @Accessor(qualifier="description",
          type=SETTER)
public void setDescription​(java.lang.String value)
        Generated method - Setter of WorkflowTemplate.description attribute defined at extension workflow.
        Parameters:
        value - the description - description of the workflows created by the template; will be copied to a created workflow initially

      • setDescription

        @Accessor(qualifier="description",
          type=SETTER)
public void setDescription​(java.lang.String value,
                           java.util.Locale loc)
        Generated method - Setter of WorkflowTemplate.description attribute defined at extension workflow.
        Parameters:
        value - the description - description of the workflows created by the template; will be copied to a created workflow initially
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value)
        Generated method - Setter of WorkflowTemplate.name attribute defined at extension workflow.
        Parameters:
        value - the name - name of the workflows created by the template; will be copied to a created workflow initially

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value,
                    java.util.Locale loc)
        Generated method - Setter of WorkflowTemplate.name attribute defined at extension workflow.
        Parameters:
        value - the name - name of the workflows created by the template; will be copied to a created workflow initially
        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 - responsible user for this template

      • setVisibleForPrincipals

        @Accessor(qualifier="visibleForPrincipals",
          type=SETTER)
public void setVisibleForPrincipals​(java.util.Collection<PrincipalModel> value)
        Generated method - Setter of WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow.
        Parameters:
        value - the visibleForPrincipals