com.saperion.ngc.model.navigation

Class NavigationClassicConnectorService

java.lang.Object

com.saperion.ngc.model.ClassicConnectorService

com.saperion.ngc.model.navigation.NavigationClassicConnectorService

All Implemented Interfaces:

NavigationService, Service

public class NavigationClassicConnectorService
extends ClassicConnectorService
implements NavigationService

Navigation service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NavigationClassicConnectorService.DefinedTreeParts Tree parts.

Field Summary

Fields inherited from class com.saperion.ngc.model.ClassicConnectorService

ddcCache

Fields inherited from interface com.saperion.ngc.model.navigation.NavigationService

NO_LIMIT_MAX_NR_OF_NODES_PER_LEVEL

Constructor Summary

Constructors

Constructor and Description
NavigationClassicConnectorService() Creates a new DefClassicConnectorService.
NavigationClassicConnectorService(ClassicConnectorProvider conProvider) Constructor - used for mock tests.

Method Summary

Modifier and Type	Method and Description
FolderId	addFavoriteFolder(String name, Properties props, String content) Adds a new node to the favorite folder with the given name, properties and content.
NavigationNode	addFolder(NavigationNode node, String childName, com.saperion.constants.SaFolderConstants.FOLDER_TYPE nodeType, Properties properties) Adds a folder with the given name to the node and returns the result containing the new child.
NavigationNode	addLinkFolder(NavigationNode node, String childName, FolderId destination) Adds a link folder with the given name to the node and returns the result containing the new child.
void	addToFolder(Set<FolderId> folderIds, Set<DocumentId> documentIDs) Adds documents to the specified folders.
NavigationNode	addWebpartFolder(NavigationNode node, String childName, String destination) Adds a webpart folder with the given name to the node and returns the result containing the new child.
NavigationNode	copyFolder(FolderId folderId, NavigationNode destinationNode, FolderId beforeChildId, boolean withDocuments) Copies a folder to the specified location.
void	deleteFolder(NavigationNode node) Deletes the given folder.
void	deleteFolderById(FolderId id) Deletes the folder identified by the specified id.
Long	getBoxCount(int boxId) Deprecated. use #getBoxTotalAndUnreadCount(int, Filter) instead
com.saperion.wf.BoxCount	getBoxTotalAndUnreadCount(int boxId, WorkflowNodeInfo.Filter boxFilter) Returns the count of all elements and of all unread elements in the given box.
Map<Integer,com.saperion.wf.BoxCount>	getBoxTotalAndUnreadCounts(Set<Integer> boxIds) Returns the count of all elements and of all unread elements in the given boxes.
long	getDocumentFolderCount(DocumentId id) Retrieves the count over all folders the document is contained in.
List<FolderId>	getDocumentFolders(DocumentId id) Retrieves the folders that contain the specified document.
List<String>	getFolderAcl(FolderId folderId) Gets ACL for folder.
FolderNode	getFolderById(FolderId id) Search a folder by id.
FolderNode	getFolderByPath(String ddc, String path) Search a folder by path.
List<FolderInfo>	getFolderChildren(FolderId id) Retrieves the children of the folder identified by the specified id.
FolderClass	getFolderClass(String className) Returns the folder class with the specified name or null if no such class exists.
Set<FolderClass>	getFolderClassesForDDC(String ddcName, com.saperion.constants.SaFolderConstants.CLASS_TYPE classType) Returns all folder classes of a certain type that can be used for the specified DDC.
FolderInfo	getFolderInfo(FolderId id) Retrieves information about the specified folder.
List<String>	getFolderTables() Reads all folder table names.
NavigationTree	getFolderTree(FolderId root, com.saperion.rmi.SaQueryInfo filter) Generates a folder tree stated at .
Set<com.saperion.folder.FolderUpdateInfo>	getFolderUpdateInfo(Map<String,Long> folderIds) Get Set of folders to refresh on client side.
int	getInboxId() Reads the inbox id for the current user.
com.saperion.ngc.iform.xml.Form	getMaskDefinition(String maskName) Retrieves the mask definition with the given name.
com.saperion.ngc.iform.xml.Form	getMaskDefinition(String maskName, boolean ignoreCompatibility) Retrieves the mask definition with the given name.
NavigationTree	getNavigationTree(String folderDDC, com.saperion.rmi.SaQueryInfo filter) Returns the navigation tree.
NavigationNode	getNextLevelFolders(NavigationNode node, com.saperion.rmi.SaQueryInfo filter, int allowedMaxNrOfNodesPerLevel) Returns the folders of the next level.
com.saperion.wf.BoxCount	getTaskCounts() Returns the number or read and unread tasks for the current user.
NavigationNode	getWorkflowNodes(NavigationNode navigationNode) Reads the workflow tree part.
boolean	hasFolder(String folderId)
void	moveFolder(FolderId folderId, FolderId targetFolderId, FolderId beforeFolderId) Moves folder.
void	removeFromFolder(Set<FolderId> folderSysRowIds, DocumentId documentId) Removes the specified document from a folder.
NavigationNode	renameFolder(NavigationNode node, String name) Renames folder.
FolderId	resolveLink(FolderId linkId) Resolves a link folder and returns the link destination.
void	setFolderAcl(FolderId folderId, String acl) Sets ACL for folder.
void	storeMaskDefinition(String maskName, com.saperion.ngc.iform.xml.Form mask) Deprecated. method no longer supported
void	updateFolder(FolderId id, Properties nameValuePairs) Updates the properties of a folder.

