Package com.flowable.action.engine.impl.persistence.entity

Class ActionDefinitionEntityImpl

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<ActionDefinitionLink> getActionDefinitionLinks()
      Returns the action definition links that are linked to the action definition.
      java.lang.String getAssignedGroupId()
      Returns the id of the assigned group of this object.
      java.lang.String getAssigneeId()
      Returns the id of the assignee of this object.
      java.lang.String getBotKey()
      Returns the key of the bot this action is implemented.
      java.util.Set<java.lang.String> getCandidateGroupIds()
      Returns a set view of the optional list of candidate group ids of this object.
      java.util.Set<java.lang.String> getCandidateUserIds()
      Returns a set view of the optional list of candidate user ids of this object.
      java.util.Date getCreationTime()
      Returns the creation timestamp of this data object.
      java.lang.String getCreatorId()
      Returns the id of the user creating this data object.
      java.lang.String getDeploymentId()  
      java.lang.String getFormKey()
      If this action has an attached form definition, this method returns the form key of it with which the form definition might be requested through Form Engine.
      java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getIdentityLinks()  
      java.lang.String getKey()  
      java.lang.String getName()
      Returns the name of this action which is also used as the slash action name (e.g.
      java.lang.String getOwnerId()
      Returns the id of the owner of this object, most likely representing the user actually creating it or being created as part of an operation that user executed.
      java.lang.Object getPersistentState()  
      java.util.List<ActionDefinitionLink> getQueryActionDefinitionLinks()
      Getter used by MyBatis when querying action definitions with action definition links.
      java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getQueryIdentityLinks()
      Getter used by MyBatis when querying action definitions with identity links.
      java.lang.String getResourceName()  
      java.lang.String getScopeType()
      Returns the type of scope if this action definition is bound to a certain type of scoped objects (e.g.
      java.lang.String getTenantId()  
      java.lang.String getUpdaterId()
      Returns the optional id of the user having last modified this data object, if any, null otherwise.
      java.util.Date getUpdateTime()
      Returns the timestamp of the last update of this data object, in most cases where events are immutable, this timestamp is the same as the creation timestamp, but must never be null.
      int getVersion()  
      boolean isGlobal()
      Whether the action definition is global
      boolean isMandatory()
      Returns true if this is a mandatory action definition, which means it has to be executed (as an action) at some point (most likely it is then backed by a user task or anything which needs to be completed somehow).
      void setActionDefinitionLinks​(java.util.List<ActionDefinitionLink> actionDefinitionLinks)  
      void setBotKey​(java.lang.String botKey)  
      void setCreationTime​(java.util.Date creationTime)  
      void setCreatorId​(java.lang.String creatorId)  
      void setDeploymentId​(java.lang.String deploymentId)  
      void setFormKey​(java.lang.String formKey)  
      void setGlobal​(boolean global)  
      void setIdentityLinks​(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)  
      void setKey​(java.lang.String key)  
      void setMandatory​(boolean mandatory)  
      void setName​(java.lang.String name)  
      void setQueryActionDefinitionLinks​(java.util.List<ActionDefinitionLink> actionDefinitionLinks)
      Setter used by MyBatis when querying action definitions with action definition links.
      void setQueryIdentityLinks​(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
      Setter used by MyBatis when querying action definitions with identity links.
      void setResourceName​(java.lang.String resourceName)  
      void setScopeType​(java.lang.String scopeType)  
      void setTenantId​(java.lang.String tenantId)  
      void setUpdaterId​(java.lang.String updaterId)  
      void setUpdateTime​(java.util.Date updateTime)  
      void setVersion​(int version)  

      • Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

        getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

        getId, getIdPrefix, getOriginalPersistentState, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setUpdated

      • Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

        getRevision, getRevisionNext, setRevision

    • Field Detail

      • key

        protected java.lang.String key

      • version

        protected int version

      • deploymentId

        protected java.lang.String deploymentId

      • tenantId

        protected java.lang.String tenantId

      • botKey

        protected java.lang.String botKey

      • mandatory

        protected boolean mandatory

      • name

        protected java.lang.String name

      • resourceName

        protected java.lang.String resourceName

      • scopeType

        protected java.lang.String scopeType

      • formKey

        protected java.lang.String formKey

      • global

        protected boolean global

      • creationTime

        protected java.util.Date creationTime

      • updateTime

        protected java.util.Date updateTime

      • creatorId

        protected java.lang.String creatorId

      • updaterId

        protected java.lang.String updaterId

      • identityLinksInitialized

        protected boolean identityLinksInitialized

      • actionDefinitionLinksInitialized

        protected boolean actionDefinitionLinksInitialized

      • identityLinks

        protected java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks
        The identity links for the action definition. Make sure that it is not set otherwise MyBatis won't invoke the setter.

    • Constructor Detail

      • ActionDefinitionEntityImpl

        public ActionDefinitionEntityImpl()

    • Method Detail

      • getBotKey

        public java.lang.String getBotKey()
        Description copied from interface: ActionDefinition
        Returns the key of the bot this action is implemented. When receiving an action, the bot will be looked up and send the action there for processing.
        Specified by:
        getBotKey in interface ActionDefinition
        Returns:
        the key of the bot to send the action to for processing

      • isMandatory

        public boolean isMandatory()
        Description copied from interface: ActionDefinition
        Returns true if this is a mandatory action definition, which means it has to be executed (as an action) at some point (most likely it is then backed by a user task or anything which needs to be completed somehow). This is an optional flag and defaults to false if not provided explicitly.
        Specified by:
        isMandatory in interface ActionDefinition
        Returns:
        true if this action definition is mandatory

      • getName

        public java.lang.String getName()
        Description copied from interface: ActionDefinition
        Returns the name of this action which is also used as the slash action name (e.g. name 'foo' would be exposed within a conversation with '/foo' to execute it).
        Specified by:
        getName in interface ActionDefinition
        Returns:
        the name of the action

      • getScopeType

        public java.lang.String getScopeType()
        Description copied from interface: ActionDefinition
        Returns the type of scope if this action definition is bound to a certain type of scoped objects (e.g. conversation, user, etc).
        Specified by:
        getScopeType in interface ActionDefinition
        Returns:
        the type of scoped objects this action definition is bound to

      • getFormKey

        public java.lang.String getFormKey()
        Description copied from interface: ActionDefinition
        If this action has an attached form definition, this method returns the form key of it with which the form definition might be requested through Form Engine.
        Specified by:
        getFormKey in interface ActionDefinition
        Returns:
        the key of the form to be used to render this action definition and get input to create an action object

      • isGlobal

        public boolean isGlobal()
        Description copied from interface: ActionDefinition
        Whether the action definition is global
        Specified by:
        isGlobal in interface ActionDefinition
        Returns:
        true if the AD is global, false otherwise

      • getCreationTime

        public java.util.Date getCreationTime()
        Description copied from interface: ActionDefinition
        Returns the creation timestamp of this data object.
        Specified by:
        getCreationTime in interface ActionDefinition
        Returns:
        the creation timestamp

      • getUpdateTime

        public java.util.Date getUpdateTime()
        Description copied from interface: ActionDefinition
        Returns the timestamp of the last update of this data object, in most cases where events are immutable, this timestamp is the same as the creation timestamp, but must never be null.
        Specified by:
        getUpdateTime in interface ActionDefinition
        Returns:
        the timestamp of the last update / modification of this data object

      • getCreatorId

        public java.lang.String getCreatorId()
        Description copied from interface: ActionDefinition
        Returns the id of the user creating this data object.
        Specified by:
        getCreatorId in interface ActionDefinition
        Returns:
        the id of the creation user

      • getUpdaterId

        public java.lang.String getUpdaterId()
        Description copied from interface: ActionDefinition
        Returns the optional id of the user having last modified this data object, if any, null otherwise.
        Specified by:
        getUpdaterId in interface ActionDefinition
        Returns:
        the optional id of the user having last updated this data object

      • getOwnerId

        public java.lang.String getOwnerId()
        Description copied from interface: ActionDefinition
        Returns the id of the owner of this object, most likely representing the user actually creating it or being created as part of an operation that user executed.
        Specified by:
        getOwnerId in interface ActionDefinition
        Returns:
        the id of the user being the owner of this object

      • getAssigneeId

        public java.lang.String getAssigneeId()
        Description copied from interface: ActionDefinition
        Returns the id of the assignee of this object. What the assignee actually represents is up to the objects use cases and implementation.
        Specified by:
        getAssigneeId in interface ActionDefinition
        Returns:
        the optional id of the user being the assignee of the object

      • getAssignedGroupId

        public java.lang.String getAssignedGroupId()
        Description copied from interface: ActionDefinition
        Returns the id of the assigned group of this object. What the assigned group actually represents is up to the objects use cases and implementation.
        Specified by:
        getAssignedGroupId in interface ActionDefinition
        Returns:
        the id of the optional assigned group

      • getCandidateUserIds

        public java.util.Set<java.lang.String> getCandidateUserIds()
        Description copied from interface: ActionDefinition
        Returns a set view of the optional list of candidate user ids of this object. In most cases, this is used to allow access to the object for a selected list of users.
        Specified by:
        getCandidateUserIds in interface ActionDefinition
        Returns:
        the optional list of candidate user ids attached to this object

      • getCandidateGroupIds

        public java.util.Set<java.lang.String> getCandidateGroupIds()
        Description copied from interface: ActionDefinition
        Returns a set view of the optional list of candidate group ids of this object. Like with the list of candidate users, all users being at least a member of one of the candidate groups will also have access to this object.
        Specified by:
        getCandidateGroupIds in interface ActionDefinition
        Returns:
        the optional list of candidate group ids attached to this object

      • getIdentityLinks

        public java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getIdentityLinks()
        Specified by:
        getIdentityLinks in interface ActionDefinitionEntity

      • setIdentityLinks

        public void setIdentityLinks​(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
        Specified by:
        setIdentityLinks in interface ActionDefinitionEntity

      • getQueryIdentityLinks

        public java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getQueryIdentityLinks()
        Getter used by MyBatis when querying action definitions with identity links.

      • setQueryIdentityLinks

        public void setQueryIdentityLinks​(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
        Setter used by MyBatis when querying action definitions with identity links.

      • getQueryActionDefinitionLinks

        public java.util.List<ActionDefinitionLink> getQueryActionDefinitionLinks()
        Getter used by MyBatis when querying action definitions with action definition links.

      • setQueryActionDefinitionLinks

        public void setQueryActionDefinitionLinks​(java.util.List<ActionDefinitionLink> actionDefinitionLinks)
        Setter used by MyBatis when querying action definitions with action definition links.

      • getPersistentState

        public java.lang.Object getPersistentState()
        Specified by:
        getPersistentState in interface org.flowable.common.engine.impl.persistence.entity.Entity