org.xcmis.client.gwt.service.navigation
Class NavigationService

java.lang.Object
  org.xcmis.client.gwt.service.navigation.NavigationService

public class NavigationService
extends Object

Created by The eXo Platform SAS.

Version:

$Id: ${date} ${time}

Author:

Ann Zhuleva

Constructor Summary

NavigationService(com.google.gwt.event.shared.HandlerManager eventBus)

Method Summary

void	getCheckedOut(String url, String folderId, int maxItems, int skipCount, String filter, EnumIncludeRelationships includeRelationships, String renditionFilter, boolean includeAllowableActions) Gets the list of documents that are checked out that the user has access to.
void	getChildren(String url, int maxItems, int skipCount, String filter, EnumIncludeRelationships includeRelationships, String renditionFilter, boolean includeAllowableActions, boolean includePathSegment) Gets the list of child objects contained in the specified folder.
void	getDescendants(String url, int depth, String filter, EnumIncludeRelationships includeRelationships, String renditionFilter, boolean includeAllowableActions, boolean includePathSegment) Gets the set of descendant objects contained in the specified folder or any of its childfolders.
void	getFolderParent(String url, String filter) Gets the parent folder object for the specified folder object.
void	getFolderTree(String url, int depth, String filter, EnumIncludeRelationships includeRelationships, String renditionFilter, boolean includeAllowableActions, boolean includePathSegment) Gets the set of descendant folder objects contained in the specified folder.
void	getNextPage(String url, String filter, EnumIncludeRelationships includeRelationships, String renditionFilter, boolean includeAllowableActions, boolean includePathSegment) To support paging and get next page with items.
void	getObjectParents(String url, String filter, EnumIncludeRelationships includeRelationships, String renditionFilter, boolean includeAllowableActions, boolean includeRelativePathSegment) Gets the parent folder(s) for the specified non-folder, fileable object.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationService

public NavigationService(com.google.gwt.event.shared.HandlerManager eventBus)

Parameters:

eventBus - eventBus

Method Detail

getChildren

public void getChildren(String url,
                        int maxItems,
                        int skipCount,
                        String filter,
                        EnumIncludeRelationships includeRelationships,
                        String renditionFilter,
                        boolean includeAllowableActions,
                        boolean includePathSegment)

Gets the list of child objects contained in the specified folder. On success response received, ChildrenReceivedEvent event is fired

Parameters:

url - url

maxItems - maxItems

skipCount - skipCount

filter - filter

includeRelationships - includeRelationships

renditionFilter - renditionFilter

includeAllowableActions - includeAllowableActions

includePathSegment - includePathSegment

getNextPage

public void getNextPage(String url,
                        String filter,
                        EnumIncludeRelationships includeRelationships,
                        String renditionFilter,
                        boolean includeAllowableActions,
                        boolean includePathSegment)

To support paging and get next page with items. On success response received, NextPageReceivedEvent event is fired.

Parameters:

url - url

filter - filter

includeRelationships - includeRelationships

renditionFilter - renditionFilter

includeAllowableActions - includeAllowableActions

includePathSegment - includePathSegment

getDescendants

public void getDescendants(String url,
                           int depth,
                           String filter,
                           EnumIncludeRelationships includeRelationships,
                           String renditionFilter,
                           boolean includeAllowableActions,
                           boolean includePathSegment)

Gets the set of descendant objects contained in the specified folder or any of its childfolders. On success response received, DescendantsReceivedEvent event is fired

Parameters:

url - url

depth - depth

filter - filter

includeRelationships - includeRelationships

renditionFilter - renditionFilter

includeAllowableActions - includeAllowableActions

includePathSegment - includePathSegment

getFolderTree

public void getFolderTree(String url,
                          int depth,
                          String filter,
                          EnumIncludeRelationships includeRelationships,
                          String renditionFilter,
                          boolean includeAllowableActions,
                          boolean includePathSegment)

Gets the set of descendant folder objects contained in the specified folder. On success response received, FolderTreeReceivedEvent event is fired.

Parameters:

url - url

depth - depth

filter - filter

includeRelationships - includeRelationships

renditionFilter - renditionFilter

includeAllowableActions - includeAllowableActions

includePathSegment - includePathSegment

getFolderParent

public void getFolderParent(String url,
                            String filter)

Gets the parent folder object for the specified folder object. On success response received, FolderParentReceivedEvent event is fired.

Parameters:

url - url

filter - filter

getObjectParents

public void getObjectParents(String url,
                             String filter,
                             EnumIncludeRelationships includeRelationships,
                             String renditionFilter,
                             boolean includeAllowableActions,
                             boolean includeRelativePathSegment)

Gets the parent folder(s) for the specified non-folder, fileable object. On success response received, ObjectParentsReceivedEvent event is fired.

Parameters:

url - url

filter - filter

includeEnumIncludeRelationships - includeEnumIncludeRelationships

renditionFilter - renditionFilter

includeAllowableActions - includeAllowableActions

includeRelativePathSegment - includeRelativePathSegment

getCheckedOut

public void getCheckedOut(String url,
                          String folderId,
                          int maxItems,
                          int skipCount,
                          String filter,
                          EnumIncludeRelationships includeRelationships,
                          String renditionFilter,
                          boolean includeAllowableActions)

Gets the list of documents that are checked out that the user has access to. On success response received, CheckedOutReceivedEvent event is fired.

Parameters:

url - url

folderId - folderId

maxItems - maxItems

skipCount - skipCount

filter - filter

includeRelationships - includeRelationships

renditionFilter - renditionFilter

includeAllowableActions - includeAllowableActions