com.ibm.pim.docstore
Interface DocumentAuditLog


public interface DocumentAuditLog

This interface represents audit log of a document. The document audit log holds details such as the type of access on the document, the user who accessed the document and the time at which the document was accessed.

Since:
6.0.0

Nested Class Summary
static class DocumentAuditLog.AccessType
          Enumeration specifying document access types.
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.Date getAccessedDate()
          Fetches the date and time at which this document was accessed.
 DocumentAuditLog.AccessType getAccessType()
          Specifies whether the user performed a read or a write operation on the document.
 Document getDocument()
          Fetches the document to which the log belongs
 User getUser()
          Fetches the user who accessed the document
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getUser

User getUser()
Fetches the user who accessed the document

Returns:
User object.
Throws:
PIMInternalException - If an internal error occurred.
PIMAuthorizationException - Reserved for future use.

getAccessType

DocumentAuditLog.AccessType getAccessType()
Specifies whether the user performed a read or a write operation on the document.

Returns:
The type of operation performed by the user.
Throws:
PIMInternalException - If an internal error occurred.

getAccessedDate

java.util.Date getAccessedDate()
Fetches the date and time at which this document was accessed.

Returns:
Date object containing date and time of access.
Throws:
PIMInternalException - If an internal error occurred.

getDocument

Document getDocument()
Fetches the document to which the log belongs

Returns:
The document to which the log belongs
Throws:
PIMInternalException - If an internal error occurred.