org.osid.offering.batch

Interface OfferingBatchManager

All Superinterfaces:

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

public interface OfferingBatchManager
extends OsidManager, OfferingBatchProfile

The offering batch manager provides access to offering batch sessions and provides interoperability tests for various aspects of this service. 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

Methods

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

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.offering.batch.OfferingBatchProfile

supportsCanonicalUnitBatchAdmin, supportsCatalogueBatchAdmin, supportsOfferingBatchAdmin, supportsParticipantBatchAdmin, supportsResultBatchAdmin, 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

getCanonicalUnitBatchAdminSession

CanonicalUnitBatchAdminSession getCanonicalUnitBatchAdminSession()
                                                                 throws OperationFailedException

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

Returns:

a CanonicalUnitBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitBatchAdmin() is false

Compliance:

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

getCanonicalUnitBatchAdminSessionForCatalogue

CanonicalUnitBatchAdminSession getCanonicalUnitBatchAdminSessionForCatalogue(Id catalogueId)
                                                                             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

Returns:

a CanonicalUnitBatchAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getOfferingBatchAdminSession

OfferingBatchAdminSession getOfferingBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk offering administration service.

Returns:

an OfferingBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingBatchAdmin() is false

Compliance:

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

getOfferingBatchAdminSessionForCatalogue

OfferingBatchAdminSession getOfferingBatchAdminSessionForCatalogue(Id catalogueId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an OfferingBatchAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getParticipantBatchAdminSession

ParticipantBatchAdminSession getParticipantBatchAdminSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk participant administration service.

Returns:

a ParticipantBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantBatchAdmin() is false

Compliance:

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

getParticipantBatchAdminSessionForCatalogue

ParticipantBatchAdminSession getParticipantBatchAdminSessionForCatalogue(Id catalogueId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a ParticipantBatchAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getResultBatchAdminSession

ResultBatchAdminSession getResultBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk result administration service.

Returns:

a ResultBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResultBatchAdmin() is false

Compliance:

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

getResultBatchAdminSessionForCatalogue

ResultBatchAdminSession getResultBatchAdminSessionForCatalogue(Id catalogueId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a ResultBatchAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCatalogueBatchAdminSession

CatalogueBatchAdminSession getCatalogueBatchAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk catalogue administration service.

Returns:

a CatalogueBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueBatchAdmin() is false

Compliance:

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