Interface CalendaringBatchProxyManager

All Superinterfaces:

AutoCloseable, CalendaringBatchProfile, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface CalendaringBatchProxyManager
extends OsidProxyManager, CalendaringBatchProfile

The calendaring batch proxy manager provides access to calendaring batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• EventBatchAdminSession : a session to create, modify and delete events in bulk
• RecurringEventBatchAdminSession : a session to create, modify and delete recurring events in bulk
• OffsetEventBatchSession : a session to create, modify and delete offset events in bulk
• ScheduleBatchAdminSession : a session to create, modify and delete schedules in bulk
• ScheduleSlotBatchSession : a session to create, modify and delete schedule slots in bulk
• CommitmentBatchAdminSession : a session to create, modify and delete commitments in bulk
• TimePeriodBatchAdminSession : a session to create, modify and delete time periods in bulk
• CalendarBatchAdminSession : a session to create, modify and delete calendars in bulk

Method Summary

Modifier and Type	Method	Description
CalendarBatchAdminSession	getCalendarBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk calendar administration service.
CommitmentBatchAdminSession	getCommitmentBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk commitment administration service.
CommitmentBatchAdminSession	getCommitmentBatchAdminSessionForCalendar(Id calendarId, Proxy proxy)	Gets the OsidSession associated with the bulk commitment administration service for the given calendar.
EventBatchAdminSession	getEventBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk event administration service.
EventBatchAdminSession	getEventBatchAdminSessionForCalendar(Id calendarId, Proxy proxy)	Gets the OsidSession associated with the bulk event administration service for the given calendar.
OffsetEventBatchAdminSession	getOffsetEventBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk offset event administration service.
OffsetEventBatchAdminSession	getOffsetEventBatchAdminSessionForCalendar(Id calendarId, Proxy proxy)	Gets the OsidSession associated with the bulk offset event administration service for the given calendar.
RecurringEventBatchAdminSession	getRecurringEventBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk recurring event administration service.
RecurringEventBatchAdminSession	getRecurringEventBatchAdminSessionForCalendar(Id calendarId, Proxy proxy)	Gets the OsidSession associated with the bulk recurring event administration service for the given calendar.
ScheduleBatchAdminSession	getScheduleBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk schedule administration service.
ScheduleBatchAdminSession	getScheduleBatchAdminSessionForCalendar(Id calendarId, Proxy proxy)	Gets the OsidSession associated with the bulk schedule administration service for the given calendar.
ScheduleSlotBatchAdminSession	getScheduleSlotBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk schedule slot administration service.
ScheduleSlotBatchAdminSession	getScheduleSlotBatchAdminSessionForCalendar(Id calendarId, Proxy proxy)	Gets the OsidSession associated with the bulk schedule slot administration service for the given calendar.
TimePeriodBatchAdminSession	getTimePeriodBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk time period administration service.
TimePeriodBatchAdminSession	getTimePeriodBatchAdminSessionForCalendar(Id calendarId, Proxy proxy)	Gets the OsidSession associated with the bulk time period administration service for the given calendar.

Methods inherited from interface CalendaringBatchProfile

supportsCalendarBatchAdmin, supportsCommitmentBatchAdmin, supportsEventBatchAdmin, supportsOffsetEventBatchAdmin, supportsRecurringEventBatchAdmin, supportsScheduleBatchAdmin, supportsScheduleSlotBatchAdmin, supportsTimePeriodBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsCalendarBatchAdmin()	Tests if bulk administration of calendars is available.
boolean	supportsCommitmentBatchAdmin()	Tests if bulk administration of commitments is available.
boolean	supportsEventBatchAdmin()	Tests if bulk administration of events is available.
boolean	supportsOffsetEventBatchAdmin()	Tests if bulk administration of offset events is available.
boolean	supportsRecurringEventBatchAdmin()	Tests if bulk administration of recurring events is available.
boolean	supportsScheduleBatchAdmin()	Tests if bulk administration of schedules is available.
boolean	supportsScheduleSlotBatchAdmin()	Tests if bulk administration of schedule slots is available.
boolean	supportsTimePeriodBatchAdmin()	Tests if bulk administration of time periods is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getEventBatchAdminSession

