Package com.saperion.ngc.model.navigation

Interface NavigationService

All Superinterfaces:

Service

All Known Implementing Classes:

NavigationClassicConnectorService

public interface NavigationService
extends Service

Interface for navigation services.

Field Summary

Fields

Modifier and Type	Field	Description
static int	NO_LIMIT_MAX_NR_OF_NODES_PER_LEVEL	Constraint, which defines the max limit of nodes per level.

Method Summary

Modifier and Type	Method	Description
FolderId	addFavoriteFolder(java.lang.String name, java.util.Properties props, java.lang.String content)	Adds a new node to the favorite folder with the given name, properties and content.
NavigationNode	addFolder(NavigationNode node, java.lang.String childName, com.saperion.constants.SaFolderConstants.FOLDER_TYPE nodeType, java.util.Properties properties)	Adds a folder with the given name to the node and returns the result containing the new child.
NavigationNode	addLinkFolder(NavigationNode node, java.lang.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(java.util.Set<FolderId> folderIds, java.util.Set<DocumentId> documentIDs)	Adds documents to the specified folders.
NavigationNode	addWebpartFolder(NavigationNode node, java.lang.String childName, java.lang.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.
java.lang.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.
java.util.Map<java.lang.Integer,com.saperion.wf.BoxCount>	getBoxTotalAndUnreadCounts(java.util.Set<java.lang.Integer> boxId)	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.
java.util.List<FolderId>	getDocumentFolders(DocumentId id)	Retrieves the folders that contain the specified document.
java.util.List<java.lang.String>	getFolderAcl(FolderId folderId)	Gets ACL for folder.
FolderNode	getFolderById(FolderId id)	Search a folder by id.
FolderNode	getFolderByPath(java.lang.String ddc, java.lang.String path)	Search a folder by path.
java.util.List<FolderInfo>	getFolderChildren(FolderId id)	Retrieves the children of the folder identified by the specified id.
FolderClass	getFolderClass(java.lang.String className)	Returns the folder class with the specified name or null if no such class exists.
java.util.Set<FolderClass>	getFolderClassesForDDC(java.lang.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.
java.util.List<java.lang.String>	getFolderTables()	Reads all folder table names.
NavigationTree	getFolderTree(FolderId root, com.saperion.rmi.SaQueryInfo filter)	Generates a folder tree stated at .
java.util.Set<com.saperion.folder.FolderUpdateInfo>	getFolderUpdateInfo(java.util.Map<java.lang.String,java.lang.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(java.lang.String maskName)	Retrieves the mask definition with the given name.
com.saperion.ngc.iform.xml.Form	getMaskDefinition(java.lang.String maskName, boolean ignoreCompatibility)	Retrieves the mask definition with the given name.
NavigationTree	getNavigationTree(java.lang.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(java.lang.String folderId)
void	moveFolder(FolderId folderId, FolderId targetFolderId, FolderId beforeFolderId)	Moves folder.
void	removeFromFolder(java.util.Set<FolderId> folderIds, DocumentId documentId)	Removes the specified document from a folder.
NavigationNode	renameFolder(NavigationNode node, java.lang.String name)	Renames folder.
FolderId	resolveLink(FolderId linkId)	Resolves a link folder and returns the link destination.
void	setFolderAcl(FolderId folderId, java.lang.String acl)	Sets ACL for folder.
void	storeMaskDefinition(java.lang.String maskName, com.saperion.ngc.iform.xml.Form mask)	Stores the given form as mask with the given name.
void	updateFolder(FolderId id, java.util.Properties nameValuePairs)	Updates the properties of a folder.

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

isActive

Field Detail

NO_LIMIT_MAX_NR_OF_NODES_PER_LEVEL

static final int NO_LIMIT_MAX_NR_OF_NODES_PER_LEVEL

Constraint, which defines the max limit of nodes per level.

See Also:

Constant Field Values

Method Detail

getMaskDefinition

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

Retrieves the mask definition with the given name.

Parameters:

maskName - Mask definition name

Returns:

Form

Throws:

SystemException - system exception

UnsupportedFormException - when the form can not be used in WebClient

AuthenticationException - authentication exception

getMaskDefinition

com.saperion.ngc.iform.xml.Form getMaskDefinition(java.lang.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.

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

storeMaskDefinition

void storeMaskDefinition(java.lang.String maskName,
                         com.saperion.ngc.iform.xml.Form mask)
                  throws javax.xml.bind.JAXBException

Stores the given form as mask with the given name.

Parameters:

maskName - Mask name

mask - Mask form

Throws:

javax.xml.bind.JAXBException - JAXBException

getInboxId

int getInboxId()
        throws AuthenticationException,
               SystemException

Reads the inbox id for the current user.

Returns:

Inbox id

Throws:

SystemException - system exception

AuthenticationException - authentication exception

getNavigationTree

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

Returns the navigation tree.

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

getWorkflowNodes

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

Reads the workflow tree part.

Parameters:

navigationNode - parent node

Returns:

Workflow tree

Throws:

NavigationException - navigation exception

AuthenticationException - Authentication exception

SystemException - system exception

DatabaseException - database exception

getFolderTree

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

Generates a folder tree stated at .

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

getFolderByPath

FolderNode getFolderByPath(java.lang.String ddc,
                           java.lang.String path)
                    throws NavigationException,
                           AuthenticationException,
                           SystemException,
                           DatabaseException,
                           UnknownFolderTypeException

Search a folder by path.

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

getFolderById

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

Search a folder by id.

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

resolveLink

FolderId resolveLink(FolderId linkId)
              throws NavigationException,
                     AuthenticationException

Resolves a link folder and returns the link destination.

Parameters:

linkId - Link folder id

Returns:

Destination folder id

Throws:

NavigationException - navigation exception

AuthenticationException - Authentication exception

getNextLevelFolders

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

Returns the folders of the next level.

Parameters:

node - node

filter - filter

allowedMaxNrOfNodesPerLevel - allowedMaxNrOfNodesPerLevel

Returns:

navigation node containing next level child nodes

Throws:

SystemException - system exception

AuthenticationException - authentication exception

NavigationException - navigation exception

DatabaseException - database exception

UnknownFolderTypeException - when a folder with an unknown type is found

deleteFolder

void deleteFolder(NavigationNode node)
           throws AuthenticationException,
                  SystemException

Deletes the given folder.

Parameters:

node - navigation node

Throws:

SystemException - system exception

AuthenticationException - authentication exception

addFolder

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

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

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

addLinkFolder

NavigationNode addLinkFolder(NavigationNode node,
                             java.lang.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.

Parameters:

node - parent node

childName - name of new child node to add

destination - Destination folder id

Returns:

node containing new child

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

addWebpartFolder

NavigationNode addWebpartFolder(NavigationNode node,
                                java.lang.String childName,
                                java.lang.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.

Parameters:

node - parent node

childName - name of new child node to add

destination - Destination webpart id

Returns:

node containing new child

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

renameFolder

NavigationNode renameFolder(NavigationNode node,
                            java.lang.String name)
                     throws SystemException,
                            NavigationException

Renames folder.

Parameters:

node - Node

name - Name

Returns:

renamed folder

Throws:

SystemException - system exception

NavigationException - navigation exception

moveFolder

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

Moves folder.

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

copyFolder

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

Copies a folder to the specified location.

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

addFavoriteFolder

FolderId addFavoriteFolder(java.lang.String name,
                           java.util.Properties props,
                           java.lang.String content)
                    throws AuthenticationException,
                           SystemException,
                           DatabaseException,
                           UnknownFolderTypeException,
                           InvalidFolderNameException

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

Parameters:

name - Folder name

props - Properties

content - Content

Returns:

Folder id

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

addToFolder

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

Adds documents to the specified folders.

Parameters:

folderIds - folder ids

documentIDs - ids of documents

Throws:

SystemException - system exception

AuthenticationException - authentication exception

NavigationException - navigation exception

DatabaseException - database exception

removeFromFolder

void removeFromFolder(java.util.Set<FolderId> folderIds,
                      DocumentId documentId)
               throws SystemException,
                      AuthenticationException

Removes the specified document from a folder.

Parameters:

folderIds - folders to remove from

documentId - ID of document to remove

Throws:

SystemException - system exception

AuthenticationException - authentication exception

getBoxCount

@Deprecated
java.lang.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.

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.

getBoxTotalAndUnreadCount

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.

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.

getBoxTotalAndUnreadCounts

java.util.Map<java.lang.Integer,com.saperion.wf.BoxCount> getBoxTotalAndUnreadCounts(java.util.Set<java.lang.Integer> boxId)
                                                                                    throws com.saperion.exception.SaAuthenticationException,
                                                                                           com.saperion.exception.SaSystemException

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

Parameters:

boxId - 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.

getDocumentFolders

java.util.List<FolderId> getDocumentFolders(DocumentId id)
                                     throws SystemException,
                                            AuthenticationException

Retrieves the folders that contain the specified document.

Parameters:

id - document's id

Returns:

list of folder document infos

Throws:

SystemException - system exception

AuthenticationException - authentication exception

getDocumentFolderCount

long getDocumentFolderCount(DocumentId id)
                     throws SystemException,
                            AuthenticationException

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

Parameters:

id - document's id

Returns:

folder count

Throws:

SystemException - system exception

AuthenticationException - authentication exception

setFolderAcl

void setFolderAcl(FolderId folderId,
                  java.lang.String acl)
           throws SystemException,
                  AuthenticationException

Sets ACL for folder.

Parameters:

folderId - folderId

acl - set of ACL names

Throws:

SystemException - system exception

AuthenticationException - authentication exception

getFolderAcl

java.util.List<java.lang.String> getFolderAcl(FolderId folderId)
                                       throws SystemException,
                                              AuthenticationException

Gets ACL for folder.

Parameters:

folderId - folderId

Returns:

list of ACL names

Throws:

SystemException - system exception

AuthenticationException - authentication exception

getFolderTables

java.util.List<java.lang.String> getFolderTables()
                                          throws SystemException,
                                                 AuthenticationException

Reads all folder table names.

Returns:

List of folder table names

Throws:

SystemException - System exception

AuthenticationException - authentication exception

hasFolder

boolean hasFolder(java.lang.String folderId)
           throws SystemException,
                  AuthenticationException

Parameters:

folderId - Folder ID

Returns:

True, if folder exists.

Throws:

SystemException - System exception

AuthenticationException - authentication exception

getFolderInfo

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

Retrieves information about the specified folder.

Parameters:

id - folder id

Returns:

folder info

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

NavigationException - navigation exception

updateFolder

void updateFolder(FolderId id,
                  java.util.Properties nameValuePairs)
           throws SystemException,
                  AuthenticationException,
                  DatabaseException

Updates the properties of a folder.

Parameters:

id - id of the folder to update

nameValuePairs - properties to update

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

getFolderClass

FolderClass getFolderClass(java.lang.String className)
                    throws SystemException,
                           AuthenticationException,
                           DatabaseException

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

Parameters:

className - class name

Returns:

folder class or null if not found

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

getFolderClassesForDDC

java.util.Set<FolderClass> getFolderClassesForDDC(java.lang.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.

Parameters:

ddcName - DDC name

classType - the type of class to search for

Returns:

set of folder classes

Throws:

SystemException - system exception

AuthenticationException - authentication exception

deleteFolderById

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

Deletes the folder identified by the specified id.

Parameters:

id - folder id

Throws:

NavigationException - navigation exception

DatabaseException - database exception

AuthenticationException - authentication exception

SystemException - system exception

getFolderChildren

java.util.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.

Parameters:

id - folder id

Returns:

list of children

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DatabaseException - database exception

NavigationException - navigation exception

getFolderUpdateInfo

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

Get Set of folders to refresh on client side.

Parameters:

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

Returns:

Set of folders that shall be refreshed.

Throws:

AuthenticationException - error on the authentification / insufficient rights

SystemException - general error

getTaskCounts

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.

Returns:

global count

Throws:

AuthenticationException - not logged in or not allowed

SystemException - system error when checking for tasks