CMISAbstractTypeDefinition (Alfresco Repository 5.0.a API)

java.lang.Object
- org.alfresco.cmis.dictionary.CMISAbstractTypeDefinition

All Implemented Interfaces:

Serializable, CMISTypeDefinition

Direct Known Subclasses:

CMISDocumentTypeDefinition, CMISFolderTypeDefinition, CMISObjectTypeDefinition, CMISPolicyTypeDefinition, CMISRelationshipTypeDefinition
```
public abstract class CMISAbstractTypeDefinition
extends Object
implements CMISTypeDefinition, Serializable
```
CMIS Object Type Definition

Author:

davidc

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<CMISAllowedActionEnum,CMISActionEvaluator<? extends Object>>`	`actionEvaluators`
`protected org.alfresco.service.cmr.dictionary.ClassDefinition`	`cmisClassDef`
`protected Boolean`	`controllableACL`
`protected Boolean`	`controllablePolicy`
`protected Boolean`	`creatable`
`protected String`	`description`
`protected String`	`displayName`
`protected Boolean`	`fullTextIndexed`
`protected Boolean`	`includedInSuperTypeQuery`
`protected Map<String,CMISPropertyDefinition>`	`inheritedProperties`
`protected CMISAbstractTypeDefinition`	`internalParentType`
`protected Boolean`	`isPublic`
`protected static org.apache.commons.logging.Log`	`logger`
`protected CMISTypeId`	`objectTypeId`
`protected String`	`objectTypeQueryName`
`protected Map<String,CMISPropertyDefinition>`	`ownedProperties`
`protected CMISTypeDefinition`	`parentType`
`protected CMISTypeId`	`parentTypeId`
`protected Map<String,CMISPropertyDefinition>`	`properties`
`protected Boolean`	`queryable`
`protected CMISTypeDefinition`	`rootType`
`protected Collection<CMISTypeId>`	`subTypeIds`
`protected Collection<CMISTypeDefinition>`	`subTypes`

Constructor Summary

Constructors
Constructor and Description

CMISAbstractTypeDefinition()

Constructors
Constructor and Description
`CMISAbstractTypeDefinition()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`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.
`CMISAbstractTypeDefinition`	`getInternalParentType()` Get internal parent 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 includeDescendants)` Get the sub-types
`CMISTypeId`	`getTypeId()` Get the unique identifier for the type
`int`	`hashCode()`
`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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected static final org.apache.commons.logging.Log logger
```
  - isPublic
```
protected Boolean isPublic
```
  - cmisClassDef
```
protected org.alfresco.service.cmr.dictionary.ClassDefinition cmisClassDef
```
  - objectTypeId
```
protected CMISTypeId objectTypeId
```
  - objectTypeQueryName
```
protected String objectTypeQueryName
```
  - displayName
```
protected String displayName
```
  - parentTypeId
```
protected CMISTypeId parentTypeId
```
  - parentType
```
protected CMISTypeDefinition parentType
```
  - internalParentType
```
protected CMISAbstractTypeDefinition internalParentType
```
  - rootType
```
protected CMISTypeDefinition rootType
```
  - description
```
protected String description
```
  - creatable
```
protected Boolean creatable
```
  - queryable
```
protected Boolean queryable
```
  - fullTextIndexed
```
protected Boolean fullTextIndexed
```
  - controllablePolicy
```
protected Boolean controllablePolicy
```
  - controllableACL
```
protected Boolean controllableACL
```
  - includedInSuperTypeQuery
```
protected Boolean includedInSuperTypeQuery
```
  - subTypeIds
```
protected Collection<CMISTypeId> subTypeIds
```
  - subTypes
```
protected Collection<CMISTypeDefinition> subTypes
```
  - properties
```
protected Map<String,CMISPropertyDefinition> properties
```
  - inheritedProperties
```
protected Map<String,CMISPropertyDefinition> inheritedProperties
```
  - ownedProperties
```
protected Map<String,CMISPropertyDefinition> ownedProperties
```
  - actionEvaluators
```
protected Map<CMISAllowedActionEnum,CMISActionEvaluator<? extends Object>> actionEvaluators
```
- Constructor Detail
  - CMISAbstractTypeDefinition
```
public CMISAbstractTypeDefinition()
```
- Method Detail
  - getInternalParentType
```
public CMISAbstractTypeDefinition getInternalParentType()
```
    Get internal parent type
    
    Returns:
  - isPublic
```
public boolean isPublic()
```
    Specified by:
    
    isPublic in interface CMISTypeDefinition
    
    Returns:
    true => type definition is for public consumption
  - getTypeId
```
public CMISTypeId getTypeId()
```
    Description copied from interface: CMISTypeDefinition
    
    Get the unique identifier for the type
    
    Specified by:
    
    getTypeId in interface CMISTypeDefinition
    
    Returns:
    - the type id
  - getQueryName
```
public String getQueryName()
```
    Description copied from interface: CMISTypeDefinition
    
    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?
    
    Specified by:
    
    getQueryName in interface CMISTypeDefinition
    
    Returns:
    the sql table name
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: CMISTypeDefinition
    
    Get the display name for the type.
    
    Specified by:
    
    getDisplayName in interface CMISTypeDefinition
    
    Returns:
    - the display name
  - getParentType
```
public CMISTypeDefinition getParentType()
```
    Description copied from interface: CMISTypeDefinition
    
    Get the type for the parent
    
    Specified by:
    
    getParentType in interface CMISTypeDefinition
    
    Returns:
    - the parent type id
  - getBaseType
```
public CMISTypeDefinition getBaseType()
```
    Description copied from interface: CMISTypeDefinition
    
    Get the base type
    
    Specified by:
    
    getBaseType in interface CMISTypeDefinition
    
    Returns:
  - getSubTypes
