com.ibm.pim.collaboration
Interface CollaborationObject

All Known Subinterfaces:
CollaborationCategory, CollaborationItem

public interface CollaborationObject

The Java API interface CollaborationObject represents an object that can be checked out to a collaboration area and operated upon in a cooperative protocol. Currently the only CollaborationObjects are CollaborationItem and CollaborationCategory.

Since:
6.0.0
See Also:
CollaborationObject, CollaborationItem, CollaborationCategory

Nested Class Summary
static class CollaborationObject.Type
           
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 CollaborationArea getCollaborationArea()
          Get the collaboration area in which this object resides.
 java.util.List<CollaborationHistoryEvent> getCollaborationHistory()
          Get the collaboration area history of this object.
 java.util.List<CollaborationHistoryEvent> getCollaborationHistory(java.util.Date beginDate, java.util.Date endDate)
          Get the collaboration area history of this object between two dates.
 java.util.Date getEntranceDate()
          Get the most recent date this collaboration object was either checked out into its collaboration area or moved from another collaboration area into this one.
 java.lang.String getLatestComment()
          Get the most recent comment for this collaboration object (for any event).
 java.util.List<CollaborationStep> getSteps()
          Get all the collaboration steps holding this object.
 CollaborationObject.Type getType()
          Get the type of this collaboration object.
 boolean isReserved()
          Test whether this collaboration object is reserved (in any collaboration step).
 boolean isReserved(CollaborationStep step)
          Test whether this collaboration object is reserved in a given collaboration step.
 

Field Detail

copyright

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

getCollaborationArea

CollaborationArea getCollaborationArea()
Get the collaboration area in which this object resides.

Returns:
the collaboration area housing this object
Throws:
PIMInternalException - if there is an internal error.
PIMAuthorizationException - if the current user does not have the equivalent of Permission.COLLABORATION_AREA_LIST.

getType

CollaborationObject.Type getType()
Get the type of this collaboration object.

Returns:
the type of this collaboration object.
Throws:
PIMInternalException - if there is an internal error.

getSteps

java.util.List<CollaborationStep> getSteps()
Get all the collaboration steps holding this object.

Returns:
a list of collaboration steps holding this object, empty if there are none the user is authorized to access.
Throws:
PIMInternalException - if there is an internal error.

getCollaborationHistory

java.util.List<CollaborationHistoryEvent> getCollaborationHistory()
Get the collaboration area history of this object.

Returns:
a list containing the collaboration area history events of this object, empty if there are none the user is authorized to access.
Throws:
PIMInternalException - if there is an internal error.

getCollaborationHistory

java.util.List<CollaborationHistoryEvent> getCollaborationHistory(java.util.Date beginDate,
                                                                  java.util.Date endDate)
Get the collaboration area history of this object between two dates.

Parameters:
beginDate - the start date for the history (inclusive)
endDate - the end date for the history (inclusive)
Returns:
a list containing the collaboration area history events of this object within the specified date range, empty if there are none the user is authorized to access.
Throws:
PIMInternalException - if there is an internal error.

getEntranceDate

java.util.Date getEntranceDate()
Get the most recent date this collaboration object was either checked out into its collaboration area or moved from another collaboration area into this one.

Returns:
the most recent date this collaboration object was checked out or moved to this collaboration step.
Throws:
PIMInternalException - if there is an internal error.

getLatestComment

java.lang.String getLatestComment()
Get the most recent comment for this collaboration object (for any event).

Returns:
the most recent comment for this collaboration object.
Throws:
PIMInternalException - if there is an internal error.

isReserved

boolean isReserved()
Test whether this collaboration object is reserved (in any collaboration step).

Returns:
true if this collaboration object has been reserved, false otherwise.
Throws:
PIMInternalException - if there is an internal error.

isReserved

boolean isReserved(CollaborationStep step)
Test whether this collaboration object is reserved in a given collaboration step.

Parameters:
step - the collaboration step in which to check the reserve status.
Returns:
true if this collaboration object has been reserved in the specified step, false otherwise.
Throws:
PIMInternalException - if there is an internal error.