org.alfresco.module.vti.handler

Interface MeetingServiceHandler

All Known Implementing Classes:

AlfrescoMeetingServiceHandler

public interface MeetingServiceHandler

Interface for meeting web service handler

Author:

PavelYur

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MeetingServiceHandler.AttendeeStatus The different statuses of a Meeting Attendee

Method Summary

Modifier and Type	Method and Description
void	addMeeting(String siteName, MeetingBean meeting) Creates the meeting information in the Meeting Workspace site on the specified Alfresco server.
void	addMeetingFromICal(String siteName, MeetingBean meeting) Associates a meeting represented in Internet Calendar (iCal) format with the Meeting Workspace site on the specified Alfresco server.
String	createWorkspace(String title, String templateName, int lcid, TimeZoneInformation timeZoneInformation, SessionUser user) Creates a new Meeting Workspace site on the specified Alfresco server.
void	deleteWorkspace(String siteName, SessionUser user) Deletes the Meeting Workspace site from the specified Alfresco server.
MeetingsInformation	getMeetingsInformation(String siteName, int requestFlags, int lcid) Lists the languages and templates supported by the specified Alfresco server.
List<SiteInfo>	getMeetingWorkspaces(boolean recurring) Lists the Meeting Workspace sites that are available, to the current user, on the Alfresco Server.
void	removeMeeting(String siteName, int recurrenceId, String uid, int sequence, Date utcDateStamp, boolean cancelMeeting) Removes the association between a meeting and a Meeting Workspace site.
void	restoreMeeting(String siteName, String uid) Restores a meeting in a Meeting Workspace site, which was previously removed.
void	updateAttendeeResponse(String siteName, String attendeeEmail, MeetingServiceHandler.AttendeeStatus status, String uid, int recurrenceId, int sequence, Date utcDateStamp) Sets an attendee's response for a meeting.
void	updateMeeting(String siteName, MeetingBean meeting) Updates meeting information .
void	updateMeetingFromICal(String siteName, MeetingBean meeting, boolean ignoreAttendees) Updates meeting information stored in Internet Calendar (iCal) format.
void	updateWorkspaceTitle(String siteName, String newTitle) Updates the title (but not the name) of a Meeting Workspace site on the specified Alfresco server

Method Detail

getMeetingWorkspaces

List<SiteInfo> getMeetingWorkspaces(boolean recurring)

Lists the Meeting Workspace sites that are available, to the current user, on the Alfresco Server.

Parameters:

recurring - true if the meeting is recurring; otherwise, false.

Returns:

list that contains the details of Meeting Workspace sites in the root directory of the Alfresco server.

getMeetingsInformation

MeetingsInformation getMeetingsInformation(String siteName,
                                           int requestFlags,
                                           int lcid)

Lists the languages and templates supported by the specified Alfresco server.

Parameters:

siteName - The site name

requestFlags -

• canCreateMeetings (returns true or false to indicate whether the caller has ManageSubweb rights on the site being posted to)
• templateLanguages (returns the list of languages for which templates are available)
• templateList (returns the list of available Meeting Workspace templates available for the specified LCID)
• workspacestatus (returns information about the workspace)

lcid - The locale identifier to which you want to limit the results.

Returns:

meeting information

createWorkspace

String createWorkspace(String title,
                       String templateName,
                       int lcid,
                       TimeZoneInformation timeZoneInformation,
                       SessionUser user)
                throws Exception

Creates a new Meeting Workspace site on the specified Alfresco server.

Parameters:

title - The title for the Meeting Workspace site that will be created.

templateName - The name of the template you want to use when the site is created.

lcid - The locale identifier that you want to use when the site is created.

timeZoneInformation - The time zone information that you want to use when the site is created.

user - Current user

Returns:

name of newly created Meeting Workspace.

Throws:

Exception

updateWorkspaceTitle

void updateWorkspaceTitle(String siteName,
                          String newTitle)
                   throws SiteDoesNotExistException

