com.flowable.dataobject.api.repository

Interface DataObjectDefinition

All Known Subinterfaces:

DataObjectDefinitionEntity

All Known Implementing Classes:

DataObjectDefinitionEntityImpl

public interface DataObjectDefinition

The definition describing a data object.

Author:

Micha Kiener

Method Summary

Modifier and Type	Method and Description
Date	getCreationTime() Returns the creation timestamp of this data object.
String	getCreatorId() Returns the id of the user creating this data object.
String	getDeploymentId()
String	getExternalId() Returns the external id for this data object definition.
String	getId() Returns the unique, technical id for this data object definition.
String	getKey() Returns the key for this data object definition which must be unique, but is human-readable normally and must be the same across environments for the same data object definition.
String	getName() Returns the name of this data object definition which is usually used as the label.
String	getResourceName()
String	getSourceId() Returns the id of the source for this data object definition.
String	getSourceType() Returns the type of the source for this data object definition.
String	getSubType() The sub type further categorizes this master data definition (see type for more information and examples).
String	getTenantId()
String	getType() The type of this data object definition, normally used to kind of categorize data object definitions (e.g.
int	getVersion()

Method Detail

getId

String getId()

Returns the unique, technical id for this data object definition. This id will be different from environment to environment.

Returns:

the id of this data object definition

getKey

String getKey()

Returns the key for this data object definition which must be unique, but is human-readable normally and must be the same across environments for the same data object definition.

Returns:

the key for this data object definition

getVersion

int getVersion()

getDeploymentId

String getDeploymentId()

getResourceName

String getResourceName()

getName

String getName()

Returns the name of this data object definition which is usually used as the label.

Returns:

the name of this data object definition

getType

String getType()

The type of this data object definition, normally used to kind of categorize data object definitions (e.g. the type might be 'masterData' and the sub type might then reflect another sub type of master data like 'internal' or 'SAP' or whatever makes sense for categorization.

Returns:

the type of this master data definition

getSubType

String getSubType()

The sub type further categorizes this master data definition (see type for more information and examples).

Returns:

the sub type of this master data description

getExternalId

String getExternalId()

Returns the external id for this data object definition.

getSourceId

String getSourceId()

Returns the id of the source for this data object definition.

getSourceType

String getSourceType()

Returns the type of the source for this data object definition.

Returns:

the type of the source supporting this data objects

See Also:

for a list of supported source types

getCreationTime

Date getCreationTime()

Returns the creation timestamp of this data object.

Returns:

the creation timestamp

getCreatorId

String getCreatorId()

Returns the id of the user creating this data object.

Returns:

the id of the creation user

getTenantId

String getTenantId()