Class WorkflowItemAttachmentModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class WorkflowItemAttachmentModel
    extends ItemModel
    Generated model class for type WorkflowItemAttachment 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
      • _WORKFLOWITEMATTACHMENTRELATION

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

        public static final java.lang.String _WORKFLOWACTIONITEMATTACHMENTRELATION
        Generated relation code constant for relation WorkflowActionItemAttachmentRelation defining source attribute actions in extension workflow.
        See Also:
        Constant Field Values
      • CODE

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

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

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

        public static final java.lang.String ITEM
        Generated constant - Attribute key of WorkflowItemAttachment.item attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • TYPEOFITEM

        public static final java.lang.String TYPEOFITEM
        Generated constant - Attribute key of WorkflowItemAttachment.typeOfItem attribute defined at extension workflow.
        See Also:
        Constant Field Values
      • ACTIONSTR

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

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

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

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

      • WorkflowItemAttachmentModel

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

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

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public WorkflowItemAttachmentModel​(ItemModel _item,
                                           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:
        _item - initial attribute declared by type WorkflowItemAttachment at extension workflow
        _workflow - initial attribute declared by type WorkflowItemAttachment at extension workflow
      • WorkflowItemAttachmentModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public WorkflowItemAttachmentModel​(java.lang.String _code,
                                           ItemModel _item,
                                           ItemModel _owner,
                                           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:
        _code - initial attribute declared by type WorkflowItemAttachment at extension workflow
        _item - initial attribute declared by type WorkflowItemAttachment at extension workflow
        _owner - initial attribute declared by type Item at extension core
        _workflow - initial attribute declared by type WorkflowItemAttachment at extension workflow
    • Method Detail

      • getActions

        @Accessor(qualifier="actions",
                  type=GETTER)
        public java.util.Collection<WorkflowActionModel> getActions()
        Generated method - Getter of the WorkflowItemAttachment.actions attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the actions - part of WorkflowActionItemAttachmentRelation; references specific actions of referenced workflow for which attachment is relevant for processing
      • getActionStr

        @Accessor(qualifier="actionStr",
                  type=GETTER)
        public java.lang.String getActionStr()
        Generated method - Getter of the WorkflowItemAttachment.actionStr attribute defined at extension workflow.
        Returns:
        the actionStr
      • getCode

        @Accessor(qualifier="code",
                  type=GETTER)
        public java.lang.String getCode()
        Generated method - Getter of the WorkflowItemAttachment.code attribute defined at extension workflow.
        Returns:
        the code - identifier of this attachment; will be generated if not set
      • getComment

        @Accessor(qualifier="comment",
                  type=GETTER)
        public java.lang.String getComment()
        Generated method - Getter of the WorkflowItemAttachment.comment attribute defined at extension workflow.
        Returns:
        the comment - a comment containing some notes either by creator or processor
      • getItem

        @Accessor(qualifier="item",
                  type=GETTER)
        public ItemModel getItem()
        Generated method - Getter of the WorkflowItemAttachment.item attribute defined at extension workflow.
        Returns:
        the item - the item this attachment references
      • getName

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

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName​(java.util.Locale loc)
        Generated method - Getter of the WorkflowItemAttachment.name attribute defined at extension workflow.
        Parameters:
        loc - the value localization key
        Returns:
        the name - name of the attachment
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getTypeOfItem

        @Accessor(qualifier="typeOfItem",
                  type=GETTER)
        public ComposedTypeModel getTypeOfItem()
        Generated method - Getter of the WorkflowItemAttachment.typeOfItem attribute defined at extension workflow.
        Returns:
        the typeOfItem
      • getWorkflow

        @Accessor(qualifier="workflow",
                  type=GETTER)
        public WorkflowModel getWorkflow()
        Generated method - Getter of the WorkflowItemAttachment.workflow attribute defined at extension workflow.
        Returns:
        the workflow - 1-part of WorkflowItemAttachmentRelation; references the related workflow this attachment belongs to
      • setActions

        @Accessor(qualifier="actions",
                  type=SETTER)
        public void setActions​(java.util.Collection<WorkflowActionModel> value)
        Generated method - Setter of WorkflowItemAttachment.actions attribute defined at extension workflow.
        Parameters:
        value - the actions - part of WorkflowActionItemAttachmentRelation; references specific actions of referenced workflow for which attachment is relevant for processing
      • setCode

        @Accessor(qualifier="code",
                  type=SETTER)
        public void setCode​(java.lang.String value)
        Generated method - Initial setter of WorkflowItemAttachment.code attribute defined at extension workflow. Can only be used at creation of model - before first save.
        Parameters:
        value - the code - identifier of this attachment; will be generated if not set
      • setComment

        @Accessor(qualifier="comment",
                  type=SETTER)
        public void setComment​(java.lang.String value)
        Generated method - Setter of WorkflowItemAttachment.comment attribute defined at extension workflow.
        Parameters:
        value - the comment - a comment containing some notes either by creator or processor
      • setItem

        @Accessor(qualifier="item",
                  type=SETTER)
        public void setItem​(ItemModel value)
        Generated method - Setter of WorkflowItemAttachment.item attribute defined at extension workflow.
        Parameters:
        value - the item - the item this attachment references
      • setName

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

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value,
                            java.util.Locale loc)
        Generated method - Setter of WorkflowItemAttachment.name attribute defined at extension workflow.
        Parameters:
        value - the name - name of the attachment
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setWorkflow

        @Accessor(qualifier="workflow",
                  type=SETTER)
        public void setWorkflow​(WorkflowModel value)
        Generated method - Initial setter of WorkflowItemAttachment.workflow attribute defined at extension workflow. Can only be used at creation of model - before first save.
        Parameters:
        value - the workflow - 1-part of WorkflowItemAttachmentRelation; references the related workflow this attachment belongs to