Updates the title (but not the name) of a Meeting Workspace site on the specified Alfresco server

Parameters:

siteName - The site name

newTitle - The new title for the Meeting Workspace site

Throws:

SiteDoesNotExistException

addMeeting

void addMeeting(String siteName,
                MeetingBean meeting)
         throws SiteDoesNotExistException

Creates the meeting information in the Meeting Workspace site on the specified Alfresco server.

Parameters:

siteName - The site name

meeting - The meeting bean (MeetingBean)

Throws:

SiteDoesNotExistException

updateMeeting

void updateMeeting(String siteName,
                   MeetingBean meeting)
            throws SiteDoesNotExistException,
                   ObjectNotFoundException

Updates meeting information .

Parameters:

siteName - The site name

meeting - The meeting bean (MeetingBean)

Throws:

SiteDoesNotExistException

ObjectNotFoundException

addMeetingFromICal

void addMeetingFromICal(String siteName,
                        MeetingBean meeting)
                 throws SiteDoesNotExistException

Associates a meeting represented in Internet Calendar (iCal) format with the Meeting Workspace site on the specified Alfresco server.

Parameters:

siteName - The site name

meeting - The meeting bean (MeetingBean)

Throws:

SiteDoesNotExistException

updateMeetingFromICal

void updateMeetingFromICal(String siteName,
                           MeetingBean meeting,
                           boolean ignoreAttendees)
                    throws SiteDoesNotExistException,
                           ObjectNotFoundException

Updates meeting information stored in Internet Calendar (iCal) format.

Parameters:

siteName - The site name

meeting - The meeting bean (MeetingBean)

ignoreAttendees - true if you want to skip processing of attendee information in the iCal; otherwise, false.

Throws:

SiteDoesNotExistException

ObjectNotFoundException

removeMeeting

void removeMeeting(String siteName,
                   int recurrenceId,
                   String uid,
                   int sequence,
                   Date utcDateStamp,
                   boolean cancelMeeting)
            throws SiteDoesNotExistException,
                   ObjectNotFoundException

Removes the association between a meeting and a Meeting Workspace site.

Parameters:

siteName - The site name

recurrenceId - The recurrence ID for the meeting that needs its association removed. This parameter can be set to 0 for single-instance meetings.

uid - A persistent GUID for the calendar component.

sequence - An integer that is used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded. If the sequence is equal to the current sequence, the latest update will be applied.

utcDateStamp - The date and time that the instance of the Date object was created. This parameter needs to be in the UTC format (for example, 2003-03-04T04:45:22-08:00).

cancelMeeting - true if you want to delete a meeting; false if you just want to remove its association with a Meeting Workspace site.

Throws:

SiteDoesNotExistException

ObjectNotFoundException

restoreMeeting

void restoreMeeting(String siteName,
                    String uid)
             throws SiteDoesNotExistException,
                    ObjectNotFoundException

Restores a meeting in a Meeting Workspace site, which was previously removed. This will only be supported if archiving is enabled, and the meeting Calendar NodeRef is still present in the archive store.

Throws:

SiteDoesNotExistException

ObjectNotFoundException

updateAttendeeResponse

void updateAttendeeResponse(String siteName,
                            String attendeeEmail,
                            MeetingServiceHandler.AttendeeStatus status,
                            String uid,
                            int recurrenceId,
                            int sequence,
                            Date utcDateStamp)
                     throws SiteDoesNotExistException,
                            ObjectNotFoundException

Sets an attendee's response for a meeting. Currently, nothing happens with this information, but in future we could potentially add activity entries, send emails etc

Throws:

SiteDoesNotExistException

ObjectNotFoundException

deleteWorkspace

void deleteWorkspace(String siteName,
                     SessionUser user)
              throws Exception

Deletes the Meeting Workspace site from the specified Alfresco server.

Parameters:

siteName - The siteName to delete

user - Current user

Throws:

Exception