Methods inherited from class com.saperion.ngc.model.ClassicConnectorService

convertAuthenticationException, getCachedDDC, getConnectionProvider, getCurrentUserFromSession, getSession, getWfConnectionProvider, isActive

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.saperion.ngc.model.Service

isActive

Constructor Detail

NavigationClassicConnectorService

public NavigationClassicConnectorService()

Creates a new DefClassicConnectorService.

NavigationClassicConnectorService

public NavigationClassicConnectorService(ClassicConnectorProvider conProvider)

Constructor - used for mock tests.

Parameters:

conProvider - Connection provider

Method Detail

getMaskDefinition

public final com.saperion.ngc.iform.xml.Form getMaskDefinition(String maskName)
                                                        throws SystemException,
                                                               UnsupportedFormException,
                                                               AuthenticationException

Retrieves the mask definition with the given name.

Specified by:

getMaskDefinition in interface NavigationService

Parameters:

maskName - Mask definition name

Returns:

Form

Throws:

SystemException - system exception

UnsupportedFormException - when the form can not be used in WebClient

AuthenticationException - authentication exception

See Also:

NavigationService.getMaskDefinition(java.lang.String)

getMaskDefinition

public com.saperion.ngc.iform.xml.Form getMaskDefinition(String maskName,
                                                         boolean ignoreCompatibility)
                                                  throws SystemException,
                                                         UnsupportedFormException,
                                                         AuthenticationException

Retrieves the mask definition with the given name. If ignoreCompatibility is set to true, masks that are not compatible with web client are returened, too.

Specified by:

getMaskDefinition in interface NavigationService

Parameters:

maskName - Mask definition name

ignoreCompatibility - if true, masks that are not compatible with the web client are returned

Returns:

Form

Throws:

SystemException - system exception

UnsupportedFormException - when the form can not be used in WebClient

AuthenticationException - authentication exception

See Also:

NavigationService.getMaskDefinition(java.lang.String, boolean)

storeMaskDefinition

@Deprecated
public void storeMaskDefinition(String maskName,
                                             com.saperion.ngc.iform.xml.Form mask)
                                      throws JAXBException

Deprecated. method no longer supported

Stores the given form as mask with the given name.

Specified by:

storeMaskDefinition in interface NavigationService

Parameters:

maskName - Mask name

mask - Mask form

Throws:

JAXBException - JAXBException

See Also:

