The Document namespace provides types and members that can be used for working with VisualVault Document objects. All Document objects are associated with a Folder. Major areas of functionality include library services functions such as check-in and check-out (which can be used for the transfer of binary files into and out of the vault), ability to modify or read meta-data, ability to view or modify the document state (archive, delete, purge, restore), compare the binary contents against another Document object, access multiple revisions, and view or modify the Document status (released, un-released).
| Class | Description |
|---|---|
| DeletedDocument | Represents a deleted Document |
| Document | Represents a revision of a Document and provides library services |
| DocumentAlreadyCheckedInException | Attempt to check in a Document when the Document was already Checked in |
| DocumentAlreadyCheckedOutException | Attempt to check out a Document when the Document was already Checked out |
| DocumentBase | |
| DocumentCheckOutException | Constructs the CheckOutError exception |
| DocumentCollection | |
| DocumentIndexField | |
| DocumentIndexFieldCollection | |
| DocumentNotFoundException | Thrown when requesting a Document and the Document was not found by its ID |
| DocumentRevisionCollection | |
| RelatedDocument | |
| RelatedDocumentCollection | |
| RevisionNotUniqueException | Revision was not unique. each document revision is required to have a different revision |
| Structure | Description |
|---|---|
| CheckedInInfo | |
| CheckedOutInfo | |
| LibraryStatus |
| Enumeration | Description |
|---|---|
| CheckInStatusType | Error type returned from checking in a document |
| CurrentDocumentState | Defines the state of a document as being Un-Released, Pending or Released |
| DocumentArchive | Defines the current Archive state of a Document |
| DocumentCheckInState | Defines the limited states that the user may set on a document as being Released or Un-Released |
| DocumentErrorType | Error type returned when retrieving a document |
| DocumentExpireAction | Defines the action to be taken when a document expires |
| DocumentIndexFieldObjectTypes | Specifies the type of IndexFields available |
| DocumentIndexFieldTypes | Specifies the type of IndexFields available in VisualVault |
| DocumentLatestState | Defines the state of a Document to return |
| DocumentRelationshipType | Defines the relations of a related Documents |
| DocumentState | Defines the possible Document state when creating a new Document |
| DocumentStatus | Defines the Document Library Status of a Document as being either Checked Out or Checked In |
| InputIndexFieldInputMode | Specifies the mode the input indexfield is in |