org.osid.hold.batch

Interface HoldBatchManager

All Superinterfaces:

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

public interface HoldBatchManager
extends OsidManager, HoldBatchProfile

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

• BlockBatchAdminSession: a session to create, modify and delete blocks in bulk
• IssueBatchSession: a session to create, modify and delete issues in bulk
• HoldBatchAdminSession: a session to create, modify and delete holds in bulk
• OublietteBatchAdminSession: a session to create, modify and delete oubliettes in bulk

Method Summary

Methods

Modifier and Type	Method and Description
BlockBatchAdminSession	getBlockBatchAdminSession() Gets the OsidSession associated with the bulk block administration service.
BlockBatchAdminSession	getBlockBatchAdminSessionForOubliette(Id oublietteId) Gets the OsidSession associated with the bulk block administration service for the given oubliette.
HoldBatchAdminSession	getHoldBatchAdminSession() Gets the OsidSession associated with the bulk hold administration service.
HoldBatchAdminSession	getHoldBatchAdminSessionForOubliette(Id oublietteId) Gets the OsidSession associated with the bulk hold administration service for the given oubliette.
IssueBatchAdminSession	getIssueBatchAdminSession() Gets the OsidSession associated with the bulk issue administration service.
IssueBatchAdminSession	getIssueBatchAdminSessionForOubliette(Id oublietteId) Gets the OsidSession associated with the bulk issue administration service for the given oubliette.
OublietteBatchAdminSession	getOublietteBatchAdminSession() Gets the OsidSession associated with the bulk oubliette administration service.

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.hold.batch.HoldBatchProfile

supportsBlockBatchAdmin, supportsHoldBatchAdmin, supportsIssueBatchAdmin, supportsOublietteBatchAdmin, 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

getBlockBatchAdminSession

BlockBatchAdminSession getBlockBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk block administration service.

Returns:

a BlockBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockBatchAdmin() is false

Compliance:

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

getBlockBatchAdminSessionForOubliette

BlockBatchAdminSession getBlockBatchAdminSessionForOubliette(Id oublietteId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the bulk block administration service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a BlockBatchAdminSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getIssueBatchAdminSession

IssueBatchAdminSession getIssueBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk issue administration service.

Returns:

an IssueBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueBatchAdmin() is false

Compliance:

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

getIssueBatchAdminSessionForOubliette

IssueBatchAdminSession getIssueBatchAdminSessionForOubliette(Id oublietteId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the bulk issue administration service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

an IssueBatchAdminSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getHoldBatchAdminSession

HoldBatchAdminSession getHoldBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk hold administration service.

Returns:

a HoldBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldBatchAdmin() is false

Compliance:

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

getHoldBatchAdminSessionForOubliette

HoldBatchAdminSession getHoldBatchAdminSessionForOubliette(Id oublietteId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the bulk hold administration service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a HoldBatchAdminSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getOublietteBatchAdminSession

OublietteBatchAdminSession getOublietteBatchAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk oubliette administration service.

Returns:

a OublietteBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteBatchAdmin() is false

Compliance:

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