NavigationService.storeMaskDefinition(java.lang.String, com.saperion.ngc.iform.xml.Form)

getInboxId

public int getInboxId()
               throws AuthenticationException,
                      SystemException

Reads the inbox id for the current user.

Specified by:

getInboxId in interface NavigationService

Returns:

Inbox id

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

NavigationService.getInboxId()

getBoxCount

@Deprecated
public Long getBoxCount(int boxId)
                              throws com.saperion.exception.SaAuthenticationException,
                                     com.saperion.exception.SaSystemException

Deprecated. use #getBoxTotalAndUnreadCount(int, Filter) instead

Loads and returns the box count for the given box.

Specified by:

getBoxCount in interface NavigationService

Parameters:

boxId - The if of the box to get the cout from.

Returns:

the number of box workflow items.

Throws:

com.saperion.exception.SaAuthenticationException - If an authentication exception occurs.

com.saperion.exception.SaSystemException - If a system exception occurs.

See Also:

NavigationService.getBoxCount(int)

getBoxTotalAndUnreadCount

public com.saperion.wf.BoxCount getBoxTotalAndUnreadCount(int boxId,
                                                          WorkflowNodeInfo.Filter boxFilter)
                                                   throws com.saperion.exception.SaAuthenticationException,
                                                          com.saperion.exception.SaSystemException

Returns the count of all elements and of all unread elements in the given box.

Specified by:

getBoxTotalAndUnreadCount in interface NavigationService

Parameters:

boxId - The if of the box to get the cout from.

boxFilter - filter type of the workflow box to get count for

Returns:

the number of all elements and of all unread element

Throws:

com.saperion.exception.SaAuthenticationException - If an authentication exception occurs.

com.saperion.exception.SaSystemException - If a system exception occurs.

See Also:

com.saperion.ngc.model.navigation.NavigationService#getBoxTotalAndUnreadCount(int, Filter)

getBoxTotalAndUnreadCounts

public Map<Integer,com.saperion.wf.BoxCount> getBoxTotalAndUnreadCounts(Set<Integer> boxIds)
                                                                 throws com.saperion.exception.SaAuthenticationException,
                                                                        com.saperion.exception.SaSystemException

Returns the count of all elements and of all unread elements in the given boxes.

Specified by:

getBoxTotalAndUnreadCounts in interface NavigationService

Parameters:

boxIds - The if of the box to get the cout from.

Returns:

the number of all elements and of all unread element

Throws:

com.saperion.exception.SaAuthenticationException - If an authentication exception occurs.

com.saperion.exception.SaSystemException - If a system exception occurs.

See Also:

NavigationService.getBoxTotalAndUnreadCounts(java.util.Set)

getNavigationTree

public final NavigationTree getNavigationTree(String folderDDC,
                                              com.saperion.rmi.SaQueryInfo filter)
                                       throws NavigationException,
                                              AuthenticationException,
                                              SystemException,
                                              DocumentIdentificationException,
                                              DatabaseException,
                                              UnknownFolderTypeException

Returns the navigation tree.

Specified by:

getNavigationTree in interface NavigationService

Parameters:

folderDDC - Folder DDC

filter - Filter object

Returns:

NavigationTree object

Throws:

NavigationException - navigation exception

AuthenticationException - Authentication exception

SystemException - system exception

DocumentIdentificationException - if the root node of the tree cannot be identified

DatabaseException - database exception when trying to resolve folder properties

UnknownFolderTypeException - when a folder with an unknown type is found

See Also:

NavigationService.getNavigationTree(java.lang.String, com.saperion.rmi.SaQueryInfo)

getWorkflowNodes

public final NavigationNode getWorkflowNodes(NavigationNode navigationNode)
                                      throws NavigationException,
                                             AuthenticationException,
                                             SystemException,
                                             DatabaseException

Reads the workflow tree part.

Specified by:

getWorkflowNodes in interface NavigationService

Parameters:

navigationNode - parent node

Returns:

Workflow tree

Throws:

NavigationException - navigation exception

