org.alfresco.repo.cmis.ws
Class DMNavigationServicePort

java.lang.Object
  extended by org.alfresco.repo.cmis.ws.DMAbstractServicePort
      extended by org.alfresco.repo.cmis.ws.DMNavigationServicePort
All Implemented Interfaces:
org.alfresco.repo.cmis.ws.NavigationServicePort

public class DMNavigationServicePort
extends DMAbstractServicePort
implements org.alfresco.repo.cmis.ws.NavigationServicePort

Port for navigation service


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
DMNavigationServicePort()
           
 
Method Summary
 org.alfresco.repo.cmis.ws.CmisObjectListType getCheckedOutDocs(java.lang.String repositoryId, java.lang.String folderId, java.lang.String filter, java.lang.String orderBy, java.lang.Boolean includeAllowableActions, org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount, org.alfresco.repo.cmis.ws.CmisExtensionType extension)
          Gets the private working copies of checked-out objects that the user is allowed to update.
 org.alfresco.repo.cmis.ws.CmisObjectInFolderListType getChildren(java.lang.String repositoryId, java.lang.String folderId, java.lang.String filter, java.lang.String orderBy, java.lang.Boolean includeAllowableActions, org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includePathSegments, java.math.BigInteger maxItems, java.math.BigInteger skipCount, org.alfresco.repo.cmis.ws.CmisExtensionType extension)
          Gets the list of child objects contained in the specified folder.
 java.util.List getDescendants(java.lang.String repositoryId, java.lang.String folderId, java.math.BigInteger depth, java.lang.String filter, java.lang.Boolean includeAllowableActions, org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includePathSegments, org.alfresco.repo.cmis.ws.CmisExtensionType extension)
          Gets the list of descendant objects contained at one or more levels in the tree rooted at the specified folder.
 org.alfresco.repo.cmis.ws.CmisObjectType getFolderParent(java.lang.String repositoryId, java.lang.String folderId, java.lang.String filter, org.alfresco.repo.cmis.ws.CmisExtensionType extension)
          Returns the parent folder object, and optionally all ancestor folder objects, above a specified folder object.
 java.util.List getFolderTree(java.lang.String repositoryId, java.lang.String folderId, java.math.BigInteger depth, java.lang.String filter, java.lang.Boolean includeAllowableActions, org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includePathSegments, org.alfresco.repo.cmis.ws.CmisExtensionType extension)
          Gets the list of descendant objects contained at one or more levels in the tree rooted at the specified folder.
 java.util.List getObjectParents(java.lang.String repositoryId, java.lang.String objectId, java.lang.String filter, java.lang.Boolean includeAllowableActions, org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includeRelativePathSegment, org.alfresco.repo.cmis.ws.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 org.alfresco.repo.cmis.ws.CmisObjectListType getCheckedOutDocs(java.lang.String repositoryId,
                                                                      java.lang.String folderId,
                                                                      java.lang.String filter,
                                                                      java.lang.String orderBy,
                                                                      java.lang.Boolean includeAllowableActions,
                                                                      org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships,
                                                                      java.lang.String renditionFilter,
                                                                      java.math.BigInteger maxItems,
                                                                      java.math.BigInteger skipCount,
                                                                      org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                                                               throws org.alfresco.repo.cmis.ws.CmisException
Gets the private working copies of checked-out objects that the user is allowed to update.

Specified by:
getCheckedOutDocs in interface org.alfresco.repo.cmis.ws.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 org.alfresco.repo.cmis.ws.CmisObjectInFolderListType getChildren(java.lang.String repositoryId,
                                                                        java.lang.String folderId,
                                                                        java.lang.String filter,
                                                                        java.lang.String orderBy,
                                                                        java.lang.Boolean includeAllowableActions,
                                                                        org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships,
                                                                        java.lang.String renditionFilter,
                                                                        java.lang.Boolean includePathSegments,
                                                                        java.math.BigInteger maxItems,
                                                                        java.math.BigInteger skipCount,
                                                                        org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                                                                 throws org.alfresco.repo.cmis.ws.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 org.alfresco.repo.cmis.ws.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 java.util.List getDescendants(java.lang.String repositoryId,
                                     java.lang.String folderId,
                                     java.math.BigInteger depth,
                                     java.lang.String filter,
                                     java.lang.Boolean includeAllowableActions,
                                     org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships,
                                     java.lang.String renditionFilter,
                                     java.lang.Boolean includePathSegments,
                                     org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                              throws org.alfresco.repo.cmis.ws.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 org.alfresco.repo.cmis.ws.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 java.util.List getFolderTree(java.lang.String repositoryId,
                                    java.lang.String folderId,
                                    java.math.BigInteger depth,
                                    java.lang.String filter,
                                    java.lang.Boolean includeAllowableActions,
                                    org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships,
                                    java.lang.String renditionFilter,
                                    java.lang.Boolean includePathSegments,
                                    org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                             throws org.alfresco.repo.cmis.ws.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 org.alfresco.repo.cmis.ws.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 org.alfresco.repo.cmis.ws.CmisObjectType getFolderParent(java.lang.String repositoryId,
                                                                java.lang.String folderId,
                                                                java.lang.String filter,
                                                                org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                                                         throws org.alfresco.repo.cmis.ws.CmisException
Returns the parent folder object, and optionally all ancestor folder objects, above a specified folder object.

Specified by:
getFolderParent in interface org.alfresco.repo.cmis.ws.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 java.util.List getObjectParents(java.lang.String repositoryId,
                                       java.lang.String objectId,
                                       java.lang.String filter,
                                       java.lang.Boolean includeAllowableActions,
                                       org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships,
                                       java.lang.String renditionFilter,
                                       java.lang.Boolean includeRelativePathSegment,
                                       org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                                throws org.alfresco.repo.cmis.ws.CmisException
Returns the parent folders for the specified non-folder, fileable object.

Specified by:
getObjectParents in interface org.alfresco.repo.cmis.ws.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)


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.