```
public Collection<CMISTypeDefinition> getSubTypes(boolean includeDescendants)
```
    Description copied from interface: CMISTypeDefinition
    
    Get the sub-types
    
    Specified by:
    
    getSubTypes in interface CMISTypeDefinition
    
    Returns:
  - getDescription
```
public String getDescription()
```
    Description copied from interface: CMISTypeDefinition
    
    Get the description for the type
    
    Specified by:
    
    getDescription in interface CMISTypeDefinition
    
    Returns:
    - the description
  - isCreatable
```
public boolean isCreatable()
```
    Description copied from interface: CMISTypeDefinition
    
    Can objects of this type be created?
    
    Specified by:
    
    isCreatable in interface CMISTypeDefinition
    
    Returns:
  - isQueryable
```
public boolean isQueryable()
```
    Description copied from interface: CMISTypeDefinition
    
    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.
    
    Specified by:
    
    isQueryable in interface CMISTypeDefinition
    
    Returns:
    true if queryable
  - isFullTextIndexed
```
public boolean isFullTextIndexed()
```
    Description copied from interface: CMISTypeDefinition
    
    Is the type full text indexed for querying via CONTAINS()
    
    Specified by:
    
    isFullTextIndexed in interface CMISTypeDefinition
    
    Returns:
  - isControllablePolicy
```
public boolean isControllablePolicy()
```
    Description copied from interface: CMISTypeDefinition
    
    Are objects of this type controllable via Policies.
    
    Specified by:
    
    isControllablePolicy in interface CMISTypeDefinition
    
    Returns:
  - isControllableACL
```
public boolean isControllableACL()
```
    Description copied from interface: CMISTypeDefinition
    
    Are objects of this type controllable via ACLs.
    
    Specified by:
    
    isControllableACL in interface CMISTypeDefinition
    
    Returns:
  - isIncludedInSuperTypeQuery
```
public boolean isIncludedInSuperTypeQuery()
```
    Description copied from interface: CMISTypeDefinition
    
    Are objects of this type included in super type queries
    
    Specified by:
    
    isIncludedInSuperTypeQuery in interface CMISTypeDefinition
    
    Returns:
  - getPropertyDefinitions
```
public Map<String,CMISPropertyDefinition> getPropertyDefinitions()
```
    Description copied from interface: CMISTypeDefinition
    
    Gets the property definitions for this type (owned and inherited)
    
    Specified by:
    
    getPropertyDefinitions in interface CMISTypeDefinition
    
    Returns:
    property definitions
  - getOwnedPropertyDefinitions
```
public Map<String,CMISPropertyDefinition> getOwnedPropertyDefinitions()
```
    Description copied from interface: CMISTypeDefinition
    
    Gets the property definitions owned by this type
    
    Specified by:
    
    getOwnedPropertyDefinitions in interface CMISTypeDefinition
    
    Returns:
  - getActionEvaluators
```
public Map<CMISAllowedActionEnum,CMISActionEvaluator<? extends Object>> getActionEvaluators()
```
    Description copied from interface: CMISTypeDefinition
    
    Gets the Action evaluators for this type
    
    Specified by:
    
    getActionEvaluators in interface CMISTypeDefinition
    
    Returns:
  - isFileable
```
public boolean isFileable()
```
    Description copied from interface: CMISTypeDefinition
    
    Are objects of this type fileable?
    
    Specified by:
    
    isFileable in interface CMISTypeDefinition
    
    Returns:
  - isVersionable
```
public boolean isVersionable()
```
    Description copied from interface: CMISTypeDefinition
    
    Is this type versionable? If true this implies all instances of the type are versionable.
    
    Specified by:
    
    isVersionable in interface CMISTypeDefinition
    
    Returns:
    true if versionable
  - getContentStreamAllowed
```
public CMISContentStreamAllowedEnum getContentStreamAllowed()
```
    Description copied from interface: CMISTypeDefinition
    
    Is a content stream allowed for this type? It may be disallowed, optional or mandatory.
    
    Specified by:
    
    getContentStreamAllowed in interface CMISTypeDefinition
    
    Returns:
  - getAllowedSourceTypes
```
public Collection<CMISTypeDefinition> getAllowedSourceTypes()
```
    Description copied from interface: CMISTypeDefinition
    
    For an association, get the collection of valid source types. For non-associations the collection will be empty.
    
    Specified by:
    
    getAllowedSourceTypes in interface CMISTypeDefinition
    
    Returns:
  - getAllowedTargetTypes
```
public Collection<CMISTypeDefinition> getAllowedTargetTypes()
```
    Description copied from interface: CMISTypeDefinition
    
    For an association, get the collection of valid target types. For non-associations the collection will be empty.
    
    Specified by:
    
    getAllowedTargetTypes in interface CMISTypeDefinition
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class CMISAbstractTypeDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

isPublic

cmisClassDef

objectTypeId

objectTypeQueryName

displayName

parentTypeId

parentType

internalParentType

rootType

description

creatable

queryable

fullTextIndexed

controllablePolicy

controllableACL

includedInSuperTypeQuery

subTypeIds

subTypes

properties

inheritedProperties

ownedProperties

actionEvaluators

Constructor Detail

CMISAbstractTypeDefinition

Method Detail

getInternalParentType

isPublic

getTypeId

getQueryName

getDisplayName

getParentType

getBaseType

getSubTypes

getDescription

isCreatable

isQueryable

isFullTextIndexed

isControllablePolicy

isControllableACL

isIncludedInSuperTypeQuery

getPropertyDefinitions

getOwnedPropertyDefinitions

getActionEvaluators

isFileable

isVersionable

getContentStreamAllowed

getAllowedSourceTypes

getAllowedTargetTypes

hashCode

equals