Package com.flowable.dataobject.api.repository

Interface DataObjectRepositoryService

  • All Known Implementing Classes:
    DataObjectRepositoryServiceImpl
    public interface DataObjectRepositoryService
    The main service interface for the master data management.
    Author:
    Micha Kiener

    • Method Detail

      • 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.

      • createDataObjectDefinitionQuery

        DataObjectDefinitionQuery createDataObjectDefinitionQuery()
        Returns a new data object definition query instance to be used when searching for data object definitions.
        Returns:
        the query instance used to specify the data object definition query terms

      • getDataObjectDefinition

        DataObjectDefinition getDataObjectDefinition​(java.lang.String dataObjectDefinitionId)
        Returns the specified data object definition given by its id.
        Parameters:
        dataObjectDefinitionId - the id of the data objectdefinition
        Returns:
        the data object definition given by its id or null if not found

      • getDataObjectDefinitionByKey

        DataObjectDefinition getDataObjectDefinitionByKey​(java.lang.String dataObjectDefinitionKey)

      • getDataObjectDefinitionByKeyAndTenantId

        DataObjectDefinition getDataObjectDefinitionByKeyAndTenantId​(java.lang.String dataObjectDefinitionKey,
                                                             java.lang.String tenantId)

      • getDataObjectModel

        DataObjectModel getDataObjectModel​(java.lang.String dataObjectDefinitionId)

      • getDataObjectModelByKey

        DataObjectModel getDataObjectModelByKey​(java.lang.String dataObjectDefinitionKey)

      • getDataObjectModelByKeyAndTenantId

        DataObjectModel getDataObjectModelByKeyAndTenantId​(java.lang.String dataObjectDefinitionKey,
                                                   java.lang.String tenantId)

      • convertDataObjectModelToJson

        java.lang.String convertDataObjectModelToJson​(java.lang.String dataObjectDefinitionId)

      • performDataObjectSchemaDefinitionUpdate

        void performDataObjectSchemaDefinitionUpdate​(java.lang.String dataObjectSchemaDefinitionId)
        Perform the update for the schema definition with the given id.
        Parameters:
        dataObjectSchemaDefinitionId - the id of the data object schema definition for which the update should be done

      • performDataObjectSchemaDefinitionRollback

        void performDataObjectSchemaDefinitionRollback​(java.lang.String dataObjectSchemaDefinitionId)
        Perform the rollback for the schema definition with the given id.
        Parameters:
        dataObjectSchemaDefinitionId - the id of the data object schema definition for which the rollback should be done

      • getMasterDataModel

        MasterDataModel getMasterDataModel​(java.lang.String dataObjectDefinitionId)
        Returns the master data model for the given master data definition id containing the meta information for that master data type.
        Parameters:
        dataObjectDefinitionId - the id of the master data definition to return its model
        Returns:
        the master data model requested

      • deleteDeployment

        void deleteDeployment​(java.lang.String deploymentId)
        Deletes the given deployment.
        Parameters:
        deploymentId - id of the deployment, cannot be null.