org.alfresco.cmis

Interface CMISTypeDefinition

All Known Implementing Classes:

CMISAbstractTypeDefinition, CMISDocumentTypeDefinition, CMISFolderTypeDefinition, CMISObjectTypeDefinition, CMISPolicyTypeDefinition, CMISRelationshipTypeDefinition

public interface CMISTypeDefinition

The base type definition for CMIS

Author:

andyh

Method Summary

Methods

Modifier and Type	Method and Description
Map<CMISAllowedActionEnum,CMISActionEvaluator<? extends Object>>	getActionEvaluators() Gets the Action evaluators for this type
Collection<CMISTypeDefinition>	getAllowedSourceTypes() For an association, get the collection of valid source types.
Collection<CMISTypeDefinition>	getAllowedTargetTypes() For an association, get the collection of valid target types.
CMISTypeDefinition	getBaseType() Get the base type
CMISContentStreamAllowedEnum	getContentStreamAllowed() Is a content stream allowed for this type? It may be disallowed, optional or mandatory.
String	getDescription() Get the description for the type
String	getDisplayName() Get the display name for the type.
Map<String,CMISPropertyDefinition>	getOwnedPropertyDefinitions() Gets the property definitions owned by this type
CMISTypeDefinition	getParentType() Get the type for the parent
Map<String,CMISPropertyDefinition>	getPropertyDefinitions() Gets the property definitions for this type (owned and inherited)
String	getQueryName() Get the table name used for queries against the type.
Collection<CMISTypeDefinition>	getSubTypes(boolean descendants) Get the sub-types
CMISTypeId	getTypeId() Get the unique identifier for the type
boolean	isControllableACL() Are objects of this type controllable via ACLs.
boolean	isControllablePolicy() Are objects of this type controllable via Policies.
boolean	isCreatable() Can objects of this type be created?
boolean	isFileable() Are objects of this type fileable?
boolean	isFullTextIndexed() Is the type full text indexed for querying via CONTAINS()
boolean	isIncludedInSuperTypeQuery() Are objects of this type included in super type queries
boolean	isPublic()
boolean	isQueryable() Is this type queryable? If not, the type may not appear in the FROM clause of a query.
boolean	isVersionable() Is this type versionable? If true this implies all instances of the type are versionable.

Method Detail

isPublic

boolean isPublic()

Returns:

true => type definition is for public consumption

getTypeId

CMISTypeId getTypeId()

Get the unique identifier for the type

Returns:

- the type id

getQueryName

String getQueryName()

Get the table name used for queries against the type. This is also a unique identifier for the type. The string conforms to SQL table naming conventions. TODO: Should we impose a maximum length and if so how do we avoid collisions from truncations?

Returns:

the sql table name

getDisplayName

String getDisplayName()

Get the display name for the type.

Returns:

- the display name

getParentType

CMISTypeDefinition getParentType()

Get the type for the parent

Returns:

- the parent type id

getSubTypes

Collection<CMISTypeDefinition> getSubTypes(boolean descendants)

Get the sub-types

Parameters:

descendants -

Returns:

getBaseType

CMISTypeDefinition getBaseType()

Get the base type

Returns:

getDescription

String getDescription()

Get the description for the type

Returns:

- the description

isCreatable

boolean isCreatable()

Can objects of this type be created?

Returns:

isFileable

boolean isFileable()

Are objects of this type fileable?

Returns:

isQueryable

boolean isQueryable()

Is this type queryable? If not, the type may not appear in the FROM clause of a query. This property of the type is not inherited in the type hierarchy. It is set on each type.

Returns:

true if queryable

isFullTextIndexed

boolean isFullTextIndexed()

Is the type full text indexed for querying via CONTAINS()

Returns:

isControllablePolicy

boolean isControllablePolicy()

Are objects of this type controllable via Policies.

Returns:

isControllableACL

boolean isControllableACL()

Are objects of this type controllable via ACLs.

Returns:

isIncludedInSuperTypeQuery

boolean isIncludedInSuperTypeQuery()

Are objects of this type included in super type queries

Returns:

isVersionable

boolean isVersionable()

Is this type versionable? If true this implies all instances of the type are versionable.

Returns:

true if versionable

getContentStreamAllowed

CMISContentStreamAllowedEnum getContentStreamAllowed()

Is a content stream allowed for this type? It may be disallowed, optional or mandatory.

Returns:

getAllowedSourceTypes

Collection<CMISTypeDefinition> getAllowedSourceTypes()

For an association, get the collection of valid source types. For non-associations the collection will be empty.

Returns:

getAllowedTargetTypes

Collection<CMISTypeDefinition> getAllowedTargetTypes()

For an association, get the collection of valid target types. For non-associations the collection will be empty.

Returns:

getPropertyDefinitions

Map<String,CMISPropertyDefinition> getPropertyDefinitions()

Gets the property definitions for this type (owned and inherited)

Returns:

property definitions

getOwnedPropertyDefinitions

Map<String,CMISPropertyDefinition> getOwnedPropertyDefinitions()

Gets the property definitions owned by this type

Returns:

getActionEvaluators

Map<CMISAllowedActionEnum,CMISActionEvaluator<? extends Object>> getActionEvaluators()

Gets the Action evaluators for this type

Returns: