com.saperion.ngc.events.navigation

Class FolderSearchInfos

java.lang.Object

com.saperion.ngc.events.navigation.FolderSearchInfos

All Implemented Interfaces:

Serializable

public class FolderSearchInfos
extends Object
implements Serializable

Bean that holds information needed to search for folders or to search for folder content.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderSearchInfos.FolderSearchMode Folder search modes.

Constructor Summary

Constructors

Constructor and Description
FolderSearchInfos(FolderId navigationParentNode, FolderId containingFolder, FolderSearchInfos.FolderSearchMode searchMode) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
FolderId	getContainingFolder()
FolderId	getNavigationParent()
FolderSearchInfos.FolderSearchMode	getSearchMode()

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderSearchInfos

public FolderSearchInfos(FolderId navigationParentNode,
                 FolderId containingFolder,
                 FolderSearchInfos.FolderSearchMode searchMode)

Constructor.

Parameters:

navigationParentNode - parent node of a file or null

containingFolder - folder containing the documents or subfolders

searchMode - search mode

Method Detail

getNavigationParent

public FolderId getNavigationParent()

Returns:

the application node in the navigation view used to start the search

getContainingFolder

public FolderId getContainingFolder()

Returns:

id of the folder containing the documents or subfolders

getSearchMode

public FolderSearchInfos.FolderSearchMode getSearchMode()

Returns:

search mode