Class WorkflowActionModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class WorkflowActionModel
    extends AbstractWorkflowActionModel
    Generated model class for type WorkflowAction 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
      • _WORKFLOWACTIONORDERINGRELATION

        public static final java.lang.String _WORKFLOWACTIONORDERINGRELATION
        Generated relation code constant for relation WorkflowActionOrderingRelation defining source attribute predecessors in extension workflow.
        See Also:
        Constant Field Values
      • _WORKFLOWACTIONRELATION

        public static final java.lang.String _WORKFLOWACTIONRELATION
        Generated relation code constant for relation WorkflowActionRelation defining source attribute workflow in extension workflow.
        See Also:
        Constant Field Values
      • _WORKFLOWACTIONLINKRELATION

        public static final java.lang.String _WORKFLOWACTIONLINKRELATION
        Generated relation code constant for relation WorkflowActionLinkRelation defining source attribute incomingDecisions in extension workflow.
        See Also:
        Constant Field Values
      • INCOMINGLINKS

        public static final java.lang.String INCOMINGLINKS
        Generated constant - Attribute key of WorkflowAction.incomingLinks attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • INCOMINGLINKSSTR

        public static final java.lang.String INCOMINGLINKSSTR
        Generated constant - Attribute key of WorkflowAction.incomingLinksStr attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • SELECTEDDECISION

        public static final java.lang.String SELECTEDDECISION
        Generated constant - Attribute key of WorkflowAction.selectedDecision attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • FIRSTACTIVATED

        public static final java.lang.String FIRSTACTIVATED
        Generated constant - Attribute key of WorkflowAction.firstActivated attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • ACTIVATED

        public static final java.lang.String ACTIVATED
        Generated constant - Attribute key of WorkflowAction.activated attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • COMMENT

        public static final java.lang.String COMMENT
        Generated constant - Attribute key of WorkflowAction.comment attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • STATUS

        public static final java.lang.String STATUS
        Generated constant - Attribute key of WorkflowAction.status attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • TEMPLATE

        public static final java.lang.String TEMPLATE
        Generated constant - Attribute key of WorkflowAction.template attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • ATTACHMENTITEMS

        public static final java.lang.String ATTACHMENTITEMS
        Generated constant - Attribute key of WorkflowAction.attachmentItems attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • WORKFLOWPOS

        public static final java.lang.String WORKFLOWPOS
        Generated constant - Attribute key of WorkflowAction.workflowPOS attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • WORKFLOW

        public static final java.lang.String WORKFLOW
        Generated constant - Attribute key of WorkflowAction.workflow attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • DECISIONS

        public static final java.lang.String DECISIONS
        Generated constant - Attribute key of WorkflowAction.decisions attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • INCOMINGDECISIONS

        public static final java.lang.String INCOMINGDECISIONS
        Generated constant - Attribute key of WorkflowAction.incomingDecisions attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • ATTACHMENTS

        public static final java.lang.String ATTACHMENTS
        Generated constant - Attribute key of WorkflowAction.attachments attribute defined at extension workflow.
        See Also:
        Constant Field Values
    • Constructor Detail

      • WorkflowActionModel

        public WorkflowActionModel()
        Generated constructor - Default constructor for generic creation.
      • WorkflowActionModel

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

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public WorkflowActionModel​(WorkflowActionType _actionType,
                                   PrincipalModel _principalAssigned,
                                   WorkflowActionTemplateModel _template,
                                   WorkflowModel _workflow)
        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
        _template - initial attribute declared by type WorkflowAction at extension workflow
        _workflow - initial attribute declared by type WorkflowAction at extension workflow
      • WorkflowActionModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public WorkflowActionModel​(WorkflowActionType _actionType,
                                   java.lang.String _code,
                                   UserModel _owner,
                                   PrincipalModel _principalAssigned,
                                   WorkflowActionTemplateModel _template,
                                   WorkflowModel _workflow)
        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
        _template - initial attribute declared by type WorkflowAction at extension workflow
        _workflow - initial attribute declared by type WorkflowAction at extension workflow
    • Method Detail

      • getActivated

        @Accessor(qualifier="activated",
                  type=GETTER)
        public java.util.Date getActivated()
        Generated method - Getter of the WorkflowAction.activated attribute defined at extension workflow.
        Returns:
        the activated - date of last activation
      • getAttachmentItems

        @Accessor(qualifier="attachmentItems",
                  type=GETTER)
        public java.util.List<ItemModel> getAttachmentItems()
        Generated method - Getter of the WorkflowAction.attachmentItems attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the attachmentItems
      • getAttachments

        @Accessor(qualifier="attachments",
                  type=GETTER)
        public java.util.List<WorkflowItemAttachmentModel> getAttachments()
        Generated method - Getter of the WorkflowAction.attachments attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action
      • getComment

        @Accessor(qualifier="comment",
                  type=GETTER)
        public java.lang.String getComment()
        Generated method - Getter of the WorkflowAction.comment attribute defined at extension workflow.
        Returns:
        the comment - comment of the assigned principal on the status of the action
      • getDecisions

        @Accessor(qualifier="decisions",
                  type=GETTER)
        public java.util.Collection<WorkflowDecisionModel> getDecisions()
        Generated method - Getter of the WorkflowAction.decisions attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the decisions - set of all possible decisions of this action
      • getFirstActivated

        @Accessor(qualifier="firstActivated",
                  type=GETTER)
        public java.util.Date getFirstActivated()
        Generated method - Getter of the WorkflowAction.firstActivated attribute defined at extension workflow.
        Returns:
        the firstActivated - date of first activation of the action (in case of a rejected action an action can be activated twice for example)
      • getIncomingDecisions

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

        @Accessor(qualifier="incomingLinks",
                  type=GETTER)
        public java.util.List<LinkModel> getIncomingLinks()
        Generated method - Getter of the WorkflowAction.incomingLinks attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the incomingLinks
      • getIncomingLinksStr

        @Accessor(qualifier="incomingLinksStr",
                  type=GETTER)
        public java.lang.String getIncomingLinksStr()
        Generated method - Getter of the WorkflowAction.incomingLinksStr attribute defined at extension workflow.
        Returns:
        the incomingLinksStr
      • getSelectedDecision

        @Accessor(qualifier="selectedDecision",
                  type=GETTER)
        public WorkflowDecisionModel getSelectedDecision()
        Generated method - Getter of the WorkflowAction.selectedDecision attribute defined at extension workflow.
        Returns:
        the selectedDecision - the decision chosen when the action is processed
      • getStatus

        @Accessor(qualifier="status",
                  type=GETTER)
        public WorkflowActionStatus getStatus()
        Generated method - Getter of the WorkflowAction.status attribute defined at extension workflow.
        Returns:
        the status - the status of the action (pending, active, completed)
      • getTemplate

        @Accessor(qualifier="template",
                  type=GETTER)
        public WorkflowActionTemplateModel getTemplate()
        Generated method - Getter of the WorkflowAction.template attribute defined at extension workflow.
        Returns:
        the template - the action template this action was created by; template defines the perform method
      • getWorkflow

        @Accessor(qualifier="workflow",
                  type=GETTER)
        public WorkflowModel getWorkflow()
        Generated method - Getter of the WorkflowAction.workflow attribute defined at extension workflow.
        Returns:
        the workflow - workflow to which the action belongs
      • setActivated

        @Accessor(qualifier="activated",
                  type=SETTER)
        public void setActivated​(java.util.Date value)
        Generated method - Setter of WorkflowAction.activated attribute defined at extension workflow.
        Parameters:
        value - the activated - date of last activation
      • setAttachments

        @Accessor(qualifier="attachments",
                  type=SETTER)
        public void setAttachments​(java.util.List<WorkflowItemAttachmentModel> value)
        Generated method - Setter of WorkflowAction.attachments attribute defined at extension workflow.
        Parameters:
        value - the attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action
      • setComment

        @Accessor(qualifier="comment",
                  type=SETTER)
        public void setComment​(java.lang.String value)
        Generated method - Setter of WorkflowAction.comment attribute defined at extension workflow.
        Parameters:
        value - the comment - comment of the assigned principal on the status of the action
      • setDecisions

        @Accessor(qualifier="decisions",
                  type=SETTER)
        public void setDecisions​(java.util.Collection<WorkflowDecisionModel> value)
        Generated method - Setter of WorkflowAction.decisions attribute defined at extension workflow.
        Parameters:
        value - the decisions - set of all possible decisions of this action
      • setFirstActivated

        @Accessor(qualifier="firstActivated",
                  type=SETTER)
        public void setFirstActivated​(java.util.Date value)
        Generated method - Setter of WorkflowAction.firstActivated attribute defined at extension workflow.
        Parameters:
        value - the firstActivated - date of first activation of the action (in case of a rejected action an action can be activated twice for example)
      • setIncomingDecisions

        @Accessor(qualifier="incomingDecisions",
                  type=SETTER)
        public void setIncomingDecisions​(java.util.Collection<WorkflowDecisionModel> value)
        Generated method - Setter of WorkflowAction.incomingDecisions attribute defined at extension workflow.
        Parameters:
        value - the incomingDecisions
      • setSelectedDecision

        @Accessor(qualifier="selectedDecision",
                  type=SETTER)
        public void setSelectedDecision​(WorkflowDecisionModel value)
        Generated method - Setter of WorkflowAction.selectedDecision attribute defined at extension workflow.
        Parameters:
        value - the selectedDecision - the decision chosen when the action is processed
      • setStatus

        @Accessor(qualifier="status",
                  type=SETTER)
        public void setStatus​(WorkflowActionStatus value)
        Generated method - Setter of WorkflowAction.status attribute defined at extension workflow.
        Parameters:
        value - the status - the status of the action (pending, active, completed)
      • setTemplate

        @Accessor(qualifier="template",
                  type=SETTER)
        public void setTemplate​(WorkflowActionTemplateModel value)
        Generated method - Initial setter of WorkflowAction.template attribute defined at extension workflow. Can only be used at creation of model - before first save.
        Parameters:
        value - the template - the action template this action was created by; template defines the perform method
      • setWorkflow

        @Accessor(qualifier="workflow",
                  type=SETTER)
        public void setWorkflow​(WorkflowModel value)
        Generated method - Initial setter of WorkflowAction.workflow attribute defined at extension workflow. Can only be used at creation of model - before first save.
        Parameters:
        value - the workflow - workflow to which the action belongs