lumis.service.document
Interface IDocumentManager

All Known Implementing Classes:

DocumentManager

public interface IDocumentManager

Field Summary

static int

TYPE_ALL

Method Summary

DocumentConfig	get(SessionConfig sessionConfig, String documentId, ITransaction transaction) Returns the DocumentConfig for a document with the given id.
Collection<DocumentConfig>	getChildren(SessionConfig sessionConfig, String serviceInstanceId, String folderId, int type, ITransaction transaction) Returns the entries in the specified folder.
Collection<String>	getFolderIdsByParentAndName(SessionConfig sessionConfig, String serviceInstanceId, String parentFolderId, String folderName, ITransaction transaction) Returns the ids of the folders child of the given parent and with the given name.
String	getFolderPath(SessionConfig sessionConfig, String folderId, ITransaction transaction) Returns the virtual path to the folder.
void	moveDocument(SessionConfig sessionConfig, String documentId, String destFolderId, ITransaction transaction) Moves a document (or a folder) to another folder.

Field Detail

TYPE_ALL

static final int TYPE_ALL

See Also:

Constant Field Values

Method Detail

get

DocumentConfig get(SessionConfig sessionConfig,
                   String documentId,
                   ITransaction transaction)
                   throws PortalException

Returns the DocumentConfig for a document with the given id.

Parameters:

sessionConfig - identifier for the session.

documentId - the id of the document.

transaction - the transaction for persistence access.

Returns:

the DocumentConfig for the document, or null if it is not found.

Throws:

PortalException

getFolderIdsByParentAndName

Collection<String> getFolderIdsByParentAndName(SessionConfig sessionConfig,
                                               String serviceInstanceId,
                                               String parentFolderId,
                                               String folderName,
                                               ITransaction transaction)
                                               throws PortalException

Returns the ids of the folders child of the given parent and with the given name.

Parameters:

sessionConfig - identifier for the session.

serviceInstanceId - the content's service instance id.

parentFolderId - the parent folder's id. Null if the folder must not have parent.

folderName - the folder name.

transaction - the transaction for persistence access.

Returns:

Throws:

PortalException

getChildren

Collection<DocumentConfig> getChildren(SessionConfig sessionConfig,
                                       String serviceInstanceId,
                                       String folderId,
                                       int type,
                                       ITransaction transaction)
                                       throws PortalException

Returns the entries in the specified folder.

Parameters:

sessionConfig - identifier for the session.

serviceInstanceId - the document service instance id.

folderId - the id of the folder.

type - the entry types to be returned. Must be DocumentConfig.TYPE_FOLDER, DocumentConfig.TYPE_DOCUMENT or TYPE_ALL.

transaction - the transaction for persistence access.

Returns:

the entries in the specified folder, or an empty collection if none is found.

Throws:

PortalException

getFolderPath

String getFolderPath(SessionConfig sessionConfig,
                     String folderId,
                     ITransaction transaction)
                     throws PortalException

Returns the virtual path to the folder.

Parameters:

sessionConfig - identifier for the session.

folderId - the id of the folder.

transaction - the transaction for persistence access.

Returns:

the virtual path to the folder.

Throws:

PortalException

moveDocument

void moveDocument(SessionConfig sessionConfig,
                  String documentId,
                  String destFolderId,
                  ITransaction transaction)
                  throws PortalException

Moves a document (or a folder) to another folder.

Parameters:

sessionConfig - identifier for the session.

documentId - the document's id.

destFolderId - the id of the destination folder.

transaction - the transaction for persistence access.

Throws:

PortalException