|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.chemistry.opencmis.client.bindings.spi.local.AbstractLocalService
org.apache.chemistry.opencmis.client.bindings.spi.local.NavigationServiceImpl
public class NavigationServiceImpl
Constructor Summary | |
---|---|
NavigationServiceImpl(BindingSession session,
CmisServiceFactory factory)
Constructor. |
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. |
Methods inherited from class org.apache.chemistry.opencmis.client.bindings.spi.local.AbstractLocalService |
---|
createCallContext, getService, getServiceFactory, getSession, setServiceFactory, setSession |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NavigationServiceImpl(BindingSession session, CmisServiceFactory factory)
Method Detail |
---|
public ObjectList getCheckedOutDocs(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
NavigationService
getCheckedOutDocs
in interface NavigationService
repositoryId
- the identifier for the repositoryfolderId
- the identifier for the folderfilter
- (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)public ObjectInFolderList getChildren(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
NavigationService
getChildren
in interface NavigationService
repositoryId
- the identifier for the repositoryfolderId
- the identifier for the folderfilter
- (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)public List<ObjectInFolderContainer> getDescendants(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, ExtensionsData extension)
NavigationService
getDescendants
in interface NavigationService
repositoryId
- the identifier for the repositoryfolderId
- the identifier for the folderdepth
- the number of levels of depth in the folder hierarchy from
which to return resultsfilter
- (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
)public ObjectData getFolderParent(String repositoryId, String folderId, String filter, ExtensionsData extension)
NavigationService
getFolderParent
in interface NavigationService
repositoryId
- the identifier for the repositoryfolderId
- the identifier for the folderfilter
- (optional) a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)public List<ObjectInFolderContainer> getFolderTree(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, ExtensionsData extension)
NavigationService
getFolderTree
in interface NavigationService
repositoryId
- the identifier for the repositoryfolderId
- the identifier for the folderdepth
- the number of levels of depth in the folder hierarchy from
which to return resultsfilter
- (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
)public List<ObjectParentData> getObjectParents(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includeRelativePathSegment, ExtensionsData extension)
NavigationService
getObjectParents
in interface NavigationService
repositoryId
- the identifier for the repositoryobjectId
- the identifier for the objectfilter
- (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
)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |