Package de.hybris.platform.workflow.jalo

Class GeneratedWorkflowAction

    • Field Detail

      • INCOMINGLINKS

        public static final java.lang.String INCOMINGLINKS
        Qualifier of the WorkflowAction.incomingLinks attribute
        See Also:
        Constant Field Values

      • INCOMINGLINKSSTR

        public static final java.lang.String INCOMINGLINKSSTR
        Qualifier of the WorkflowAction.incomingLinksStr attribute
        See Also:
        Constant Field Values

      • SELECTEDDECISION

        public static final java.lang.String SELECTEDDECISION
        Qualifier of the WorkflowAction.selectedDecision attribute
        See Also:
        Constant Field Values

      • FIRSTACTIVATED

        public static final java.lang.String FIRSTACTIVATED
        Qualifier of the WorkflowAction.firstActivated attribute
        See Also:
        Constant Field Values

      • ACTIVATED

        public static final java.lang.String ACTIVATED
        Qualifier of the WorkflowAction.activated attribute
        See Also:
        Constant Field Values

      • COMMENT

        public static final java.lang.String COMMENT
        Qualifier of the WorkflowAction.comment attribute
        See Also:
        Constant Field Values

      • STATUS

        public static final java.lang.String STATUS
        Qualifier of the WorkflowAction.status attribute
        See Also:
        Constant Field Values

      • TEMPLATE

        public static final java.lang.String TEMPLATE
        Qualifier of the WorkflowAction.template attribute
        See Also:
        Constant Field Values

      • ATTACHMENTITEMS

        public static final java.lang.String ATTACHMENTITEMS
        Qualifier of the WorkflowAction.attachmentItems attribute
        See Also:
        Constant Field Values

      • WORKFLOWPOS

        public static final java.lang.String WORKFLOWPOS
        Qualifier of the WorkflowAction.workflowPOS attribute
        See Also:
        Constant Field Values

      • WORKFLOW

        public static final java.lang.String WORKFLOW
        Qualifier of the WorkflowAction.workflow attribute
        See Also:
        Constant Field Values

      • DECISIONS

        public static final java.lang.String DECISIONS
        Qualifier of the WorkflowAction.decisions attribute
        See Also:
        Constant Field Values

      • INCOMINGDECISIONS

        public static final java.lang.String INCOMINGDECISIONS
        Qualifier of the WorkflowAction.incomingDecisions attribute
        See Also:
        Constant Field Values

      • WORKFLOWACTIONLINKRELATION_SRC_ORDERED

        protected static java.lang.String WORKFLOWACTIONLINKRELATION_SRC_ORDERED
        Relation ordering override parameter constants for WorkflowActionLinkRelation from ((workflow))

      • WORKFLOWACTIONLINKRELATION_TGT_ORDERED

        protected static java.lang.String WORKFLOWACTIONLINKRELATION_TGT_ORDERED

      • WORKFLOWACTIONLINKRELATION_MARKMODIFIED

        protected static java.lang.String WORKFLOWACTIONLINKRELATION_MARKMODIFIED
        Relation disable markmodifed parameter constants for WorkflowActionLinkRelation from ((workflow))

      • ATTACHMENTS

        public static final java.lang.String ATTACHMENTS
        Qualifier of the WorkflowAction.attachments attribute
        See Also:
        Constant Field Values

      • WORKFLOWACTIONITEMATTACHMENTRELATION_SRC_ORDERED

        protected static java.lang.String WORKFLOWACTIONITEMATTACHMENTRELATION_SRC_ORDERED
        Relation ordering override parameter constants for WorkflowActionItemAttachmentRelation from ((workflow))

      • WORKFLOWACTIONITEMATTACHMENTRELATION_TGT_ORDERED

        protected static java.lang.String WORKFLOWACTIONITEMATTACHMENTRELATION_TGT_ORDERED

      • WORKFLOWACTIONITEMATTACHMENTRELATION_MARKMODIFIED

        protected static java.lang.String WORKFLOWACTIONITEMATTACHMENTRELATION_MARKMODIFIED
        Relation disable markmodifed parameter constants for WorkflowActionItemAttachmentRelation from ((workflow))

      • DEFAULT_INITIAL_ATTRIBUTES

        protected static final java.util.Map<java.lang.String,​Item.AttributeMode> DEFAULT_INITIAL_ATTRIBUTES

    • Constructor Detail

      • GeneratedWorkflowAction

        public GeneratedWorkflowAction()

    • Method Detail

      • getActivated

        public java.util.Date getActivated​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.activated attribute.
        Returns:
        the activated - date of last activation

      • getActivated

        public java.util.Date getActivated()
        Generated method - Getter of the WorkflowAction.activated attribute.
        Returns:
        the activated - date of last activation

      • setActivated

        public void setActivated​(SessionContext ctx,
                         java.util.Date value)
        Generated method - Setter of the WorkflowAction.activated attribute.
        Parameters:
        value - the activated - date of last activation

      • setActivated

        public void setActivated​(java.util.Date value)
        Generated method - Setter of the WorkflowAction.activated attribute.
        Parameters:
        value - the activated - date of last activation

      • getAttachmentItems

        public abstract java.util.List<Item> getAttachmentItems​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.attachmentItems attribute.
        Returns:
        the attachmentItems

      • getAttachmentItems

        public java.util.List<Item> getAttachmentItems()
        Generated method - Getter of the WorkflowAction.attachmentItems attribute.
        Returns:
        the attachmentItems

      • getAttachments

        public java.util.List<WorkflowItemAttachment> getAttachments​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.attachments attribute.
        Returns:
        the attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action

      • getAttachments

        public java.util.List<WorkflowItemAttachment> getAttachments()
        Generated method - Getter of the WorkflowAction.attachments attribute.
        Returns:
        the attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action

      • getAttachmentsCount

        public long getAttachmentsCount​(SessionContext ctx)

      • getAttachmentsCount

        public long getAttachmentsCount()

      • setAttachments

        public void setAttachments​(SessionContext ctx,
                           java.util.List<WorkflowItemAttachment> value)
        Generated method - Setter of the WorkflowAction.attachments attribute.
        Parameters:
        value - the attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action

      • setAttachments

        public void setAttachments​(java.util.List<WorkflowItemAttachment> value)
        Generated method - Setter of the WorkflowAction.attachments attribute.
        Parameters:
        value - the attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action

      • addToAttachments

        public void addToAttachments​(SessionContext ctx,
                             WorkflowItemAttachment value)
        Generated method - Adds value to attachments.
        Parameters:
        value - the item to add to attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action

      • addToAttachments

        public void addToAttachments​(WorkflowItemAttachment value)
        Generated method - Adds value to attachments.
        Parameters:
        value - the item to add to attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action

      • removeFromAttachments

        public void removeFromAttachments​(SessionContext ctx,
                                  WorkflowItemAttachment value)
        Generated method - Removes value from attachments.
        Parameters:
        value - the item to remove from attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action

      • removeFromAttachments

        public void removeFromAttachments​(WorkflowItemAttachment value)
        Generated method - Removes value from attachments.
        Parameters:
        value - the item to remove from attachments - part of the WorkflowActionItemAttachmentRelation; associates a set of attachments set to the related workflow of this action

      • getComment

        public java.lang.String getComment​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.comment attribute.
        Returns:
        the comment - comment of the assigned principal on the status of the action

      • getComment

        public java.lang.String getComment()
        Generated method - Getter of the WorkflowAction.comment attribute.
        Returns:
        the comment - comment of the assigned principal on the status of the action

      • setComment

        public void setComment​(SessionContext ctx,
                       java.lang.String value)
        Generated method - Setter of the WorkflowAction.comment attribute.
        Parameters:
        value - the comment - comment of the assigned principal on the status of the action

      • setComment

        public void setComment​(java.lang.String value)
        Generated method - Setter of the WorkflowAction.comment attribute.
        Parameters:
        value - the comment - comment of the assigned principal on the status of the action

      • createItem

        protected Item createItem​(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException
        Description copied from class: Item
        Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

        In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
        Sn example: 

        
 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
        Overrides:
        createItem in class AbstractWorkflowAction
        Parameters:
        ctx - the current session context which this item is created within
        type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )
        Returns:
        the new item instance
        Throws:
        JaloBusinessException - indicates an error during creation - any changes will be rollbacked

      • getDecisions

        public java.util.Collection<WorkflowDecision> getDecisions​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.decisions attribute.
        Returns:
        the decisions - set of all possible decisions of this action

      • getDecisions

        public java.util.Collection<WorkflowDecision> getDecisions()
        Generated method - Getter of the WorkflowAction.decisions attribute.
        Returns:
        the decisions - set of all possible decisions of this action

      • setDecisions

        public void setDecisions​(SessionContext ctx,
                         java.util.Collection<WorkflowDecision> value)
        Generated method - Setter of the WorkflowAction.decisions attribute.
        Parameters:
        value - the decisions - set of all possible decisions of this action

      • setDecisions

        public void setDecisions​(java.util.Collection<WorkflowDecision> value)
        Generated method - Setter of the WorkflowAction.decisions attribute.
        Parameters:
        value - the decisions - set of all possible decisions of this action

      • addToDecisions

        public void addToDecisions​(SessionContext ctx,
                           WorkflowDecision value)
        Generated method - Adds value to decisions.
        Parameters:
        value - the item to add to decisions - set of all possible decisions of this action

      • addToDecisions

        public void addToDecisions​(WorkflowDecision value)
        Generated method - Adds value to decisions.
        Parameters:
        value - the item to add to decisions - set of all possible decisions of this action

      • removeFromDecisions

        public void removeFromDecisions​(SessionContext ctx,
                                WorkflowDecision value)
        Generated method - Removes value from decisions.
        Parameters:
        value - the item to remove from decisions - set of all possible decisions of this action

      • removeFromDecisions

        public void removeFromDecisions​(WorkflowDecision value)
        Generated method - Removes value from decisions.
        Parameters:
        value - the item to remove from decisions - set of all possible decisions of this action

      • getFirstActivated

        public java.util.Date getFirstActivated​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.firstActivated attribute.
        Returns:
        the firstActivated - date of first activation of the action (in case of a rejected action an action can be activated twice for example)

      • getFirstActivated

        public java.util.Date getFirstActivated()
        Generated method - Getter of the WorkflowAction.firstActivated attribute.
        Returns:
        the firstActivated - date of first activation of the action (in case of a rejected action an action can be activated twice for example)

      • setFirstActivated

        public void setFirstActivated​(SessionContext ctx,
                              java.util.Date value)
        Generated method - Setter of the WorkflowAction.firstActivated attribute.
        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)

      • setFirstActivated

        public void setFirstActivated​(java.util.Date value)
        Generated method - Setter of the WorkflowAction.firstActivated attribute.
        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)

      • getIncomingDecisions

        public java.util.Collection<WorkflowDecision> getIncomingDecisions​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.incomingDecisions attribute.
        Returns:
        the incomingDecisions

      • getIncomingDecisions

        public java.util.Collection<WorkflowDecision> getIncomingDecisions()
        Generated method - Getter of the WorkflowAction.incomingDecisions attribute.
        Returns:
        the incomingDecisions

      • getIncomingDecisionsCount

        public long getIncomingDecisionsCount​(SessionContext ctx)

      • getIncomingDecisionsCount

        public long getIncomingDecisionsCount()

      • setIncomingDecisions

        public void setIncomingDecisions​(SessionContext ctx,
                                 java.util.Collection<WorkflowDecision> value)
        Generated method - Setter of the WorkflowAction.incomingDecisions attribute.
        Parameters:
        value - the incomingDecisions

      • setIncomingDecisions

        public void setIncomingDecisions​(java.util.Collection<WorkflowDecision> value)
        Generated method - Setter of the WorkflowAction.incomingDecisions attribute.
        Parameters:
        value - the incomingDecisions

      • addToIncomingDecisions

        public void addToIncomingDecisions​(SessionContext ctx,
                                   WorkflowDecision value)
        Generated method - Adds value to incomingDecisions.
        Parameters:
        value - the item to add to incomingDecisions

      • addToIncomingDecisions

        public void addToIncomingDecisions​(WorkflowDecision value)
        Generated method - Adds value to incomingDecisions.
        Parameters:
        value - the item to add to incomingDecisions

      • removeFromIncomingDecisions

        public void removeFromIncomingDecisions​(SessionContext ctx,
                                        WorkflowDecision value)
        Generated method - Removes value from incomingDecisions.
        Parameters:
        value - the item to remove from incomingDecisions

      • removeFromIncomingDecisions

        public void removeFromIncomingDecisions​(WorkflowDecision value)
        Generated method - Removes value from incomingDecisions.
        Parameters:
        value - the item to remove from incomingDecisions

      • getIncomingLinks

        public abstract java.util.List<Link> getIncomingLinks​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.incomingLinks attribute.
        Returns:
        the incomingLinks

      • getIncomingLinks

        public java.util.List<Link> getIncomingLinks()
        Generated method - Getter of the WorkflowAction.incomingLinks attribute.
        Returns:
        the incomingLinks

      • getIncomingLinksStr

        public abstract java.lang.String getIncomingLinksStr​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.incomingLinksStr attribute.
        Returns:
        the incomingLinksStr

      • getIncomingLinksStr

        public java.lang.String getIncomingLinksStr()
        Generated method - Getter of the WorkflowAction.incomingLinksStr attribute.
        Returns:
        the incomingLinksStr

      • getSelectedDecision

        public WorkflowDecision getSelectedDecision​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.selectedDecision attribute.
        Returns:
        the selectedDecision - the decision chosen when the action is processed

      • getSelectedDecision

        public WorkflowDecision getSelectedDecision()
        Generated method - Getter of the WorkflowAction.selectedDecision attribute.
        Returns:
        the selectedDecision - the decision chosen when the action is processed

      • setSelectedDecision

        public void setSelectedDecision​(SessionContext ctx,
                                WorkflowDecision value)
        Generated method - Setter of the WorkflowAction.selectedDecision attribute.
        Parameters:
        value - the selectedDecision - the decision chosen when the action is processed

      • setSelectedDecision

        public void setSelectedDecision​(WorkflowDecision value)
        Generated method - Setter of the WorkflowAction.selectedDecision attribute.
        Parameters:
        value - the selectedDecision - the decision chosen when the action is processed

      • getStatus

        public EnumerationValue getStatus​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.status attribute.
        Returns:
        the status - the status of the action (pending, active, completed)

      • getStatus

        public EnumerationValue getStatus()
        Generated method - Getter of the WorkflowAction.status attribute.
        Returns:
        the status - the status of the action (pending, active, completed)

      • setStatus

        public void setStatus​(SessionContext ctx,
                      EnumerationValue value)
        Generated method - Setter of the WorkflowAction.status attribute.
        Parameters:
        value - the status - the status of the action (pending, active, completed)

      • setStatus

        public void setStatus​(EnumerationValue value)
        Generated method - Setter of the WorkflowAction.status attribute.
        Parameters:
        value - the status - the status of the action (pending, active, completed)

      • getTemplate

        public WorkflowActionTemplate getTemplate​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.template attribute.
        Returns:
        the template - the action template this action was created by; template defines the perform method

      • getTemplate

        public WorkflowActionTemplate getTemplate()
        Generated method - Getter of the WorkflowAction.template attribute.
        Returns:
        the template - the action template this action was created by; template defines the perform method

      • setTemplate

        protected void setTemplate​(SessionContext ctx,
                           WorkflowActionTemplate value)
        Generated method - Setter of the WorkflowAction.template attribute.
        Parameters:
        value - the template - the action template this action was created by; template defines the perform method

      • setTemplate

        protected void setTemplate​(WorkflowActionTemplate value)
        Generated method - Setter of the WorkflowAction.template attribute.
        Parameters:
        value - the template - the action template this action was created by; template defines the perform method

      • getWorkflow

        public Workflow getWorkflow​(SessionContext ctx)
        Generated method - Getter of the WorkflowAction.workflow attribute.
        Returns:
        the workflow - workflow to which the action belongs

      • getWorkflow

        public Workflow getWorkflow()
        Generated method - Getter of the WorkflowAction.workflow attribute.
        Returns:
        the workflow - workflow to which the action belongs

      • setWorkflow

        protected void setWorkflow​(SessionContext ctx,
                           Workflow value)
        Generated method - Setter of the WorkflowAction.workflow attribute.
        Parameters:
        value - the workflow - workflow to which the action belongs

      • setWorkflow

        protected void setWorkflow​(Workflow value)
        Generated method - Setter of the WorkflowAction.workflow attribute.
        Parameters:
        value - the workflow - workflow to which the action belongs