org.apache.chemistry.opencmis.commons.definitions
Interface TypeDefinition

All Superinterfaces:
ExtensionsData, Serializable
All Known Subinterfaces:
DocumentType, DocumentTypeDefinition, FolderType, FolderTypeDefinition, ObjectType, PolicyType, PolicyTypeDefinition, RelationshipType, RelationshipTypeDefinition

public interface TypeDefinition
extends Serializable, ExtensionsData

Base type definition interface.

Author:
Florian Müller

Method Summary
 BaseTypeId getBaseTypeId()
          Returns the base object type id.
 String getDescription()
          Returns the property description.
 String getDisplayName()
          Returns the display name.
 String getId()
          Returns the type id.
 String getLocalName()
          Returns the local name.
 String getLocalNamespace()
          Returns the local namespace.
 String getParentTypeId()
          Returns the parent type id.
 Map<String,PropertyDefinition<?>> getPropertyDefinitions()
          Returns the property definitions of this type.
 String getQueryName()
          Returns the query name
 Boolean isControllableAcl()
          Returns if objects of this type are controllable by ACLs.
 Boolean isControllablePolicy()
          Returns if objects of this type are controllable by policies.
 Boolean isCreatable()
          Returns if an object of this type can be created.
 Boolean isFileable()
          Returns if an object of this type can be filed.
 Boolean isFulltextIndexed()
          Returns if this type is full text indexed.
 Boolean isIncludedInSupertypeQuery()
          Returns if this type is included in queries that query the super type.
 Boolean isQueryable()
          Returns if this type is queryable.
 
Methods inherited from interface org.apache.chemistry.opencmis.commons.data.ExtensionsData
getExtensions, setExtensions
 

Method Detail

getId

String getId()
Returns the type id.

Returns:
the type id

getLocalName

String getLocalName()
Returns the local name.

Returns:
the local name

getLocalNamespace

String getLocalNamespace()
Returns the local namespace.

Returns:
the local namespace

getDisplayName

String getDisplayName()
Returns the display name.

Returns:
the display name

getQueryName

String getQueryName()
Returns the query name

Returns:
the query name

getDescription

String getDescription()
Returns the property description.

Returns:
returns the description

getBaseTypeId

BaseTypeId getBaseTypeId()
Returns the base object type id.

Returns:
the base object type id

getParentTypeId

String getParentTypeId()
Returns the parent type id.

Returns:
the parent type id or null if the type is a base type

isCreatable

Boolean isCreatable()
Returns if an object of this type can be created.

Returns:
true if an object of this type can be created; false if creation of objects of this type is not possible; null - unknown (noncompliant repository)

isFileable

Boolean isFileable()
Returns if an object of this type can be filed.

Returns:
true if an object of this type can be filed; false if an object of this type cannot be filed; null - unknown (noncompliant repository)

isQueryable

Boolean isQueryable()
Returns if this type is queryable.

Returns:
true if this type is queryable; false if this type is not queryable; null - unknown (noncompliant repository)

isFulltextIndexed

Boolean isFulltextIndexed()
Returns if this type is full text indexed.

Returns:
true if this type is full text indexed; false if this type is not full text indexed; null - unknown (noncompliant repository)

isIncludedInSupertypeQuery

Boolean isIncludedInSupertypeQuery()
Returns if this type is included in queries that query the super type.

Returns:
true if this type is included; false if this type is not included; null - unknown (noncompliant repository)

isControllablePolicy

Boolean isControllablePolicy()
Returns if objects of this type are controllable by policies.

Returns:
true if objects are controllable by policies; false if objects are not controllable by policies; null - unknown (noncompliant repository)

isControllableAcl

Boolean isControllableAcl()
Returns if objects of this type are controllable by ACLs.

Returns:
true if objects are controllable by ACLs; false if objects are not controllable by ACLs; null - unknown (noncompliant repository)

getPropertyDefinitions

Map<String,PropertyDefinition<?>> getPropertyDefinitions()
Returns the property definitions of this type.

Returns:
the property definitions or null if the property definitions were not requested


Copyright © 2009-2011 The Apache Software Foundation. All Rights Reserved.