AuthenticationException - Authentication exception

SystemException - system exception

DatabaseException - database exception

See Also:

(com.saperion.ngc.model.navigation.intf.NavigationNode)

getFolderTree

public final NavigationTree getFolderTree(FolderId root,
                                          com.saperion.rmi.SaQueryInfo filter)
                                   throws NavigationException,
                                          AuthenticationException,
                                          SystemException,
                                          DatabaseException,
                                          UnknownFolderTypeException

Generates a folder tree stated at .

Specified by:

getFolderTree in interface NavigationService

Parameters:

root - Root node

filter - Filter object

Returns:

Folder tree

Throws:

NavigationException - navigation exception

AuthenticationException - Authentication exception

SystemException - system exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

See Also:

NavigationService.getFolderTree(com.saperion.ngc.model.FolderId, com.saperion.rmi.SaQueryInfo)

getFolderByPath

public final FolderNode getFolderByPath(String ddc,
                                        String path)
                                 throws NavigationException,
                                        AuthenticationException,
                                        SystemException,
                                        DatabaseException,
                                        UnknownFolderTypeException

Search a folder by path.

Specified by:

getFolderByPath in interface NavigationService

Parameters:

ddc - folder ddc

path - Absolute path

Returns:

FolderNode or null, if not found.

Throws:

NavigationException - navigation exception

AuthenticationException - Authentication exception

SystemException - system exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

See Also:

NavigationService.getFolderByPath(java.lang.String, java.lang.String)

getFolderById

public FolderNode getFolderById(FolderId id)
                         throws AuthenticationException,
                                SystemException,
                                NavigationException,
                                DatabaseException,
                                UnknownFolderTypeException

Search a folder by id.

Specified by:

getFolderById in interface NavigationService

Parameters:

id - folder id

Returns:

folder node or null, if not found

Throws:

AuthenticationException - Authentication exception

SystemException - system exception

NavigationException - navigation exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

See Also:

NavigationService.getFolderById(com.saperion.ngc.model.FolderId)

resolveLink

public final FolderId resolveLink(FolderId linkId)
                           throws NavigationException,
                                  AuthenticationException

Resolves a link folder and returns the link destination.

Specified by:

resolveLink in interface NavigationService

Parameters:

linkId - Link folder id

Returns:

Destination folder id

Throws:

NavigationException - navigation exception

AuthenticationException - Authentication exception

See Also:

NavigationService.resolveLink(com.saperion.ngc.model.FolderId)

getNextLevelFolders

public NavigationNode getNextLevelFolders(NavigationNode node,
                                          com.saperion.rmi.SaQueryInfo filter,
                                          int allowedMaxNrOfNodesPerLevel)
                                   throws NavigationException,
                                          AuthenticationException,
                                          SystemException,
                                          DatabaseException,
                                          UnknownFolderTypeException

Returns the folders of the next level.

Specified by:

getNextLevelFolders in interface NavigationService

Parameters:

node - node

filter - filter

allowedMaxNrOfNodesPerLevel - allowedMaxNrOfNodesPerLevel

Returns:

navigation node containing next level child nodes

Throws:

NavigationException - navigation exception

AuthenticationException - authentication exception

SystemException - system exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

See Also:

#getNextLevelFolders(com.saperion.ngc.model.navigation.intf.NavigationNode, com.saperion.rmi.SaQueryInfo, int)

deleteFolder

public void deleteFolder(NavigationNode node)
                  throws AuthenticationException,
                         SystemException

Deletes the given folder.

Specified by:

deleteFolder in interface NavigationService

Parameters:

node - navigation node

Throws:

AuthenticationException - authentication exception

SystemException - system exception

See Also:

(com.saperion.ngc.model.navigation.intf.NavigationNode)

addFolder

public NavigationNode addFolder(NavigationNode node,
                                String childName,
                                com.saperion.constants.SaFolderConstants.FOLDER_TYPE nodeType,
                                Properties properties)
                         throws AuthenticationException,
                                SystemException,
                                NavigationException,
                                DatabaseException,
                                UnknownFolderTypeException

