IDocumentDescription Interface
Defines the Description of a document in Pam.Archive
Namespace: Pam.ArchiveAssembly: inPoint.Archive.API (in inPoint.Archive.API.dll) Version: 2025.1
public interface IDocumentDescription
| Archive |
the archive, where this document is from
|
| ArchiveUnit |
the unit, where this document is from
|
| Changed |
true, if the document was changed by the client.
|
| CheckOutDate |
the document was locked at this date (can be null if not known)
|
| CheckOutMachine |
document is locked on this machine
|
| CheckOutStatus |
CheckOut state of this document (if it is locked by a user or not)
|
| CheckOutUser |
document is locked by this user
|
| CheckOutUserId |
the document is locked by this user (given by id, can be null if not known)
|
| ContentCount |
Logical count of the contents.
|
| CreationDate |
the document was created on this date
|
| Creator |
the document was created by this user
|
| DeletedState |
A flag if a document is marked as logical deleted (it's in the recycle-bin then).
The status can only be changed by DeleteLogical(EID) and RestoreLogical(EID) |
| DocCreatorId |
The ID of the user who created this document (optional).
|
| DocID |
the id of this document
|
| DocumentType |
The type of the document (e.g. Normal or WorkflowReport).
|
| Eid |
the unique Id of this document
|
| ExplicitRetentionDate |
Enables the caller to explicitly set a retention date for all contents while saving a document.
(This value is only used during archive and will not be set during read!)
|
| ExplicitRetentionTimeMonths |
Enables the caller to explicitly set a retention time for all contents while saving a document.
(This value is only used during archive and will not be set during read!)
|
| ExplicitStorageSchemeId |
Enables the caller to explicitly set a HSM or HybridStore scheme for all contents while saving a document.
(This value is only used during archive and will not be set during read!)
|
| ExtensionExists |
true if there are any extensions for this document.
|
| IsDeleted |
A flag if a document is marked as logical deleted (it's in the recycle-bin then).
The status can only be changed by DeleteLogical(EID) and RestoreLogical(EID) |
| IsShelvedVersion |
If this is true, this version of the document is shelved. Only the user who has checked it out, will be able to see this version, all other user will see a different version.
|
| LastModifiedDate |
date of the last change
|
| LastModifiedId |
The ID of the user who last changed this document (optional).
|
| LastModifiedMachine |
last change was done on this machine.
|
| LastModifiedUser |
last change was done by this user.
|
| UserProps |
a list of all additional user properties (the list is read-only, the values are not)
|
| Version |
Version of this document
|
| GetUserValueT |
Tries to get a value from the user properties, if it's not existing a default will be returned.
|
| GetValueT |
Tries to get a value from the user or system properties, if it's not existing a default will be returned
|