Package de.hybris.platform.processengine.model

Class BusinessProcessModel

    • Field Detail

      • _TYPECODE

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

      • CODE

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

      • PROCESSDEFINITIONNAME

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

      • PROCESSDEFINITIONVERSION

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

      • STATE

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

      • PROCESSSTATE

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

      • ENDMESSAGE

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

      • USER

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

      • CURRENTTASKS

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

      • CONTEXTPARAMETERS

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

      • TASKLOGS

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

      • EMAILS

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

    • Constructor Detail

      • BusinessProcessModel

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

      • BusinessProcessModel

        public BusinessProcessModel​(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​(java.lang.String _code,
                            java.lang.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​(java.lang.String _code,
                            ItemModel _owner,
                            java.lang.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 Detail

      • getCode

        @Accessor(qualifier="code",
          type=GETTER)
public java.lang.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 java.util.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 java.util.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 java.util.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 java.lang.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 java.lang.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 java.lang.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 java.util.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​(java.lang.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​(java.util.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​(java.util.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​(java.util.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.util.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