EventBatchAdminSession getEventBatchAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk event administration service.

Parameters:

proxy - a proxy

Returns:

an EventBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsEventBatchAdmin()} is {@code true} .

getEventBatchAdminSessionForCalendar

EventBatchAdminSession getEventBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk event administration service for the given calendar.

Parameters:

calendarId - the Id of the Calendar

proxy - a proxy

Returns:

a EventBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEventBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsEventBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getRecurringEventBatchAdminSession

RecurringEventBatchAdminSession getRecurringEventBatchAdminSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the bulk recurring event administration service.

Parameters:

proxy - a proxy

Returns:

a RecurringEventBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsRecurringEventBatchAdmin()} is {@code true} .

getRecurringEventBatchAdminSessionForCalendar

RecurringEventBatchAdminSession getRecurringEventBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk recurring event administration service for the given calendar.

Parameters:

calendarId - the Id of the Calendar

proxy - a proxy

Returns:

a RecurringEventBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecurringEventBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRecurringEventBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getOffsetEventBatchAdminSession

OffsetEventBatchAdminSession getOffsetEventBatchAdminSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the bulk offset event administration service.

Parameters:

proxy - a proxy

Returns:

an OffsetEventBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsOffsetEventBatchAdmin()} is {@code true} .

getOffsetEventBatchAdminSessionForCalendar

OffsetEventBatchAdminSession getOffsetEventBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk offset event administration service for the given calendar.

Parameters:

calendarId - the Id of the Calendar

proxy - a proxy

Returns:

an OffsetEventBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOffsetEventBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOffsetEventBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getScheduleBatchAdminSession

ScheduleBatchAdminSession getScheduleBatchAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk schedule administration service.

Parameters:

proxy - a proxy

Returns:

a ScheduleBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsScheduleBatchAdmin()} is {@code true} .

getScheduleBatchAdminSessionForCalendar

ScheduleBatchAdminSession getScheduleBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk schedule administration service for the given calendar.

Parameters:

calendarId - the Id of the Calendar

proxy - a proxy

Returns:

a ScheduleBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsScheduleBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getScheduleSlotBatchAdminSession

ScheduleSlotBatchAdminSession getScheduleSlotBatchAdminSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the bulk schedule slot administration service.

Parameters:

proxy - a proxy

Returns:

a ScheduleSlotBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsScheduleSlotBatchAdmin()} is {@code true} .

getScheduleSlotBatchAdminSessionForCalendar

ScheduleSlotBatchAdminSession getScheduleSlotBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk schedule slot administration service for the given calendar.

Parameters:

calendarId - the Id of the Calendar

proxy - a proxy

Returns:

a ScheduleSlotBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsScheduleSlotBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsScheduleSlotBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getCommitmentBatchAdminSession

CommitmentBatchAdminSession getCommitmentBatchAdminSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the bulk commitment administration service.

Parameters:

proxy - a proxy

Returns:

a CommitmentBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCommitmentBatchAdmin()} is {@code true} .

getCommitmentBatchAdminSessionForCalendar

CommitmentBatchAdminSession getCommitmentBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk commitment administration service for the given calendar.

Parameters:

calendarId - the Id of the Calendar

proxy - a proxy

Returns:

a CommitmentBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommitmentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCommitmentBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getTimePeriodBatchAdminSession

TimePeriodBatchAdminSession getTimePeriodBatchAdminSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the bulk time period administration service.

Parameters:

proxy - a proxy

Returns:

a TimePeriodBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsTimePeriodBatchAdmin()} is {@code true} .

getTimePeriodBatchAdminSessionForCalendar

TimePeriodBatchAdminSession getTimePeriodBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk time period administration service for the given calendar.

Parameters:

calendarId - the Id of the Calendar

proxy - a proxy

Returns:

a TimePeriodBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTimePeriodBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTimePeriodBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getCalendarBatchAdminSession

CalendarBatchAdminSession getCalendarBatchAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk calendar administration service.

Parameters:

proxy - a proxy

Returns:

a CalendarBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarBatchAdmin()} is {@code true} .