org.alfresco.repo.cmis.ws

Class DMNavigationServicePort

java.lang.Object

org.alfresco.repo.cmis.ws.DMAbstractServicePort

org.alfresco.repo.cmis.ws.DMNavigationServicePort

All Implemented Interfaces:

NavigationServicePort

public class DMNavigationServicePort
extends DMAbstractServicePort
implements NavigationServicePort

Port for navigation service

Author:

Dmitry Lazurkin, Dmitry Velichkevich

Field Summary

Fields inherited from class org.alfresco.repo.cmis.ws.DMAbstractServicePort

authorityService, cmisAclService, cmisChangeLogService, cmisObjectFactory, cmisQueryService, cmisRenditionService, cmisService, descriptorService, fileFolderService, INCLUDE_RELATIONSHIPS_ENUM_MAPPING, nodeService, permissionService, propertiesUtil, searchService

Constructor Summary

Constructors

Constructor and Description
DMNavigationServicePort()

Method Summary

Methods

Modifier and Type	Method and Description
CmisObjectListType	getCheckedOutDocs(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, EnumIncludeRelationships includeRelationships, String renditionFilter, BigInteger maxItems, BigInteger skipCount, CmisExtensionType extension) Gets the private working copies of checked-out objects that the user is allowed to update.
CmisObjectInFolderListType	getChildren(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, EnumIncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegments, BigInteger maxItems, BigInteger skipCount, CmisExtensionType extension) Gets the list of child objects contained in the specified folder.
List<CmisObjectInFolderContainerType>	getDescendants(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, EnumIncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegments, CmisExtensionType extension) Gets the list of descendant objects contained at one or more levels in the tree rooted at the specified folder.
CmisObjectType	getFolderParent(String repositoryId, String folderId, String filter, CmisExtensionType extension) Returns the parent folder object, and optionally all ancestor folder objects, above a specified folder object.
List<CmisObjectInFolderContainerType>	getFolderTree(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, EnumIncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegments, CmisExtensionType extension) Gets the list of descendant objects contained at one or more levels in the tree rooted at the specified folder.
List<CmisObjectParentsType>	getObjectParents(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, EnumIncludeRelationships includeRelationships, String renditionFilter, Boolean includeRelativePathSegment, CmisExtensionType extension) Returns the parent folders for the specified non-folder, fileable object.

Methods inherited from class org.alfresco.repo.cmis.ws.DMAbstractServicePort

appendWithAce, appendWithRelationships, applyAclCarefully, applyPolicies, checkRepositoryId, convertAclReportToCmisAclType, createCmisObject, createCmisObject, createCmisObjectList, createCursor, createPropertyFilter, createPropertyFilter, determineObjectAllowableActions, getRenditions, isObjectInFolder, setAuthorityService, setCmisAclService, setCmisChangeLogService, setCmisQueryService, setCmisRenditionService, setCmisService, setDescriptorService, setFileFolderService, setNodeService, setPermissionService, setPropertiesUtil, setSearchService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DMNavigationServicePort

public DMNavigationServicePort()

Method Detail

getCheckedOutDocs

public CmisObjectListType getCheckedOutDocs(String repositoryId,
                                   String folderId,
                                   String filter,
                                   String orderBy,
                                   Boolean includeAllowableActions,
                                   EnumIncludeRelationships includeRelationships,
                                   String renditionFilter,
                                   BigInteger maxItems,
                                   BigInteger skipCount,
                                   CmisExtensionType extension)
                                     throws CmisException

Gets the private working copies of checked-out objects that the user is allowed to update.

Specified by:

getCheckedOutDocs in interface NavigationServicePort

Parameters:

parameters - repositoryId: repository Id; folderID: folder Id; filter: property filter; includeAllowableActions; includeRelationships; maxItems: 0 = Unlimited; skipCount: 0 = start at beginning

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FILTER_NOT_VALID)

getChildren

public CmisObjectInFolderListType getChildren(String repositoryId,
                                     String folderId,
                                     String filter,
                                     String orderBy,
                                     Boolean includeAllowableActions,
                                     EnumIncludeRelationships includeRelationships,
                                     String renditionFilter,
                                     Boolean includePathSegments,
                                     BigInteger maxItems,
                                     BigInteger skipCount,
                                     CmisExtensionType extension)
                                       throws CmisException

