Interface CalendaringCycleBatchProxyManager

All Superinterfaces:

AutoCloseable, CalendaringCycleBatchProfile, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface CalendaringCycleBatchProxyManager
extends OsidProxyManager, CalendaringCycleBatchProfile

The calendaring cycle batch proxy manager provides access to calendaring cycle 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:

• 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

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

Methods inherited from interface CalendaringCycleBatchProfile

supportsCyclicEventBatchAdmin, supportsCyclicTimePeriodBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsCyclicEventBatchAdmin()	Tests if bulk administration of cyclic events is available.
boolean	supportsCyclicTimePeriodBatchAdmin()	Tests if bulk administration of cyclic 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

getCyclicEventBatchAdminSession

CyclicEventBatchAdminSession getCyclicEventBatchAdminSession(Proxy proxy)
                                                      throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CyclicEventBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventBatchAdmin() is false

Compliance:

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

getCyclicEventBatchAdminSessionForCalendar

CyclicEventBatchAdminSession getCyclicEventBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                                 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

proxy - a proxy

Returns:

a CyclicEventBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicEventBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCyclicTimePeriodBatchAdminSession

CyclicTimePeriodBatchAdminSession getCyclicTimePeriodBatchAdminSession(Proxy proxy)
                                                                throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CyclicTimePeriodBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodBatchAdmin() is false

Compliance:

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

getCyclicTimePeriodBatchAdminSessionForCalendar

CyclicTimePeriodBatchAdminSession getCyclicTimePeriodBatchAdminSessionForCalendar(Id calendarId,
 Proxy proxy)
                                                                           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

proxy - a proxy

Returns:

a CyclicTimePeriodBatchAdminSession

Throws:

NotFoundException - no Calendar found by the given Id

NullArgumentException - calendarId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCyclicTimePeriodBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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