cz.ues.digitalworkspace.sync.ical

Interface UESiCal

@UESService
public interface UESiCal

UES Command for synchronization of digital workspace calendar with other services by iCalendar data format.

Since:

UES7-01

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI personalRoleUri) Creates an object (data structure) used for iCalendar publication.
void	delete(UESURI personalRoleUri) Deletes data structure used for synchronization of digital workspace calendar.
UESiCalAttributes	getAttributes(UESURI personalRoleUri) Returns iCalendar attributes for specified personal role.
java.lang.String	getCalendar(UESURI roleUri, UESiCalGetCalendar parameters) The operation for export Role calendar to iCal (RFC2445) data format.
void	setAccessState(UESURI personalRoleUri, UESiCalSetAccessState state) Sets diary publication access state.
void	setCredentials(UESURI personalRoleUri, UESiCalSetCredentials credentials) Sets credentials to iCalendar account.

Method Detail

getCalendar

java.lang.String getCalendar(UESURI roleUri,
                           UESiCalGetCalendar parameters)

The operation for export Role calendar to iCal (RFC2445) data format. The roleUri or iCalParameters could be used to limit exported records.

This command does not require any special access rights, the UES command UESRoleCalendar is used for read of the calendar records and provides the internal authorization.

Parameters:

roleUri - - the UESRole URI used to find Role-Calendar. Typically the UESPerson URI is used to export all user calendar entries.

parameters - the special attributes for parameterization of the export. Or may be used NULL to use the default values.

Returns:

iCal-text export of the Role Calendar. It is encoded in UTF-8 format, as it is defined by iCal specification as default data characterset.

Since:

UES7-01

create

UESURI create(UESURI personalRoleUri)
              throws UESICalRTException

Creates an object (data structure) used for iCalendar publication. This method must be invoked before attributes are obtained.

Current implementation of UESiCal service requires that used main entity is personal role of current authenticated user. If it is necessary to extend this behavior, please send a request.

Parameters:

personalRoleUri - UESURI of personal role of current authenticated user.

Returns:

UESURI of created object.

Throws:

UESICalRTException - If data structure cannot be created.

Since:

UES7-10

getAttributes

UESiCalAttributes getAttributes(UESURI personalRoleUri)

Returns iCalendar attributes for specified personal role. This method doesn't return any calendar data. It returns only meta data related to calendar.

Current implementation of UESiCal service requires that used main entity is personal role of current authenticated user. If it is necessary to extend this behavior, please send a request.

Parameters:

personalRoleUri - UESURI of personal role of current authenticated user.

Returns:

iCalendar attributes for specified personal role or the value null if no such attributes exists.

Since:

UES7-10

setAccessState

void setAccessState(UESURI personalRoleUri,
                  UESiCalSetAccessState state)
                    throws UESICalRTException

Sets diary publication access state.

Current implementation of UESiCal service requires that used main entity is personal role of current authenticated user. If it is necessary to extend this behavior, please send a request.

Parameters:

personalRoleUri - UESURI of personal role of current authenticated user.

state - DTO which describes credentials state.

Throws:

UESICalRTException - Thrown if the user has no iCalendar account.

Since:

UES7-10

setCredentials

void setCredentials(UESURI personalRoleUri,
                  UESiCalSetCredentials credentials)
                    throws UESICalRTException

Sets credentials to iCalendar account. Invocation of this method changes access token and therefore it affects the iCalendar URL.

Current implementation of UESiCal service requires that used main entity is personal role of current authenticated user. If it is necessary to extend this behavior, please send a request.

The parameter credentials doesn't require current credentials because this command relies on authorization. When no new credentials are specified, the command generates appropriate credentials itself.

Parameters:

personalRoleUri - UESURI of personal role of current authenticated user.

credentials - DTO with new credentials.

Throws:

UESICalRTException - Thrown if the user has no iCalendar account.

Since:

UES7-10

delete

void delete(UESURI personalRoleUri)
            throws UESICalRTException

Deletes data structure used for synchronization of digital workspace calendar.

Current implementation of UESiCal service requires that used main entity is personal role of current authenticated user. If it is necessary to extend this behavior, please send a request.

Parameters:

personalRoleUri - UESURI of personal role of current authenticated user.

Throws:

UESICalRTException - Thrown if some data cannot be deleted.

Since:

UES7-10