org.apache.chemistry.opencmis.commons.spi
Interface NavigationService

All Known Subinterfaces:
CmisService
All Known Implementing Classes:
CmisServiceWrapper

public interface NavigationService

Navigation Service interface.

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


Method Summary
 ObjectList getCheckedOutDocs(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
          Gets the list of documents that are checked out that the user has access to.
 ObjectInFolderList getChildren(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
          Gets the list of child objects contained in the specified folder.
 List<ObjectInFolderContainer> getDescendants(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, ExtensionsData extension)
          Gets the set of descendant objects contained in the specified folder or any of its child folders.
 ObjectData getFolderParent(String repositoryId, String folderId, String filter, ExtensionsData extension)
          Gets the parent folder object for the specified folder object.
 List<ObjectInFolderContainer> getFolderTree(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, ExtensionsData extension)
          Gets the set of descendant folder objects contained in the specified folder.
 List<ObjectParentData> getObjectParents(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includeRelativePathSegment, ExtensionsData extension)
          Gets the parent folder(s) for the specified non-folder, fileable object.
 

Method Detail

getChildren

ObjectInFolderList getChildren(String repositoryId,
                               String folderId,
                               String filter,
                               String orderBy,
                               Boolean includeAllowableActions,
                               IncludeRelationships includeRelationships,
                               String renditionFilter,
                               Boolean includePathSegment,
                               BigInteger maxItems,
                               BigInteger skipCount,
                               ExtensionsData extension)
Gets the list of child objects contained in the specified folder.

Parameters:
repositoryId - the identifier for the repository
folderId - the identifier for the folder
filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)
orderBy - (optional) a comma-separated list of query names that define the order of the result set. Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC" (default is repository specific)
includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)
includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)
renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")
includePathSegment - (optional) if true, returns a path segment for each child object for use in constructing that object's path (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)

getDescendants

List<ObjectInFolderContainer> getDescendants(String repositoryId,
                                             String folderId,
                                             BigInteger depth,
                                             String filter,
                                             Boolean includeAllowableActions,
                                             IncludeRelationships includeRelationships,
                                             String renditionFilter,
                                             Boolean includePathSegment,
                                             ExtensionsData extension)
Gets the set of descendant objects contained in the specified folder or any of its child folders.

Parameters:
repositoryId - the identifier for the repository
folderId - the identifier for the folder
depth - the number of levels of depth in the folder hierarchy from which to return results
filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)
includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)
includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)
renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")
includePathSegment - (optional) if true, returns a path segment for each child object for use in constructing that object's path (default is false)

getFolderTree

List<ObjectInFolderContainer> getFolderTree(String repositoryId,
                                            String folderId,
                                            BigInteger depth,
                                            String filter,
                                            Boolean includeAllowableActions,
                                            IncludeRelationships includeRelationships,
                                            String renditionFilter,
                                            Boolean includePathSegment,
                                            ExtensionsData extension)
Gets the set of descendant folder objects contained in the specified folder.

Parameters:
repositoryId - the identifier for the repository
folderId - the identifier for the folder
depth - the number of levels of depth in the folder hierarchy from which to return results
filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)
includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)
includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)
renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")
includePathSegment - (optional) if true, returns a path segment for each child object for use in constructing that object's path (default is false)

getObjectParents

List<ObjectParentData> getObjectParents(String repositoryId,
                                        String objectId,
                                        String filter,
                                        Boolean includeAllowableActions,
                                        IncludeRelationships includeRelationships,
                                        String renditionFilter,
                                        Boolean includeRelativePathSegment,
                                        ExtensionsData extension)
Gets the parent folder(s) for the specified non-folder, fileable object.

Parameters:
repositoryId - the identifier for the repository
objectId - the identifier for the object
filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)
includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)
includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)
renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")
includeRelativePathSegment - (optional) if true, returns a relative path segment for each parent object for use in constructing that object's path (default is false)

getFolderParent

ObjectData getFolderParent(String repositoryId,
                           String folderId,
                           String filter,
                           ExtensionsData extension)
Gets the parent folder object for the specified folder object.

Parameters:
repositoryId - the identifier for the repository
folderId - the identifier for the folder
filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

getCheckedOutDocs

ObjectList getCheckedOutDocs(String repositoryId,
                             String folderId,
                             String filter,
                             String orderBy,
                             Boolean includeAllowableActions,
                             IncludeRelationships includeRelationships,
                             String renditionFilter,
                             BigInteger maxItems,
                             BigInteger skipCount,
                             ExtensionsData extension)
Gets the list of documents that are checked out that the user has access to.

Parameters:
repositoryId - the identifier for the repository
folderId - the identifier for the folder
filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)
orderBy - (optional) a comma-separated list of query names that define the order of the result set. Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC" (default is repository specific)
includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)
includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)
renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")
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)


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