|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
CollaborationArea getCollaborationArea()
PIMInternalException
- if there is an internal error.
PIMAuthorizationException
- if the current user does not have the equivalent of
Permission.COLLABORATION_AREA_LIST
.CollaborationObject.Type getType()
PIMInternalException
- if there is an internal error.java.util.List<CollaborationStep> getSteps()
PIMInternalException
- if there is an internal error.java.util.List<CollaborationHistoryEvent> getCollaborationHistory()
PIMInternalException
- if there is an internal error.java.util.List<CollaborationHistoryEvent> getCollaborationHistory(java.util.Date beginDate, java.util.Date endDate)
beginDate
- the start date for the history (inclusive)endDate
- the end date for the history (inclusive)
PIMInternalException
- if there is an internal error.java.util.Date getEntranceDate()
PIMInternalException
- if there is an internal error.java.lang.String getLatestComment()
PIMInternalException
- if there is an internal error.boolean isReserved()
PIMInternalException
- if there is an internal error.boolean isReserved(CollaborationStep step)
step
- the collaboration step in which to check the reserve status.
PIMInternalException
- if there is an internal error.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |