com.ibm.pim.collaboration
Interface CollaborationHistoryEvent


public interface CollaborationHistoryEvent

The Java API interface CollaborationHistoryEvent represents a collaboration history event for a collaboration area.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 CollaborationStep getCollaborationStep()
          Get the collaboration step at which the event happened.
 java.lang.String getComment()
          Get the comment, which describes more about the event.
 java.util.Date getDate()
          Get the date and time at which the event happened.
 java.lang.String getDifferences()
          Get the differences between the item or category attributes before and after the event.
 java.lang.String getExitValue()
          Get the exit value associated with the event.
 java.lang.String getPrimaryKey()
          Get the primary key of the item or category involved in the event.
 java.lang.String getType()
          Get the type of the collaboration history event.
 User getUser()
          Get the user who initiated the collaboration event.
 

Field Detail

copyright

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

getDate

java.util.Date getDate()
Get the date and time at which the event happened.

Returns:
The time for the event, as a Date object.
Throws:
PIMInternalException - if there is an internal error.

getPrimaryKey

java.lang.String getPrimaryKey()
Get the primary key of the item or category involved in the event.

Returns:
The primary key value for the event.
Throws:
PIMInternalException - if there is an internal error.

getComment

java.lang.String getComment()
Get the comment, which describes more about the event.

Returns:
The comment for the event.
Throws:
PIMInternalException - if there is an internal error.

getExitValue

java.lang.String getExitValue()
Get the exit value associated with the event.

Returns:
The exit value for the event.
Throws:
PIMInternalException - if there is an internal error.

getDifferences

java.lang.String getDifferences()
Get the differences between the item or category attributes before and after the event.

Returns:
The differences.
Throws:
PIMInternalException - if there is an internal error.

getType

java.lang.String getType()
Get the type of the collaboration history event.

Returns:
the collaboration history event type.
Throws:
PIMInternalException - if there is an internal error.

getUser

User getUser()
Get the user who initiated the collaboration event.

Returns:
The user, as a User object.
Throws:
PIMInternalException - if there is an internal error.

getCollaborationStep

CollaborationStep getCollaborationStep()
Get the collaboration step at which the event happened.

Returns:
The collaboration step, as a CollaborationStep object.
Throws:
PIMInternalException - if there is an internal error.
See Also:
CollaborationStep