Adds a folder with the given name to the node and returns the result containing the new child.

Specified by:

addFolder in interface NavigationService

Parameters:

node - parent node

childName - name of new child node to add

nodeType - node type

properties - node properties

Returns:

node containing new child

Throws:

AuthenticationException - authentication exception

SystemException - system exception

NavigationException - navigation exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

See Also:

(com.saperion.ngc.model.navigation.intf.NavigationNode, java.lang.String, com.saperion.constants.SaFolderConstants.FOLDER_TYPE, java.util.Properties)

addLinkFolder

public NavigationNode addLinkFolder(NavigationNode node,
                                    String childName,
                                    FolderId destination)
                             throws SystemException,
                                    AuthenticationException,
                                    DatabaseException,
                                    UnknownFolderTypeException,
                                    InvalidFolderNameException

Adds a link folder with the given name to the node and returns the result containing the new child.

Specified by:

addLinkFolder in interface NavigationService

Parameters:

node - parent node

childName - name of new child node to add

destination - Destination folder id

Returns:

node containing new child

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

InvalidFolderNameException - when the folder name contained an invalid character

See Also:

#addLinkFolder(com.saperion.ngc.model.navigation.intf.NavigationNode, java.lang.String, com.saperion.ngc.model.FolderId)

addWebpartFolder

public NavigationNode addWebpartFolder(NavigationNode node,
                                       String childName,
                                       String destination)
                                throws SystemException,
                                       AuthenticationException,
                                       DatabaseException,
                                       UnknownFolderTypeException,
                                       InvalidFolderNameException

Adds a webpart folder with the given name to the node and returns the result containing the new child.

Specified by:

addWebpartFolder in interface NavigationService

Parameters:

node - parent node

childName - name of new child node to add

destination - Destination webpart id

Returns:

node containing new child

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

InvalidFolderNameException - when the folder name contained an invalid character

See Also:

#addWebpartFolder(com.saperion.ngc.model.navigation.intf.NavigationNode, java.lang.String, java.lang.String)

renameFolder

public NavigationNode renameFolder(NavigationNode node,
                                   String name)
                            throws NavigationException,
                                   SystemException

Renames folder.

Specified by:

renameFolder in interface NavigationService

Parameters:

node - Node

name - Name

Returns:

renamed folder

Throws:

NavigationException - navigation exception

SystemException - system exception

See Also:

(com.saperion.ngc.model.navigation.intf.NavigationNode, java.lang.String)

moveFolder

public void moveFolder(FolderId folderId,
                       FolderId targetFolderId,
                       FolderId beforeFolderId)
                throws FolderMoveException,
                       DuplicateFolderException

Moves folder.

Specified by:

moveFolder in interface NavigationService

Parameters:

folderId - folder id

targetFolderId - target folder

beforeFolderId - before folder

Throws:

FolderMoveException - if moving failed or is not allowed

DuplicateFolderException - if a node with the same name already exists

See Also:

NavigationService.moveFolder(com.saperion.ngc.model.FolderId, com.saperion.ngc.model.FolderId, com.saperion.ngc.model.FolderId)

copyFolder

public NavigationNode copyFolder(FolderId folderId,
                                 NavigationNode destinationNode,
                                 FolderId beforeChildId,
                                 boolean withDocuments)
                          throws SystemException,
                                 AuthenticationException,
                                 NavigationException,
                                 DatabaseException,
                                 UnknownFolderTypeException

Copies a folder to the specified location.

Specified by:

copyFolder in interface NavigationService

Parameters:

folderId - id of the folder to copy

destinationNode - the destination folder

beforeChildId - id of the child to insert the copied folder before

withDocuments - documents will be copied, too

Returns:

the new child

Throws:

SystemException - system exception

AuthenticationException - authentication exception

NavigationException - navigation exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

See Also:

