Interface OfferingBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OfferingBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface OfferingBatchProxyManager
extends OsidProxyManager, OfferingBatchProfile

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

• CanonicalUnitBatchAdminSession : a session to create, modify and delete canonical units in bulk
• OfferingBatchAdminSession : a session to create, modify and delete offerings in bulk
• ParticipantBatchSession : a session to create, modify and delete participants in bulk
• ResultBatchAdminSession : a session to create, modify and delete results in bulk
• CatalogueBatchAdminSession : a session to create, modify and delete catalogues in bulk

Method Summary

Modifier and Type	Method	Description
CanonicalUnitBatchAdminSession	getCanonicalUnitBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk canonical unit administration service.
CanonicalUnitBatchAdminSession	getCanonicalUnitBatchAdminSessionForCatalogue(Id catalogueId, Proxy proxy)	Gets the OsidSession associated with the bulk canonical unit administration service for the given catalogue
CatalogueBatchAdminSession	getCatalogueBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk catalogue administration service.
OfferingBatchAdminSession	getOfferingBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk offering administration service.
OfferingBatchAdminSession	getOfferingBatchAdminSessionForCatalogue(Id catalogueId, Proxy proxy)	Gets the OsidSession associated with the bulk offering administration service for the given catalogue
ParticipantBatchAdminSession	getParticipantBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk participant administration service.
ParticipantBatchAdminSession	getParticipantBatchAdminSessionForCatalogue(Id catalogueId, Proxy proxy)	Gets the OsidSession associated with the bulk participant administration service for the given catalogue
ResultBatchAdminSession	getResultBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk result administration service.
ResultBatchAdminSession	getResultBatchAdminSessionForCatalogue(Id catalogueId, Proxy proxy)	Gets the OsidSession associated with the bulk result administration service for the given catalogue

Methods inherited from interface Closeable

close

Methods inherited from interface OfferingBatchProfile

supportsCanonicalUnitBatchAdmin, supportsCatalogueBatchAdmin, supportsOfferingBatchAdmin, supportsParticipantBatchAdmin, supportsResultBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsCanonicalUnitBatchAdmin()	Tests if bulk administration of canonical units is available.
boolean	supportsCatalogueBatchAdmin()	Tests if bulk administration of catalogues is available.
boolean	supportsOfferingBatchAdmin()	Tests if bulk administration of offerings is available.
boolean	supportsParticipantBatchAdmin()	Tests if bulk administration of participants is available.
boolean	supportsResultBatchAdmin()	Tests if bulk administration of results is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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

getCanonicalUnitBatchAdminSession

CanonicalUnitBatchAdminSession getCanonicalUnitBatchAdminSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the bulk canonical unit administration service.

Parameters:

proxy - a proxy

Returns:

a CanonicalUnitBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitBatchAdmin() is false

Compliance:

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

getCanonicalUnitBatchAdminSessionForCatalogue

CanonicalUnitBatchAdminSession getCanonicalUnitBatchAdminSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk canonical unit administration service for the given catalogue

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a CanonicalUnitBatchAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getOfferingBatchAdminSession

OfferingBatchAdminSession getOfferingBatchAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk offering administration service.

Parameters:

proxy - a proxy

Returns:

an OfferingBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingBatchAdmin() is false

Compliance:

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

getOfferingBatchAdminSessionForCatalogue

OfferingBatchAdminSession getOfferingBatchAdminSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk offering administration service for the given catalogue

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

an OfferingBatchAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getParticipantBatchAdminSession

ParticipantBatchAdminSession getParticipantBatchAdminSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the bulk participant administration service.

Parameters:

proxy - a proxy

Returns:

a ParticipantBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantBatchAdmin() is false

Compliance:

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

getParticipantBatchAdminSessionForCatalogue

ParticipantBatchAdminSession getParticipantBatchAdminSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk participant administration service for the given catalogue

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ParticipantBatchAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getResultBatchAdminSession

ResultBatchAdminSession getResultBatchAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the bulk result administration service.

Parameters:

proxy - a proxy

Returns:

a ResultBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultBatchAdmin() is false

Compliance:

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

getResultBatchAdminSessionForCatalogue

ResultBatchAdminSession getResultBatchAdminSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk result administration service for the given catalogue

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ResultBatchAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCatalogueBatchAdminSession

CatalogueBatchAdminSession getCatalogueBatchAdminSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk catalogue administration service.

Parameters:

proxy - a proxy

Returns:

a CatalogueBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueBatchAdmin() is false

Compliance:

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