org.apache.chemistry.opencmis.commons.spi

Interface RepositoryService

All Known Subinterfaces:

CallContextAwareCmisService, CmisService, ProgressControlCmisService

All Known Implementing Classes:

AbstractBindingCmisServiceWrapper, AbstractCmisService, AbstractCmisServiceWrapper, CachedBindingCmisService, ConformanceCmisServiceWrapper, FilterCmisService, HttpSessionCmisService, LruCacheCmisService, SimpleForwardingCmisService, SimpleLoggingCmisServiceWrapper

public interface RepositoryService

Repository Service interface.

See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations, parameters, exceptions and the domain model.

Method Summary

Modifier and Type	Method and Description
TypeDefinition	createType(String repositoryId, TypeDefinition type, ExtensionsData extension) Creates a new type.
void	deleteType(String repositoryId, String typeId, ExtensionsData extension) Deletes a type.
RepositoryInfo	getRepositoryInfo(String repositoryId, ExtensionsData extension) Returns information about the CMIS repository, the optional capabilities it supports and its access control information if applicable.
List<RepositoryInfo>	getRepositoryInfos(ExtensionsData extension) Returns a list of CMIS repository information available from this CMIS service endpoint.
TypeDefinitionList	getTypeChildren(String repositoryId, String typeId, Boolean includePropertyDefinitions, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension) Returns the list of object types defined for the repository that are children of the specified type.
TypeDefinition	getTypeDefinition(String repositoryId, String typeId, ExtensionsData extension) Gets the definition of the specified object type.
List<TypeDefinitionContainer>	getTypeDescendants(String repositoryId, String typeId, BigInteger depth, Boolean includePropertyDefinitions, ExtensionsData extension) Returns the set of descendant object type defined for the repository under the specified type.
TypeDefinition	updateType(String repositoryId, TypeDefinition type, ExtensionsData extension) Updates a type.

Method Detail

getRepositoryInfos

List<RepositoryInfo> getRepositoryInfos(ExtensionsData extension)

Returns a list of CMIS repository information available from this CMIS service endpoint. In contrast to the CMIS specification this method returns repository infos not only repository IDs.

Parameters:

extension - extension data

Returns:

the list of repositories

getRepositoryInfo

RepositoryInfo getRepositoryInfo(String repositoryId,
                                 ExtensionsData extension)

Returns information about the CMIS repository, the optional capabilities it supports and its access control information if applicable.

Parameters:

repositoryId - the identifier for the repository

extension - extension data

Returns:

the repository info

getTypeChildren

TypeDefinitionList getTypeChildren(String repositoryId,
                                   String typeId,
                                   Boolean includePropertyDefinitions,
                                   BigInteger maxItems,
                                   BigInteger skipCount,
                                   ExtensionsData extension)

Returns the list of object types defined for the repository that are children of the specified type.

Parameters:

repositoryId - the identifier for the repository

typeId - (optional) the typeId of an object type specified in the repository (if not specified the repository MUST return all base object types)

includePropertyDefinitions - (optional) if true the repository MUST return the property definitions for each object type returned (default is false)

maxItems - (optional) the maximum number of items to return in a response (default is repository specific)

skipCount - (optional) number of potential results that the repository MUST skip/page over before returning any results (default is 0)

extension - extension data

Returns:

the list of type children

getTypeDescendants

List<TypeDefinitionContainer> getTypeDescendants(String repositoryId,
                                                 String typeId,
                                                 BigInteger depth,
                                                 Boolean includePropertyDefinitions,
                                                 ExtensionsData extension)

Returns the set of descendant object type defined for the repository under the specified type.

Parameters:

repositoryId - the identifier for the repository

typeId - (optional) the typeId of an object type specified in the repository (if not specified the repository MUST return all types and MUST ignore the value of the depth parameter)

depth - (optional) the number of levels of depth in the type hierarchy from which to return results (default is repository specific)

includePropertyDefinitions - (optional) if true the repository MUST return the property definitions for each object type returned (default is false)

extension - extension data

Returns:

the tree of type descendants

getTypeDefinition

TypeDefinition getTypeDefinition(String repositoryId,
                                 String typeId,
                                 ExtensionsData extension)

Gets the definition of the specified object type.

Parameters:

repositoryId - the identifier for the repository

typeId - typeId of an object type specified in the repository

extension - extension data

Returns:

the type definition

createType

TypeDefinition createType(String repositoryId,
                          TypeDefinition type,
                          ExtensionsData extension)

Creates a new type.

Parameters:

repositoryId - the identifier for the repository

type - the type definition

extension - extension data

Returns:

the newly created type

updateType

TypeDefinition updateType(String repositoryId,
                          TypeDefinition type,
                          ExtensionsData extension)

Updates a type.

Parameters:

repositoryId - the identifier for the repository

type - the type definition

extension - extension data

Returns:

the updated type

deleteType

void deleteType(String repositoryId,
                String typeId,
                ExtensionsData extension)

Deletes a type.

Parameters:

repositoryId - the identifier for the repository

typeId - typeId of an object type specified in the repository

extension - extension data