org.apache.chemistry.opencmis.client.bindings.spi.webservices
Class NavigationServiceImpl

java.lang.Object
  extended by org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractWebServicesService
      extended by org.apache.chemistry.opencmis.client.bindings.spi.webservices.NavigationServiceImpl
All Implemented Interfaces:
NavigationService

public class NavigationServiceImpl
extends AbstractWebServicesService
implements NavigationService

Navigation Service Web Services client.


Constructor Summary
NavigationServiceImpl(BindingSession session, AbstractPortProvider portProvider)
          Constructor.
 
Method Summary
 ObjectList getCheckedOutDocs(java.lang.String repositoryId, java.lang.String folderId, java.lang.String filter, java.lang.String orderBy, java.lang.Boolean includeAllowableActions, IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount, ExtensionsData extension)
          Gets the list of documents that are checked out that the user has access to.
 ObjectInFolderList getChildren(java.lang.String repositoryId, java.lang.String folderId, java.lang.String filter, java.lang.String orderBy, java.lang.Boolean includeAllowableActions, IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includePathSegment, java.math.BigInteger maxItems, java.math.BigInteger skipCount, ExtensionsData extension)
          Gets the list of child objects contained in the specified folder.
 java.util.List<ObjectInFolderContainer> getDescendants(java.lang.String repositoryId, java.lang.String folderId, java.math.BigInteger depth, java.lang.String filter, java.lang.Boolean includeAllowableActions, IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includePathSegment, ExtensionsData extension)
          Gets the set of descendant objects contained in the specified folder or any of its child folders.
 ObjectData getFolderParent(java.lang.String repositoryId, java.lang.String folderId, java.lang.String filter, ExtensionsData extension)
          Gets the parent folder object for the specified folder object.
 java.util.List<ObjectInFolderContainer> getFolderTree(java.lang.String repositoryId, java.lang.String folderId, java.math.BigInteger depth, java.lang.String filter, java.lang.Boolean includeAllowableActions, IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includePathSegment, ExtensionsData extension)
          Gets the set of descendant folder objects contained in the specified folder.
 java.util.List<ObjectParentData> getObjectParents(java.lang.String repositoryId, java.lang.String objectId, java.lang.String filter, java.lang.Boolean includeAllowableActions, IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includeRelativePathSegment, ExtensionsData extension)
          Gets the parent folder(s) for the specified non-folder, fileable object.
 
Methods inherited from class org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractWebServicesService
convertException, getSession, setSession
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NavigationServiceImpl

public NavigationServiceImpl(BindingSession session,
                             AbstractPortProvider portProvider)
Constructor.

Method Detail

getChildren

public ObjectInFolderList getChildren(java.lang.String repositoryId,
                                      java.lang.String folderId,
                                      java.lang.String filter,
                                      java.lang.String orderBy,
                                      java.lang.Boolean includeAllowableActions,
                                      IncludeRelationships includeRelationships,
                                      java.lang.String renditionFilter,
                                      java.lang.Boolean includePathSegment,
                                      java.math.BigInteger maxItems,
                                      java.math.BigInteger skipCount,
                                      ExtensionsData extension)
Description copied from interface: NavigationService
Gets the list of child objects contained in the specified folder.

Specified by:
getChildren in interface NavigationService
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

public java.util.List<ObjectInFolderContainer> getDescendants(java.lang.String repositoryId,
                                                              java.lang.String folderId,
                                                              java.math.BigInteger depth,
                                                              java.lang.String filter,
                                                              java.lang.Boolean includeAllowableActions,
                                                              IncludeRelationships includeRelationships,
                                                              java.lang.String renditionFilter,
                                                              java.lang.Boolean includePathSegment,
                                                              ExtensionsData extension)
Description copied from interface: NavigationService
Gets the set of descendant objects contained in the specified folder or any of its child folders.

Specified by:
getDescendants in interface NavigationService
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)

getFolderParent

public ObjectData getFolderParent(java.lang.String repositoryId,
                                  java.lang.String folderId,
                                  java.lang.String filter,
                                  ExtensionsData extension)
Description copied from interface: NavigationService
Gets the parent folder object for the specified folder object.

Specified by:
getFolderParent in interface NavigationService
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)

getFolderTree

public java.util.List<ObjectInFolderContainer> getFolderTree(java.lang.String repositoryId,
                                                             java.lang.String folderId,
                                                             java.math.BigInteger depth,
                                                             java.lang.String filter,
                                                             java.lang.Boolean includeAllowableActions,
                                                             IncludeRelationships includeRelationships,
                                                             java.lang.String renditionFilter,
                                                             java.lang.Boolean includePathSegment,
                                                             ExtensionsData extension)
Description copied from interface: NavigationService
Gets the set of descendant folder objects contained in the specified folder.

Specified by:
getFolderTree in interface NavigationService
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

public java.util.List<ObjectParentData> getObjectParents(java.lang.String repositoryId,
                                                         java.lang.String objectId,
                                                         java.lang.String filter,
                                                         java.lang.Boolean includeAllowableActions,
                                                         IncludeRelationships includeRelationships,
                                                         java.lang.String renditionFilter,
                                                         java.lang.Boolean includeRelativePathSegment,
                                                         ExtensionsData extension)
Description copied from interface: NavigationService
Gets the parent folder(s) for the specified non-folder, fileable object.

Specified by:
getObjectParents in interface NavigationService
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)

getCheckedOutDocs

public ObjectList getCheckedOutDocs(java.lang.String repositoryId,
                                    java.lang.String folderId,
                                    java.lang.String filter,
                                    java.lang.String orderBy,
                                    java.lang.Boolean includeAllowableActions,
                                    IncludeRelationships includeRelationships,
                                    java.lang.String renditionFilter,
                                    java.math.BigInteger maxItems,
                                    java.math.BigInteger skipCount,
                                    ExtensionsData extension)
Description copied from interface: NavigationService
Gets the list of documents that are checked out that the user has access to.

Specified by:
getCheckedOutDocs in interface NavigationService
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-2011 The Apache Software Foundation. All Rights Reserved.