Interface HoldBatchManager

All Superinterfaces:

AutoCloseable, Closeable, HoldBatchProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface HoldBatchProfile

supportsBlockBatchAdmin, supportsHoldBatchAdmin, supportsIssueBatchAdmin, supportsOublietteBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsBlockBatchAdmin()	Tests if bulk administration of blocks is available.
boolean	supportsHoldBatchAdmin()	Tests if bulk administration of holds is available.
boolean	supportsIssueBatchAdmin()	Tests if bulk administration of issues is available.
boolean	supportsOublietteBatchAdmin()	Tests if bulk administration of oubliettes is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

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 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

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 {@code supportsBlockBatchAdmin()} is {@code 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 {@code supportsBlockBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsIssueBatchAdmin()} is {@code 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 {@code supportsIssueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsHoldBatchAdmin()} is {@code 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 {@code supportsHoldBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getOublietteBatchAdminSession

OublietteBatchAdminSession getOublietteBatchAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk oubliette administration service.

Returns:

an OublietteBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteBatchAdmin() is false

Compliance:

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