|
Oracle® Collaboration Suite Workspaces API Reference 10g (10.1.1.0.2) Part No. B16233-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.workspaces.resource.CwResource
oracle.workspaces.resource.calendar.CwCalendarResource
This class represents workspace calendar resource/service (meetings and tasks).
Method Summary | |
CwEvent |
createEvent(CwEventDefinition eventDef) Creates an event in the workspace agenda and returns it. |
CwTask |
createTask(CwTaskDefinition taskDef) Creates a to-do task in the workspace agenda and returns it. |
void |
deleteAllEventInstances(CwUid uid) Deletes all event instances of a repeating event in the workspace agenda. |
void |
deleteEvent(CwEvent event) Deletes a single event instance in the workspace agenda. |
void |
deleteEvent(CwUid uid) Deletes an event instance in the workspace agenda. |
void |
deleteEvents(CwUid[] uids) Deletes event instances in the workspace calendar. |
void |
deleteTask(CwUid uid) Deletes a to-do task in the workspace agenda. |
void |
deleteTasks(CwUid[] uids) Deletes to-do tasks in the workspace agenda. |
CwEvent[] |
getAllEventInstances(CwUid eventUid) Get all event instances of a repeating event. |
CwAttendeeFreeBusy[] |
getAttendeeFreeBusys(CwCalendarAttendee[] attendees, java.util.Date beginTime, java.util.Date endTime) Returns the results of given users/resources free busy status given a time frame. |
CwEvent |
getEventByUid(CwUid eventUid) Get an event instance in the workspace agenda by its uid. |
CwFreeBusy[] |
getFreeBusys(CwUser[] users, java.util.Date beginTime, java.util.Date endTime) Returns the combined results of given users' free busy status given a time frame. |
CwFreeBusy[] |
getFreeBusys(java.util.Date beginTime, java.util.Date endTime) Returns the current user's free busy status given a time frame. |
CwResourceItem |
getItemByUid(CwUid uid) Returns the resource item for the given UID. |
java.lang.String |
getMappedWspcEntityGuid() A convenience method to retieve mapped Workspace Entity Guid |
CwTask[] |
getMyTasks() Gets all tasks that are assigned to the user or his or her group. |
CwTask[] |
getMyTasks(boolean bSort) Gets all tasks that are assigned to the user or his or her group. |
CwEvent[] |
getNewEvents(java.util.Date beginDate, java.util.Date endDate, boolean bSort) Get new events in workspaces agenda that expect current user's reply and occur within the time range specified. |
CwResourceItem[] |
getRecentActivities() Returns a list of recent events. |
CwTask |
getTaskByUid(CwUid taskUid) Gets a to-do task in the workspace agenda by its uid. |
java.lang.String |
getWorkspaceEntityOnCalendar() Returns the mapped workspace entity name on Calendar. |
boolean |
isFreeByRange(CwUser[] users, java.util.Date beginTime, java.util.Date endTime) Returns true if the given users are free within the given time frame. |
CwTask[] |
listAllCompletedTasks(boolean bSort) Get all completed tasks in this workspace agenda. |
CwEvent[] |
listAllEvents(boolean bSort) Get all events in this workspace agenda. |
CwTask[] |
listAllIncompleteTasks(boolean bSort) Get all incomplete tasks in this workspace agenda. |
CwTask[] |
listAllTasks(boolean bSort) Get all tasks in this workspace agenda. |
CwEvent[] |
listEventsByRange(java.util.Date beginDate, java.util.Date endDate, boolean bSort) Get events in workspace agenda that occur within the time range specified. |
CwResourceBulkResponse |
listEventsByUid(CwUid[] eventUids) Gets event instances in the workspace agenda by it UIDs. |
CwResourceBulkResponse |
listItemsByUids(CwUid[] uids) Returns the requested resource items. |
CwTask[] |
listTasksByRange(java.util.Date beginTime, java.util.Date endTime, boolean bSort) Get tasks which are active within the time range specified. |
CwResourceBulkResponse |
listTasksByUid(CwUid[] taskUids) Gets to-do tasks in the workspace agenda given the UIDs. |
Methods inherited from class oracle.workspaces.resource.CwResource |
getProperties, getStatus, getUid, getWorkspace, storeProperties |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public CwEvent createEvent(CwEventDefinition eventDef) throws CwException
eventDef
- the event definition for the new event to be createdCwException
public CwTask createTask(CwTaskDefinition taskDef) throws CwException
taskDef
- the task definition for the new task to be createdCwException
public void deleteAllEventInstances(CwUid uid) throws CwException
uid
- the UID of the event to be deleted Note: If this is called upon a non-repeating event, it is the same as deleteEvent().CwException
public void deleteEvent(CwEvent event) throws CwException
event
- Event instance to be deleted.CwException
deleteEvent(CwUid)
, deleteAllEventInstances(CwUid)
public void deleteEvent(CwUid uid) throws CwException
uid
- the UID of the event instance to be deletedCwException
deleteEvent(CwEvent)
, deleteAllEventInstances(CwUid)
public void deleteEvents(CwUid[] uids) throws CwException
uids
- the UIDs of the event instances to be deleted Note: To delete all instance of a repeating event, call deleteAllEventInstances()CwException
public void deleteTask(CwUid uid) throws CwException
uid
- the UID of the task to be droppedCwException
public void deleteTasks(CwUid[] uids) throws CwException
uids
- the UIDs of the tasks to be droppedCwException
public CwEvent[] getAllEventInstances(CwUid eventUid) throws CwException
CwException
public CwAttendeeFreeBusy[] getAttendeeFreeBusys(CwCalendarAttendee[] attendees, java.util.Date beginTime, java.util.Date endTime) throws CwException
attendees
- Attendees to check upon.beginTime
- Begin of the time frameendTime
- End of the time frameCwException
CwAttendeeFreeBusy
public CwEvent getEventByUid(CwUid eventUid) throws CwException
CwException
public CwFreeBusy[] getFreeBusys(CwUser[] users, java.util.Date beginTime, java.util.Date endTime) throws CwException
users
- Users to check upon.beginTime
- Begin of the time frameendTime
- End of the time frame Note: In the returned results (assume it is called "freeBusys") 1. freeBusys[0].getStartTime() is the same as beginTime, 2. freeBusys[results.length-1].getEndTime(0 is the same as endTime 3. freeBusys' time frame are in assending order. 4. There should be no time frame overlap between freeBusys[i] and freeBusys[i+1].CwException
public CwFreeBusy[] getFreeBusys(java.util.Date beginTime, java.util.Date endTime) throws CwException
beginTime
- Begin of the time frameendTime
- End of the time frame Note: In the returned results (assume it is called "freeBusys") 1. freeBusys[0].getStartTime() is the same as beginTime, 2. freeBusys[results.length-1].getEndTime(0 is the same as endTime 3. freeBusys' time frame are in assending order. 4. There should be no time frame overlap between freeBusys[i] and freeBusys[i+1].CwException
public CwResourceItem getItemByUid(CwUid uid) throws CwException
getItemByUid
in class CwResource
uid
- UID of the item to be retrieved.CwException
public java.lang.String getMappedWspcEntityGuid()
public CwTask[] getMyTasks() throws CwException
#getMyTasks(false)
.CwException
public CwTask[] getMyTasks(boolean bSort) throws CwException
bSort
- true to sort by endTime in ascending order, false to whatever arbitrary order returned from Calendar APICwException
public CwEvent[] getNewEvents(java.util.Date beginDate, java.util.Date endDate, boolean bSort) throws CwException
bSort
- specifies that results will be sorted in starttime (ascending)CwException
public final CwResourceItem[] getRecentActivities() throws CwException
getRecentActivities
in class CwResource
CwException
public CwTask getTaskByUid(CwUid taskUid) throws CwException
taskUid
- the Uid of the task that needs to be fetchedCwException
public java.lang.String getWorkspaceEntityOnCalendar()
public boolean isFreeByRange(CwUser[] users, java.util.Date beginTime, java.util.Date endTime) throws CwException
users
- Users to check upon.beginTime
- Begin of the time frameendTime
- End of the time frameCwException
public CwTask[] listAllCompletedTasks(boolean bSort) throws CwException
bSort
- true specifies that results will be sorted in ascending order of start-time. false specifies that results will not be sorted.CwException
listTasksByRange(Date,Date,boolean)
public CwEvent[] listAllEvents(boolean bSort) throws CwException
bSort
- true specifies that results will be sorted in ascending order of start-time. false specifies that results will not be sorted.CwException
listEventsByRange(Date,Date,boolean)
public CwTask[] listAllIncompleteTasks(boolean bSort) throws CwException
bSort
- true specifies that results will be sorted in ascending order of start-time. false specifies that results will not be sorted.CwException
listTasksByRange(Date,Date,boolean)
public CwTask[] listAllTasks(boolean bSort) throws CwException
bSort
- true specifies that results will be sorted in ascending order of start-time. false specifies that results will not be sorted.CwException
listTasksByRange(Date,Date,boolean)
public CwEvent[] listEventsByRange(java.util.Date beginDate, java.util.Date endDate, boolean bSort) throws CwException
bSort
- specifies that results will be sorted in starttime (ascending)CwException
public CwResourceBulkResponse listEventsByUid(CwUid[] eventUids) throws CwException
CwException
public CwResourceBulkResponse listItemsByUids(CwUid[] uids) throws CwException
listItemsByUids
in class CwResource
uids
- UIDs of the resource items to be retrieved.CwException
public CwTask[] listTasksByRange(java.util.Date beginTime, java.util.Date endTime, boolean bSort) throws CwException
beginTime
- the begin point of the time rangeendTime
- the end point of the time rangebSort
- specifies that results will be sorted in starttime (ascending)CwException
public CwResourceBulkResponse listTasksByUid(CwUid[] taskUids) throws CwException
taskUids
- the array containing uid of the tasks that need to be fetchedCwException
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |