com.plumtree.remote.prc
Interface IDocumentFolderManager

public interface IDocumentFolderManager

Interface that provides remote access to the portal Knowledge Directory's folder structure. Applications can call these methods to get information about folders.

Method Summary

IObjectQueryRow	getFolder(int folderID) Queries properties of the specified folder in the Knowledge Directory.
IObjectQueryRow	getFolder(java.lang.String folderPath) Queries properties of the specified folder in the Knowledge Directory.
IObjectQueryRow	getRootFolder() Queries properties of the root folder in the Knowledge Directory.
IObjectQuery	getSubFolders(int folderID) Queries the subfolders and their properties of a specified folder in the Knowledge Directory.
IObjectQuery	getSubFolders(int folderID, int startRow, int maxRows, ObjectProperty sortProperty, QueryFilter[] filters) Queries the subfolders and their properties for a specified folder in the Knowledge Directory.

Method Detail

getRootFolder

public IObjectQueryRow getRootFolder()
                              throws PortalException,
                                     java.rmi.RemoteException

Queries properties of the root folder in the Knowledge Directory.

Returns:

the root folder's properties

Throws:

PortalException - if the operation resulted in an error in the portal

RemoteException - if there was a communication problem during the execution of the remote method call

getFolder

public IObjectQueryRow getFolder(int folderID)
                          throws PortalException,
                                 java.rmi.RemoteException

Queries properties of the specified folder in the Knowledge Directory.

Parameters:

folderID - the ID of the folder on which to gather properties

Returns:

the folder's properties

Throws:

java.lang.IllegalArgumentException - if the folderID is < 0

PortalException - if the operation resulted in an error in the portal

RemoteException - if there was a communication problem during the execution of the remote method call

getFolder

public IObjectQueryRow getFolder(java.lang.String folderPath)
                          throws PortalException,
                                 java.rmi.RemoteException

Queries properties of the specified folder in the Knowledge Directory.

Parameters:

folderPath - the path to the folder on which to gather properties (for example, \Knowledge Directory\Unclassified Documents) Note: The slash must be escaped.

Returns:

the folder's properties

Throws:

java.lang.IllegalArgumentException - if the FolderPath does not start with a \

PortalException - if the operation resulted in an error in the portal

RemoteException - if there was a communication problem during the execution of the remote method call

getSubFolders

public IObjectQuery getSubFolders(int folderID)
                           throws PortalException,
                                  java.rmi.RemoteException

Queries the subfolders and their properties of a specified folder in the Knowledge Directory.

Parameters:

folderID - the parent folder ID

Returns:

the subfolders and their properties

Throws:

PortalException - if the operation resulted in an error in the portal

RemoteException - if there was a communication problem during the execution of the remote method call

getSubFolders

public IObjectQuery getSubFolders(int folderID,
                                  int startRow,
                                  int maxRows,
                                  ObjectProperty sortProperty,
                                  QueryFilter[] filters)
                           throws PortalException,
                                  java.rmi.RemoteException

Queries the subfolders and their properties for a specified folder in the Knowledge Directory.

Parameters:

folderID - the parent folder ID

startRow - the first row to retrieve (row numbers are zero-based)

maxRows - the number of rows to retrieve; if set to -1, all rows are retrieved

sortProperty - the property on which to sort the query (specified using DocumentFolderProperty)

filters - an array of query filters to narrow down the search

Returns:

the subfolders and their properties

Throws:

PortalException - if the operation resulted in an error in the portal

RemoteException - if there was a communication problem during the execution of the remote method call