Interface ActionRepositoryService
-
- All Known Implementing Classes:
ActionRepositoryServiceImpl
public interface ActionRepositoryService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ActionDefinitionLinkaddActionDefinitionLink(java.lang.String actionDefinitionId, java.lang.String type, java.lang.String linkValue)Adds a newActionDefinitionLinkfor the given action definition id.java.lang.StringconvertActionDefinitionModelToJson(java.lang.String actionDefinitionId)Returns theActionDefinitionModelas a JSON string.ActionDefinitionQuerycreateActionDefinitionQuery()Query case definitionsActionDeploymentBuildercreateDeployment()Starts creating a new deploymentActionDeploymentQuerycreateDeploymentQuery()Query deploymentsvoiddeleteActionDefinitionLink(java.lang.String actionDefinitionLinkId)Deletes anActionDefinitionLinkfor the given action definition link id.voiddeleteDeployment(java.lang.String deploymentId)Deletes the given deployment.ActionDefinitiongetActionDefinition(java.lang.String actionDefinitionId)Returns theActionDefinitionincluding all action information like additional Properties (e.g.ActionDefinitiongetActionDefinitionByKey(java.lang.String actionDefinitionKey)Returns theActionDefinitionincluding all action information like additional Properties (e.g.ActionDefinitiongetActionDefinitionByKeyAndTenantId(java.lang.String actionDefinitionKey, java.lang.String tenantId)Returns theActionDefinitionincluding all action information like additional Properties (e.g.java.util.List<ActionDefinitionLink>getActionDefinitionLinks(java.lang.String actionDefinitionId)ReturnsActionDefinitionLinks for the given action definition id.ActionDefinitionModelgetActionDefinitionModel(java.lang.String actionDefinitionId)Returns theActionDefinitionModelincluding all action model info.ActionDefinitionModelgetActionDefinitionModelByKey(java.lang.String actionDefinitionKey)Returns theActionDefinitionModelincluding all action model info, using the action definition key and resolving the key to the latest version.ActionDefinitionModelgetActionDefinitionModelByKeyAndTenantId(java.lang.String actionDefinitionKey, java.lang.String tenantId)Returns theActionDefinitionModelincluding all action model info, using the action definition key and resolving the key to the latest version.java.util.List<java.lang.String>getDeploymentResourceNames(java.lang.String deploymentId)Retrieves a list of deployment resources for the given deployment, ordered alphabetically.java.io.InputStreamgetResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)Gives access to a deployment resource through a stream of bytes.
-
-
-
Method Detail
-
createDeployment
ActionDeploymentBuilder createDeployment()
Starts creating a new deployment
-
getDeploymentResourceNames
java.util.List<java.lang.String> getDeploymentResourceNames(java.lang.String deploymentId)
Retrieves a list of deployment resources for the given deployment, ordered alphabetically.- Parameters:
deploymentId- id of the deployment, cannot be null.
-
getResourceAsStream
java.io.InputStream getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)Gives access to a deployment resource through a stream of bytes.- Parameters:
deploymentId- id of the deployment, cannot be null.resourceName- name of the resource, cannot be null.- Throws:
org.flowable.common.engine.api.FlowableObjectNotFoundException- when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.
-
getActionDefinitionModel
ActionDefinitionModel getActionDefinitionModel(java.lang.String actionDefinitionId)
Returns theActionDefinitionModelincluding all action model info.
-
getActionDefinitionModelByKey
ActionDefinitionModel getActionDefinitionModelByKey(java.lang.String actionDefinitionKey)
Returns theActionDefinitionModelincluding all action model info, using the action definition key and resolving the key to the latest version.
-
getActionDefinitionModelByKeyAndTenantId
ActionDefinitionModel getActionDefinitionModelByKeyAndTenantId(java.lang.String actionDefinitionKey, java.lang.String tenantId)
Returns theActionDefinitionModelincluding all action model info, using the action definition key and resolving the key to the latest version.
-
convertActionDefinitionModelToJson
java.lang.String convertActionDefinitionModelToJson(java.lang.String actionDefinitionId)
Returns theActionDefinitionModelas a JSON string.
-
getActionDefinition
ActionDefinition getActionDefinition(java.lang.String actionDefinitionId)
Returns theActionDefinitionincluding all action information like additional Properties (e.g. documentation).
-
getActionDefinitionByKey
ActionDefinition getActionDefinitionByKey(java.lang.String actionDefinitionKey)
Returns theActionDefinitionincluding all action information like additional Properties (e.g. documentation). The latest version for the given key will be returned.
-
getActionDefinitionByKeyAndTenantId
ActionDefinition getActionDefinitionByKeyAndTenantId(java.lang.String actionDefinitionKey, java.lang.String tenantId)
Returns theActionDefinitionincluding all action information like additional Properties (e.g. documentation). The latest version for the given key will be returned.
-
getActionDefinitionLinks
java.util.List<ActionDefinitionLink> getActionDefinitionLinks(java.lang.String actionDefinitionId)
ReturnsActionDefinitionLinks for the given action definition id.
-
addActionDefinitionLink
ActionDefinitionLink addActionDefinitionLink(java.lang.String actionDefinitionId, java.lang.String type, java.lang.String linkValue)
Adds a newActionDefinitionLinkfor the given action definition id.
-
deleteActionDefinitionLink
void deleteActionDefinitionLink(java.lang.String actionDefinitionLinkId)
Deletes anActionDefinitionLinkfor the given action definition link id.
-
deleteDeployment
void deleteDeployment(java.lang.String deploymentId)
Deletes the given deployment.- Parameters:
deploymentId- id of the deployment, cannot be null.
-
createDeploymentQuery
ActionDeploymentQuery createDeploymentQuery()
Query deployments
-
createActionDefinitionQuery
ActionDefinitionQuery createActionDefinitionQuery()
Query case definitions
-
-