Gets the list of child objects contained in the specified folder. Only the filter-selected properties associated with each object are returned. The content-streams of documents are not returned.For returning a tree of objects of a certain depth, use #getDescendants(GetDescendants parameters).

Specified by:

getChildren in interface NavigationServicePort

Parameters:

parameters - repositoryId: repository Id; folderId: folder Id; type: DOCUMENTS, FOLDERS, POLICIES, ANY; filter: property filter; includeAllowableActions; includeRelationships; maxItems: 0 = Unlimited; skipCount: 0 = start at beginning

Returns:

collection of CmisObjectType and boolean hasMoreItems

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FILTER_NOT_VALID)

getDescendants

public List<CmisObjectInFolderContainerType> getDescendants(String repositoryId,
                                                   String folderId,
                                                   BigInteger depth,
                                                   String filter,
                                                   Boolean includeAllowableActions,
                                                   EnumIncludeRelationships includeRelationships,
                                                   String renditionFilter,
                                                   Boolean includePathSegments,
                                                   CmisExtensionType extension)
                                                     throws CmisException

Gets the list of descendant objects contained at one or more levels in the tree rooted at the specified folder. Only the filter-selected properties associated with each object are returned. The content-stream is not returned. For paging through the children (depth of 1) only use #getChildren(GetChildren parameters).

Specified by:

getDescendants in interface NavigationServicePort

Parameters:

parameters - repositoryId: repository Id; folderId: folder Id; depth: 1 this folder only (Default), N folders deep, -1 for all levels; filter: property filter; includeAllowableActions; includeRelationships;

Returns:

collection of CmisObjectType

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FILTER_NOT_VALID)

getFolderTree

public List<CmisObjectInFolderContainerType> getFolderTree(String repositoryId,
                                                  String folderId,
                                                  BigInteger depth,
                                                  String filter,
                                                  Boolean includeAllowableActions,
                                                  EnumIncludeRelationships includeRelationships,
                                                  String renditionFilter,
                                                  Boolean includePathSegments,
                                                  CmisExtensionType extension)
                                                    throws CmisException

Gets the list of descendant objects contained at one or more levels in the tree rooted at the specified folder. Only the filter-selected properties associated with each object are returned. The content-stream is not returned. For paging through the children (depth of 1) only use #getChildren(GetChildren parameters).

Specified by:

getFolderTree in interface NavigationServicePort

Parameters:

parameters - repositoryId: repository Id; folderId: folder Id; depth: 1 this folder only (Default), N folders deep, -1 for all levels; filter: property filter; includeAllowableActions; includeRelationships;

Returns:

collection of CmisObjectType

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FILTER_NOT_VALID)

getFolderParent

public CmisObjectType getFolderParent(String repositoryId,
                             String folderId,
                             String filter,
                             CmisExtensionType extension)
                               throws CmisException

Returns the parent folder object, and optionally all ancestor folder objects, above a specified folder object.

Specified by:

getFolderParent in interface NavigationServicePort

Parameters:

parameters - repositoryId: repository Id; folderId: folder Id; filter: property filter; includeAllowableActions; includeRelationships; returnToRoot: If false, return only the immediate parent of the folder. If true, return an ordered list of all ancestor folders from the specified folder to the root folder

Returns:

collection of CmisObjectType

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FILTER_NOT_VALID)

getObjectParents

public List<CmisObjectParentsType> getObjectParents(String repositoryId,
                                           String objectId,
                                           String filter,
                                           Boolean includeAllowableActions,
                                           EnumIncludeRelationships includeRelationships,
                                           String renditionFilter,
                                           Boolean includeRelativePathSegment,
                                           CmisExtensionType extension)
                                             throws CmisException

Returns the parent folders for the specified non-folder, fileable object.

Specified by:

getObjectParents in interface NavigationServicePort

Parameters:

parameters - repositoryId: repository Id; objectId: object Id; filter: property filter; includeAllowableActions; includeRelationships;

Returns:

collection of CmisObjectType

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, FILTER_NOT_VALID)