Plumtree EDK (Enterprise Web Development Kit) 5.4.0

Plumtree.Remote.PRC.Collaboration.Document Namespace

Provides classes and interfaces for creating, modifying, managing, and querying for Collaboration document folders and documents. See Document Examples

Since EDK 5.1

Namespace hierarchy

Classes

Class	Description
DocumentFolderQueryOrder	`DocumentFolderQueryOrder` represents a pair that consists of a `DocumentFolderAttributes` and a boolean value indicating whether to order ascending. This class is used in `IFilter`.
DocumentQueryOrder	`DocumentQueryOrder` represents a pair that consists of a `DocumentAttributes` and a boolean value indicating whether to order ascending. This class is used in `IFilter`.

Interfaces

Interface	Description
IDocument	This interface represents a document, or more specifically, a collection of meta-data about a collaboration document. To retrieve an existing document, use `IDocumentManager.GetDocument`. To insert a new document, first obtain a new empty `IDocument` using `IDocumentManager.CreateNewDocument`, possibly set some of the meta-data such as author, then call `IDocumentManager.InsertNewDocument`. To retrieve the actual content of a saved document, call `GetContentAsInputStream()` Any modification of a document will not be stored permanently until `Store` is called.
IDocumentFilter	Filters used for querying Documents.
IDocumentFolder	This interface represents a document folder or a collection of meta-data about a document folder. To retrieve an existing folder use `IDocumentManager.GetFolder`. To insert a newly created folder, first obtain a new empty folder using `IDocumentManager.CreateNewFolder`, set some of the meta-data, then store the document folder by calling `IDocumentManager.InsertNewFolder`. Any modification or updates of the meta-data of a document folder will not be stored permanently until `Store` is called.
IDocumentFolderFilter	Filters used for querying Document folders.
IDocumentManager	Interface for managing `IDocument` and `IDocumentFolder` functionality. It handles creation, copying, removal and querying for documents and document folders. See Document Examples.

Enumerations

Enumeration	Description
DocumentAttributes	An enumerated type used to describe the specific fields that can be used in constructing a `DocumentQueryOrder` for documents.
DocumentFilterTypes	An enumerated type used to describe the possible filter types for documents. It is used in `IDocumentFilter.FilterType`.
DocumentFolderAttributes	An enumerated type used to describe the specific fields that can be used in constructing a `DocumentFolderQueryOrder` for document folders.
DocumentFolderPermissions	An enumerated type used to describe the permissions for document folders. It is used in `IDocument.IsActionAllowed` method.
DocumentPermissions	An enumerated type used to describe the permissions for Documents. This is used in `IDocument.IsActionAllowed` method.