org.osid.calendaring.cycle.batch

Interface CalendaringCycleBatchManager

All Superinterfaces:

java.lang.AutoCloseable, CalendaringCycleBatchProfile, java.io.Closeable, OsidManager, OsidProfile, Sourceable

public interface CalendaringCycleBatchManager
extends OsidManager, CalendaringCycleBatchProfile

The calendaring cycle batch manager provides access to calendaring cycle batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• CyclicEventBatchAdminSession: a session to create, modify and delete cyclic events in bulk
• CyclicTimePeriodBatchSession: a session to create, modify and delete cyclic time periods in bulk

Method Summary

Methods

Modifier and Type	Method and Description
CyclicEventBatchAdminSession	getCyclicEventBatchAdminSession() Gets the OsidSession associated with the bulk cyclic event administration service.
CyclicEventBatchAdminSession	getCyclicEventBatchAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the bulk cyclic event administration service for the given calendar.
CyclicTimePeriodBatchAdminSession	getCyclicTimePeriodBatchAdminSession() Gets the OsidSession associated with the bulk cyclic time period administration service.
CyclicTimePeriodBatchAdminSession	getCyclicTimePeriodBatchAdminSessionForCalendar(Id calendarId) Gets the OsidSession associated with the bulk cyclic time period administration service for the given calendar.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.calendaring.cycle.batch.CalendaringCycleBatchProfile

supportsCyclicEventBatchAdmin, supportsCyclicTimePeriodBatchAdmin, 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

getCyclicEventBatchAdminSession

CyclicEventBatchAdminSession getCyclicEventBatchAdminSession()
                                                             throws OperationFailedException

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

Returns:

a CyclicEventBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsCyclicEventBatchAdmin() is true.

getCyclicEventBatchAdminSessionForCalendar

CyclicEventBatchAdminSession getCyclicEventBatchAdminSessionForCalendar(Id calendarId)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

calendarId - the Id of the Calendar

Returns:

a CyclicEventBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCyclicEventBatchAdmin() and supportsVisibleFederation() are true

getCyclicTimePeriodBatchAdminSession

CyclicTimePeriodBatchAdminSession getCyclicTimePeriodBatchAdminSession()
                                                                       throws OperationFailedException

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

Returns:

a CyclicTimePeriodBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsCyclicTimePeriodBatchAdmin() is true.

getCyclicTimePeriodBatchAdminSessionForCalendar

CyclicTimePeriodBatchAdminSession getCyclicTimePeriodBatchAdminSessionForCalendar(Id calendarId)
                                                                                  throws NotFoundException,
                                                                                         OperationFailedException

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

Parameters:

calendarId - the Id of the Calendar

Returns:

a CyclicTimePeriodBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCyclicTimePeriodBatchAdmin() and supportsVisibleFederation() are true