NavigationService.copyFolder(com.saperion.ngc.model.FolderId, com.saperion.ngc.model.navigation.intf.NavigationNode, com.saperion.ngc.model.FolderId, boolean)

addFavoriteFolder

public FolderId addFavoriteFolder(String name,
                                  Properties props,
                                  String content)
                           throws AuthenticationException,
                                  SystemException,
                                  DatabaseException,
                                  UnknownFolderTypeException,
                                  InvalidFolderNameException

Adds a new node to the favorite folder with the given name, properties and content.

Specified by:

addFavoriteFolder in interface NavigationService

Parameters:

name - Folder name

props - Properties

content - Content

Returns:

Folder id

Throws:

AuthenticationException - authentication exception

SystemException - system exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

InvalidFolderNameException - when the folder name contained an invalid character

See Also:

NavigationService.addFavoriteFolder(java.lang.String, java.util.Properties, java.lang.String)

addToFolder

public void addToFolder(Set<FolderId> folderIds,
                        Set<DocumentId> documentIDs)
                 throws SystemException,
                        AuthenticationException,
                        DatabaseException,
                        NavigationException

Adds documents to the specified folders.

Specified by:

addToFolder in interface NavigationService

Parameters:

folderIds - folder ids

documentIDs - ids of documents

Throws:

DatabaseException

SystemException - system exception

AuthenticationException - authentication exception

NavigationException - navigation exception

See Also:

NavigationService.addToFolder(java.util.Set, java.util.Set)

removeFromFolder

public void removeFromFolder(Set<FolderId> folderSysRowIds,
                             DocumentId documentId)
                      throws SystemException,
                             AuthenticationException

Removes the specified document from a folder.

Specified by:

removeFromFolder in interface NavigationService

Parameters:

folderSysRowIds - folders to remove from

documentId - ID of document to remove

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

NavigationService.removeFromFolder(java.util.Set, com.saperion.ngc.model.document.DocumentId)

getDocumentFolders

public List<FolderId> getDocumentFolders(DocumentId id)
                                  throws SystemException,
                                         AuthenticationException

Retrieves the folders that contain the specified document.

Specified by:

getDocumentFolders in interface NavigationService

Parameters:

id - document's id

Returns:

list of folder document infos

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

(com.saperion.ngc.model.document.DocumentId)

getDocumentFolderCount

public long getDocumentFolderCount(DocumentId id)
                            throws SystemException,
                                   AuthenticationException

Retrieves the count over all folders the document is contained in.

Specified by:

getDocumentFolderCount in interface NavigationService

Parameters:

id - document's id

Returns:

folder count

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

(com.saperion.ngc.model.document.DocumentId)

setFolderAcl

public void setFolderAcl(FolderId folderId,
                         String acl)
                  throws SystemException,
                         AuthenticationException

Sets ACL for folder.

Specified by:

setFolderAcl in interface NavigationService

Parameters:

folderId - folderId

acl - set of ACL names

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

NavigationService.setFolderAcl(com.saperion.ngc.model.FolderId, java.lang.String)

getFolderAcl

public List<String> getFolderAcl(FolderId folderId)
                          throws SystemException,
                                 AuthenticationException

Gets ACL for folder.

Specified by:

getFolderAcl in interface NavigationService

Parameters:

folderId - folderId

Returns:

list of ACL names

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

NavigationService.getFolderAcl(com.saperion.ngc.model.FolderId)

getFolderTables

public List<String> getFolderTables()
                             throws SystemException,
                                    AuthenticationException

Reads all folder table names.

Specified by:

getFolderTables in interface NavigationService

Returns:

List of folder table names

Throws:

SystemException - System exception

AuthenticationException - authentication exception

See Also:

NavigationService.getFolderTables()

hasFolder

public boolean hasFolder(String folderId)
                  throws SystemException,
                         AuthenticationException

Specified by:

hasFolder in interface NavigationService

Parameters:

folderId - Folder ID

Returns:

True, if folder exists.

Throws:

SystemException - System exception

AuthenticationException - authentication exception

