org.osid.calendaring.batch

Interface CalendaringBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, CalendaringBatchProfile, java.io.Closeable, OsidProfile, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.calendaring.batch.CalendaringBatchProfile

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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsEventBatchAdmin() is 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 supportsEventBatchAdmin() and supportsVisibleFederation() are 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 supportsRecurringEventBatchAdmin() is 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 supportsRecurringEventBatchAdmin() and supportsVisibleFederation() are 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 supportsOffsetEventBatchAdmin() is 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 supportsOffsetEventBatchAdmin() and supportsVisibleFederation() are 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 supportsScheduleBatchAdmin() is 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 supportsScheduleBatchAdmin() and supportsVisibleFederation() are 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 supportsScheduleSlotBatchAdmin() is 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 supportsScheduleSlotBatchAdmin() and supportsVisibleFederation() are 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 supportsCommitmentBatchAdmin() is 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 supportsCommitmentBatchAdmin() and supportsVisibleFederation() are 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 supportsTimePeriodBatchAdmin() is 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 supportsTimePeriodBatchAdmin() and supportsVisibleFederation() are 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 supportsCalendarBatchAdmin() is true.