oracle.workspaces.ws
Interface MeetingsService

public interface MeetingsService

MeetingsService provides methods to operate on meetings in a workspace.

The major operations supported include:

• Creation of a meeting in the workspace agenda. Repeating meetings can also be created
• Updation of a meeting
• Retrieval of meeting(s)
• Listing of the meetings in a workspace
• Deletion of meeting
• Getting attendee(s)' free/busy status
• The code snippet given below, for an Axis Client, illustrates how a meeting can be created within a workspace.

     // Invoke an instance of meeting service locator and get a handle to meeting service.
     MeetingsServiceServiceLocator mssl = new MeetingsServiceServiceLocator();
     MeetingsService meetingService = mssl.getMeetingsService();
     //Create a meeting definition object
     MeetingDefinition mtngDef = new MeetingDefinition();
     mtngDef.setName("My Meeting1");
     mtngDef.setLocation("meetingRoom1");
     mtngDef.setDescription("Meeting1 description");
     mtngDef.setStartTime(new Calendar());
     mtngDef.setEndTime(toCal(en));
     mtngDef.setEventType("APPOINTMENT");
     mtngDef.setAttendingType("ALL");
     // invoke method to create a meeting
     meetingService.createMeeting(wspcId,mtngDef); 
     // wspcId is the Uid of workspace in which the meeting is created.
   
  

  Method Summary

  MeetingResourceItem	createMeeting(java.lang.String wspcId, MeetingDefinition eventDef) Creates a meeting in the workspace agenda and returns it.
  void	deleteAllMeetingInstances(java.lang.String wspcId, java.lang.String meetingId) Deletes all meeting instances of a repeating event in the workspace agenda.
  void	deleteMeeting(java.lang.String wspcId, java.lang.String meetingId) Deletes a single meeting instance in the workspace agenda
  AttendeeFreeBusy[]	getAttendeeFreeBusys(java.lang.String wspcId, java.util.Calendar beginTime, java.util.Calendar endTime, CalendarAttendee[] attendees) Returns the results of given users/resources free busy status given a time frame.
  MeetingResourceItem	getMeetingByUid(java.lang.String wspcId, java.lang.String meetingId) Get a meeting instance in the workspace agenda by its Id.
  MeetingResourceItem[]	getMeetingInstances(java.lang.String wspcId, java.lang.String meetingId) Get all instances of a repeating meeting.
  java.lang.String	getMyParticipationStatus(java.lang.String wspcId, java.lang.String meetingId) Returns participating status for the current user.
  MeetingResourceItem[]	listAllMeetings(java.lang.String wspcId, boolean bSort) Get all meetings in this workspace agenda.
  MeetingResourceItem[]	listMeetingsByRange(java.lang.String wspcId, java.util.Calendar beginDate, java.util.Calendar endDate, boolean bSort) Get meetings in workspace agenda that occur within the time range specified.
  void	setParticipationStatus(java.lang.String wspcId, java.lang.String meetingId, java.lang.String status, java.lang.String showAsFree) Sets the participating status for the current user.
  void	setParticipationStatusForAllInstances(java.lang.String wspcId, java.lang.String meetingId, java.lang.String status, java.lang.String showAsFree) Sets the participating status for the current user for all instances of this meeting.
  void	updateAllMeetingInstances(java.lang.String wspcId, MeetingResourceItem meetingResourceItem) Update all instances of repeating meeting.
  void	updateMeeting(java.lang.String wspcId, MeetingResourceItem meetingResourceItem) Update the meeting

  Method Detail

  createMeeting

  public MeetingResourceItem createMeeting(java.lang.String wspcId,
                                           MeetingDefinition eventDef)
                                    throws CwWSException
  

  Creates a meeting in the workspace agenda and returns it. If the definition specifies a repeating meeting, only the instance with the same start time as in definition will be returned. The returned meeting instance will have the specific repeating status set.

  Parameters:

  wspcId - - Id of the workspace

  eventDef - - The definition for the new meeting to be created

  Returns:

  MeetingResourceItem - Represents the meeting that was created.

  Throws:

  CwWSException - - If the workspace Id or the meeting definition properties are invalid.

  deleteMeeting

  public void deleteMeeting(java.lang.String wspcId,
                            java.lang.String meetingId)
                     throws CwWSException
  

  Deletes a single meeting instance in the workspace agenda

  Parameters:

  wspcId - - Id of the workspace

  meetingId - - Id of the meeting instance to be deleted

  Throws:

  CwWSException - - If the workspace Id or meeting Id is invalid.

  deleteAllMeetingInstances

  public void deleteAllMeetingInstances(java.lang.String wspcId,
                                        java.lang.String meetingId)
                                 throws CwWSException
  

  Deletes all meeting instances of a repeating event in the workspace agenda.

  Parameters:

  wspcId - - Id of the workspace

  meetingId - - Id of the meeting to be deleted

  Throws:

  CwWSException - - If the workspace Id or meeting Id is invalid.

  updateMeeting

  public void updateMeeting(java.lang.String wspcId,
                            MeetingResourceItem meetingResourceItem)
                     throws CwWSException
  

  Update the meeting

  Parameters:

  wspcId - - Id of the workspace

  meetingResourceItem - - The meetingResourceItem that needs to be updated

  Throws:

  CwWSException - - If the workspace Id or if the properties of the meeting resource item are invalid.

  updateAllMeetingInstances

  public void updateAllMeetingInstances(java.lang.String wspcId,
                                        MeetingResourceItem meetingResourceItem)
                                 throws CwWSException
  

  Update all instances of repeating meeting.

  Parameters:

  wspcId - - Id of the workspace

  meetingResourceItem - - The meetingResourceItem that needs to be updated

  Throws:

  CwWSException - - If the workspace Id or If the properties of the meeting resource item are invalid or If the meeting is not a repeating meeting or If the start date of the meeting is changed.

  listMeetingsByRange

  public MeetingResourceItem[] listMeetingsByRange(java.lang.String wspcId,
                                                   java.util.Calendar beginDate,
                                                   java.util.Calendar endDate,
                                                   boolean bSort)
                                            throws CwWSException
  

  Get meetings in workspace agenda that occur within the time range specified.

  Parameters:

  wspcId - - Id of the workspace

  beginDate - - Start date for the range

  endDate - - End date for the range

  bSort - - Specifies that results will be sorted in starttime (ascending)

  Returns:

  MeetingResourceItem[] - Represents the meetings.

  Throws:

  CwWSException - - If the workspace Id or the dates are invalid.

  getMeetingInstances

  public MeetingResourceItem[] getMeetingInstances(java.lang.String wspcId,
                                                   java.lang.String meetingId)
                                            throws CwWSException
  

  Get all instances of a repeating meeting.

  Parameters:

  wspcId - - Id of the workspace

  meetingId - - Id of the meeting

  Returns:

  MeetingResourceItem[] - Represents the meetings.

  Throws:

  CwWSException - - If the workspace Id or meeting Id is invalid.

  getAttendeeFreeBusys

  public AttendeeFreeBusy[] getAttendeeFreeBusys(java.lang.String wspcId,
                                                 java.util.Calendar beginTime,
                                                 java.util.Calendar endTime,
                                                 CalendarAttendee[] attendees)
                                          throws CwWSException
  

  Returns the results of given users/resources free busy status given a time frame.

  Parameters:

  wspcId - - Id of the workspace

  beginTime - - Start time for the range

  endTime - - End time for the range

  attendees - - Attendees to check upon

  Returns:

  AttendeeFreeBusy[] - Represents the free busy status of the users/resources.

  Throws:

  CwWSException - - If the workspace Id or dates are invalid or If the list of attendees is invalid.

  getMeetingByUid

  public MeetingResourceItem getMeetingByUid(java.lang.String wspcId,
                                             java.lang.String meetingId)
                                      throws CwWSException
  

  Get a meeting instance in the workspace agenda by its Id.

  Parameters:

  wspcId - - Id of the workspace

  meetingId - - Id of the meeting

  Returns:

  MeetingResourceItem - Represents the meeting requested for.

  Throws:

  CwWSException - - If the workspace Id or meeting Id is invalid.

  listAllMeetings

  public MeetingResourceItem[] listAllMeetings(java.lang.String wspcId,
                                               boolean bSort)
                                        throws CwWSException
  

  Get all meetings in this workspace agenda.

  Parameters:

  wspcId - - Id of the workspace

  bSort - - Specifies that results will be sorted in ascending order of start-time

  Returns:

  MeetingResourceItem[] - Represents all the meetings of the workspace.

  Throws:

  CwWSException - - If the workspace Id is invalid.

  getMyParticipationStatus

  public java.lang.String getMyParticipationStatus(java.lang.String wspcId,
                                                   java.lang.String meetingId)
                                            throws CwWSException
  

  Returns participating status for the current user.

  Parameters:

  wspcId - - Id of the workspace

  meetingId - - Id of the meeting

  Returns:

  String - Participating status of the current user. Values could be NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE (ACCEPT but prefer another time)

  Throws:

  CwWSException - - If the workspace Id or meeting Id is invalid.

  setParticipationStatus

  public void setParticipationStatus(java.lang.String wspcId,
                                     java.lang.String meetingId,
                                     java.lang.String status,
                                     java.lang.String showAsFree)
                              throws CwWSException
  

  Sets the participating status for the current user.

  Parameters:

  wspcId - - Id of the workspace

  meetingId - - Id of the meeting

  status - - Status to be set for the user for the meeting Values could be NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE (ACCEPT but prefer another time)

  showAsFree - - overwrite the free/busy status, and values could be FREE, BUSY , OUT, TENTATIVE

  Throws:

  CwWSException - - If the workspace Id or meeting Id is invalid or If the status or showAsFree values are invalid.

  setParticipationStatusForAllInstances

  public void setParticipationStatusForAllInstances(java.lang.String wspcId,
                                                    java.lang.String meetingId,
                                                    java.lang.String status,
                                                    java.lang.String showAsFree)
                                             throws CwWSException
  

  Sets the participating status for the current user for all instances of this meeting.

  Parameters:

  wspcId - - Id of the workspace

  meetingId - - Id of the meeting

  status - - Status to be set for the user for the meeting Values could be NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE (ACCEPT but prefer another time)

  showAsFree - - overwrite the free/busy status, and values could be FREE, BUSY , OUT, TENTATIVE

  Throws:

  CwWSException - - If the workspace Id or meeting Id is invalid or If the status or showAsFree values are invalid.