Package de.hybris.platform.processengine.model

Class BusinessProcessModel

java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.processengine.model.BusinessProcessModel
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ConsignmentProcessModel, OrderProcessModel, QuoteProcessModel, ReturnProcessModel, StoreFrontProcessModel
public class BusinessProcessModel extends ItemModel
Generated model class for type BusinessProcess first defined at extension processing.
See Also:

  • Nested Class Summary

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

    de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    _TYPECODE
    Generated model type code constant.
    static final String
    CODE
    Generated constant - Attribute key of BusinessProcess.code attribute defined at extension processing.
    static final String
    CONTEXTPARAMETERS
    Generated constant - Attribute key of BusinessProcess.contextParameters attribute defined at extension processing.
    static final String
    CURRENTTASKS
    Generated constant - Attribute key of BusinessProcess.currentTasks attribute defined at extension processing.
    static final String
    EMAILS
    Generated constant - Attribute key of BusinessProcess.emails attribute defined at extension acceleratorservices.
    static final String
    ENDMESSAGE
    Generated constant - Attribute key of BusinessProcess.endMessage attribute defined at extension processing.
    static final String
    PROCESSDEFINITIONNAME
    Generated constant - Attribute key of BusinessProcess.processDefinitionName attribute defined at extension processing.
    static final String
    PROCESSDEFINITIONVERSION
    Generated constant - Attribute key of BusinessProcess.processDefinitionVersion attribute defined at extension processing.
    static final String
    PROCESSSTATE
    Generated constant - Attribute key of BusinessProcess.processState attribute defined at extension processing.
    static final String
    STATE
    Generated constant - Attribute key of BusinessProcess.state attribute defined at extension processing.
    static final String
    TASKLOGS
    Generated constant - Attribute key of BusinessProcess.taskLogs attribute defined at extension processing.
    static final String
    USER
    Generated constant - Attribute key of BusinessProcess.user attribute defined at extension processing.

    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
    Description
    BusinessProcessModel()
    Generated constructor - Default constructor for generic creation.
    BusinessProcessModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
    Generated constructor - Default constructor for creation with existing context
    BusinessProcessModel(String _code, ItemModel _owner, String _processDefinitionName)
    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
    BusinessProcessModel(String _code, String _processDefinitionName)
    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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCode()
    Generated method - Getter of the BusinessProcess.code attribute defined at extension processing.
    Collection<BusinessProcessParameterModel>
    getContextParameters()
    Generated method - Getter of the BusinessProcess.contextParameters attribute defined at extension processing.
    Collection<ProcessTaskModel>
    getCurrentTasks()
    Generated method - Getter of the BusinessProcess.currentTasks attribute defined at extension processing.
    List<EmailMessageModel>
    getEmails()
    Generated method - Getter of the BusinessProcess.emails attribute defined at extension acceleratorservices.
    String
    getEndMessage()
    Generated method - Getter of the BusinessProcess.endMessage attribute defined at extension processing.
    String
    getProcessDefinitionName()
    Generated method - Getter of the BusinessProcess.processDefinitionName attribute defined at extension processing.
    String
    getProcessDefinitionVersion()
    Generated method - Getter of the BusinessProcess.processDefinitionVersion attribute defined at extension processing.
    ProcessState
    getProcessState()
    Generated method - Getter of the BusinessProcess.processState dynamic attribute defined at extension processing.
    ProcessState
    getState()
    Generated method - Getter of the BusinessProcess.state attribute defined at extension processing.
    Collection<ProcessTaskLogModel>
    getTaskLogs()
    Generated method - Getter of the BusinessProcess.taskLogs attribute defined at extension processing.
    UserModel
    getUser()
    Generated method - Getter of the BusinessProcess.user attribute defined at extension processing.
    void
    setCode(String value)
    Generated method - Initial setter of BusinessProcess.code attribute defined at extension processing.
    void
    setContextParameters(Collection<BusinessProcessParameterModel> value)
    Generated method - Setter of BusinessProcess.contextParameters attribute defined at extension processing.
    void
    setCurrentTasks(Collection<ProcessTaskModel> value)
    Generated method - Setter of BusinessProcess.currentTasks attribute defined at extension processing.
    void
    setEmails(List<EmailMessageModel> value)
    Generated method - Setter of BusinessProcess.emails attribute defined at extension acceleratorservices.
    void
    setEndMessage(String value)
    Generated method - Setter of BusinessProcess.endMessage attribute defined at extension processing.
    void
    setProcessDefinitionName(String value)
    Generated method - Initial setter of BusinessProcess.processDefinitionName attribute defined at extension processing.
    void
    setProcessDefinitionVersion(String value)
    Generated method - Setter of BusinessProcess.processDefinitionVersion attribute defined at extension processing.
    void
    setState(ProcessState value)
    Generated method - Setter of BusinessProcess.state attribute defined at extension processing.
    void
    setTaskLogs(Collection<ProcessTaskLogModel> value)
    Generated method - Setter of BusinessProcess.taskLogs attribute defined at extension processing.
    void
    setUser(UserModel value)
    Generated method - Setter of BusinessProcess.user attribute defined at extension processing.

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

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

    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 Details

    • _TYPECODE

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

    • CODE

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

    • PROCESSDEFINITIONNAME

      public static final String PROCESSDEFINITIONNAME
      Generated constant - Attribute key of BusinessProcess.processDefinitionName attribute defined at extension processing.
      See Also:

    • PROCESSDEFINITIONVERSION

      public static final String PROCESSDEFINITIONVERSION
      Generated constant - Attribute key of BusinessProcess.processDefinitionVersion attribute defined at extension processing.
      See Also:

    • STATE

      public static final String STATE
      Generated constant - Attribute key of BusinessProcess.state attribute defined at extension processing.
      See Also:

    • PROCESSSTATE

      public static final String PROCESSSTATE
      Generated constant - Attribute key of BusinessProcess.processState attribute defined at extension processing.
      See Also:

    • ENDMESSAGE

      public static final String ENDMESSAGE
      Generated constant - Attribute key of BusinessProcess.endMessage attribute defined at extension processing.
      See Also:

    • USER

      public static final String USER
      Generated constant - Attribute key of BusinessProcess.user attribute defined at extension processing.
      See Also:

    • CURRENTTASKS

      public static final String CURRENTTASKS
      Generated constant - Attribute key of BusinessProcess.currentTasks attribute defined at extension processing.
      See Also:

    • CONTEXTPARAMETERS

      public static final String CONTEXTPARAMETERS
      Generated constant - Attribute key of BusinessProcess.contextParameters attribute defined at extension processing.
      See Also:

    • TASKLOGS

      public static final String TASKLOGS
      Generated constant - Attribute key of BusinessProcess.taskLogs attribute defined at extension processing.
      See Also:

    • EMAILS

      public static final String EMAILS
      Generated constant - Attribute key of BusinessProcess.emails attribute defined at extension acceleratorservices.
      See Also:

  • Constructor Details

    • BusinessProcessModel

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

    • BusinessProcessModel

      public BusinessProcessModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      Parameters:
      ctx - the model context to be injected, must not be null

    • BusinessProcessModel

      @Deprecated(since="4.1.1", forRemoval=true) public BusinessProcessModel(String _code, String _processDefinitionName)
      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 BusinessProcess at extension processing
      _processDefinitionName - initial attribute declared by type BusinessProcess at extension processing

    • BusinessProcessModel

      @Deprecated(since="4.1.1", forRemoval=true) public BusinessProcessModel(String _code, ItemModel _owner, String _processDefinitionName)
      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 BusinessProcess at extension processing
      _owner - initial attribute declared by type Item at extension core
      _processDefinitionName - initial attribute declared by type BusinessProcess at extension processing

  • Method Details

    • getCode

      @Accessor(qualifier="code", type=GETTER) public String getCode()
      Generated method - Getter of the BusinessProcess.code attribute defined at extension processing.
      Returns:
      the code - Unique identifier of this process

    • getContextParameters

      @Accessor(qualifier="contextParameters", type=GETTER) public Collection<BusinessProcessParameterModel> getContextParameters()
      Generated method - Getter of the BusinessProcess.contextParameters attribute defined at extension processing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the contextParameters

    • getCurrentTasks

      @Accessor(qualifier="currentTasks", type=GETTER) public Collection<ProcessTaskModel> getCurrentTasks()
      Generated method - Getter of the BusinessProcess.currentTasks attribute defined at extension processing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the currentTasks

    • getEmails

      @Accessor(qualifier="emails", type=GETTER) public List<EmailMessageModel> getEmails()
      Generated method - Getter of the BusinessProcess.emails attribute defined at extension acceleratorservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the emails

    • getEndMessage

      @Accessor(qualifier="endMessage", type=GETTER) public String getEndMessage()
      Generated method - Getter of the BusinessProcess.endMessage attribute defined at extension processing.
      Returns:
      the endMessage - Message given in the end state of the process.

    • getProcessDefinitionName

      @Accessor(qualifier="processDefinitionName", type=GETTER) public String getProcessDefinitionName()
      Generated method - Getter of the BusinessProcess.processDefinitionName attribute defined at extension processing.
      Returns:
      the processDefinitionName - Name of the process definition to use.

    • getProcessDefinitionVersion

      @Accessor(qualifier="processDefinitionVersion", type=GETTER) public String getProcessDefinitionVersion()
      Generated method - Getter of the BusinessProcess.processDefinitionVersion attribute defined at extension processing.
      Returns:
      the processDefinitionVersion - Version of the process definition used by this process.

    • getProcessState

      @Accessor(qualifier="processState", type=GETTER) public ProcessState getProcessState()
      Generated method - Getter of the BusinessProcess.processState dynamic attribute defined at extension processing.
      Returns:
      the processState - Current (accessible) state of this process.

    • getState

      @Accessor(qualifier="state", type=GETTER) public ProcessState getState()
      Generated method - Getter of the BusinessProcess.state attribute defined at extension processing.
      Returns:
      the state - Current (persisted) state of this process.

    • getTaskLogs

      @Accessor(qualifier="taskLogs", type=GETTER) public Collection<ProcessTaskLogModel> getTaskLogs()
      Generated method - Getter of the BusinessProcess.taskLogs attribute defined at extension processing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the taskLogs

    • getUser

      @Accessor(qualifier="user", type=GETTER) public UserModel getUser()
      Generated method - Getter of the BusinessProcess.user attribute defined at extension processing.
      Returns:
      the user

    • setCode

      @Accessor(qualifier="code", type=SETTER) public void setCode(String value)
      Generated method - Initial setter of BusinessProcess.code attribute defined at extension processing. Can only be used at creation of model - before first save.
      Parameters:
      value - the code - Unique identifier of this process

    • setContextParameters

      @Accessor(qualifier="contextParameters", type=SETTER) public void setContextParameters(Collection<BusinessProcessParameterModel> value)
      Generated method - Setter of BusinessProcess.contextParameters attribute defined at extension processing.
      Parameters:
      value - the contextParameters

    • setCurrentTasks

      @Accessor(qualifier="currentTasks", type=SETTER) public void setCurrentTasks(Collection<ProcessTaskModel> value)
      Generated method - Setter of BusinessProcess.currentTasks attribute defined at extension processing.
      Parameters:
      value - the currentTasks

    • setEmails

      @Accessor(qualifier="emails", type=SETTER) public void setEmails(List<EmailMessageModel> value)
      Generated method - Setter of BusinessProcess.emails attribute defined at extension acceleratorservices.
      Parameters:
      value - the emails

    • setEndMessage

      @Accessor(qualifier="endMessage", type=SETTER) public void setEndMessage(String value)
      Generated method - Setter of BusinessProcess.endMessage attribute defined at extension processing.
      Parameters:
      value - the endMessage - Message given in the end state of the process.

    • setProcessDefinitionName

      @Accessor(qualifier="processDefinitionName", type=SETTER) public void setProcessDefinitionName(String value)
      Generated method - Initial setter of BusinessProcess.processDefinitionName attribute defined at extension processing. Can only be used at creation of model - before first save.
      Parameters:
      value - the processDefinitionName - Name of the process definition to use.

    • setProcessDefinitionVersion

      @Accessor(qualifier="processDefinitionVersion", type=SETTER) public void setProcessDefinitionVersion(String value)
      Generated method - Setter of BusinessProcess.processDefinitionVersion attribute defined at extension processing.
      Parameters:
      value - the processDefinitionVersion - Version of the process definition used by this process.

    • setState

      @Accessor(qualifier="state", type=SETTER) public void setState(ProcessState value)
      Generated method - Setter of BusinessProcess.state attribute defined at extension processing.
      Parameters:
      value - the state - Current (persisted) state of this process.

    • setTaskLogs

      @Accessor(qualifier="taskLogs", type=SETTER) public void setTaskLogs(Collection<ProcessTaskLogModel> value)
      Generated method - Setter of BusinessProcess.taskLogs attribute defined at extension processing.
      Parameters:
      value - the taskLogs

    • setUser

      @Accessor(qualifier="user", type=SETTER) public void setUser(UserModel value)
      Generated method - Setter of BusinessProcess.user attribute defined at extension processing.
      Parameters:
      value - the user