See Also:

NavigationService.hasFolder(java.lang.String)

getFolderInfo

public FolderInfo getFolderInfo(FolderId id)
                         throws SystemException,
                                AuthenticationException,
                                DatabaseException,
                                NavigationException

Retrieves information about the specified folder.

Specified by:

getFolderInfo in interface NavigationService

Parameters:

id - folder id

Returns:

folder info

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

NavigationException - navigation exception

See Also:

NavigationService.getFolderInfo(com.saperion.ngc.model.FolderId)

updateFolder

public void updateFolder(FolderId id,
                         Properties nameValuePairs)
                  throws SystemException,
                         AuthenticationException,
                         DatabaseException

Updates the properties of a folder.

Specified by:

updateFolder in interface NavigationService

Parameters:

id - id of the folder to update

nameValuePairs - properties to update

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

See Also:

NavigationService.updateFolder(com.saperion.ngc.model.FolderId, java.util.Properties)

getFolderClass

public FolderClass getFolderClass(String className)
                           throws SystemException,
                                  AuthenticationException,
                                  DatabaseException

Returns the folder class with the specified name or null if no such class exists.

Specified by:

getFolderClass in interface NavigationService

Parameters:

className - class name

Returns:

folder class or null if not found

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

See Also:

NavigationService.getFolderClass(java.lang.String)

getFolderClassesForDDC

public Set<FolderClass> getFolderClassesForDDC(String ddcName,
                                               com.saperion.constants.SaFolderConstants.CLASS_TYPE classType)
                                        throws SystemException,
                                               AuthenticationException

Returns all folder classes of a certain type that can be used for the specified DDC.

Specified by:

getFolderClassesForDDC in interface NavigationService

Parameters:

ddcName - DDC name

classType - the type of class to search for

Returns:

set of folder classes

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

NavigationService.getFolderClassesForDDC(java.lang.String, com.saperion.constants.SaFolderConstants.CLASS_TYPE)

deleteFolderById

public void deleteFolderById(FolderId id)
                      throws SystemException,
                             AuthenticationException,
                             DatabaseException,
                             NavigationException

Deletes the folder identified by the specified id.

Specified by:

deleteFolderById in interface NavigationService

Parameters:

id - folder id

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

NavigationException - navigation exception

See Also:

NavigationService.deleteFolderById(com.saperion.ngc.model.FolderId)

getFolderChildren

public List<FolderInfo> getFolderChildren(FolderId id)
                                   throws SystemException,
                                          AuthenticationException,
                                          DatabaseException,
                                          NavigationException

Retrieves the children of the folder identified by the specified id. Only the direct descendants of the node are returned.

Specified by:

getFolderChildren in interface NavigationService

Parameters:

id - folder id

Returns:

list of children

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

NavigationException - navigation exception

See Also:

NavigationService.getFolderChildren(com.saperion.ngc.model.FolderId)

getFolderUpdateInfo

public Set<com.saperion.folder.FolderUpdateInfo> getFolderUpdateInfo(Map<String,Long> folderIds)
                                                              throws SystemException,
                                                                     AuthenticationException

Get Set of folders to refresh on client side.

Specified by:

getFolderUpdateInfo in interface NavigationService

Parameters:

folderIds - Map of SYSROWIDs with time stamps of last refresh to check.

Returns:

Set of folders that shall be refreshed.

Throws:

SystemException - general error

AuthenticationException - error on the authentification / insufficient rights

See Also:

NavigationService.getFolderUpdateInfo(java.util.Map)

getTaskCounts

public com.saperion.wf.BoxCount getTaskCounts()
                                       throws AuthenticationException,
                                              SystemException

Returns the number or read and unread tasks for the current user. The count is created by summing up the counts of all workflow boxes.

Specified by:

getTaskCounts in interface NavigationService

Returns:

global count

Throws:

AuthenticationException - not logged in or not allowed

SystemException - system error when checking for tasks

See Also:

NavigationService.getTaskCounts()