org.osid.hold.batch

Interface HoldBatchProxyManager

All Superinterfaces:

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

public interface HoldBatchProxyManager
extends OsidProxyManager, HoldBatchProfile

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

• 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(Proxy proxy) Gets the OsidSession associated with the bulk block administration service.
BlockBatchAdminSession	getBlockBatchAdminSessionForOubliette(Id oublietteId, Proxy proxy) Gets the OsidSession associated with the bulk block administration service for the given oubliette.
HoldBatchAdminSession	getHoldBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk hold administration service.
HoldBatchAdminSession	getHoldBatchAdminSessionForOubliette(Id oublietteId, Proxy proxy) Gets the OsidSession associated with the bulk hold administration service for the given oubliette.
IssueBatchAdminSession	getIssueBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk issue administration service.
IssueBatchAdminSession	getIssueBatchAdminSessionForOubliette(Id oublietteId, Proxy proxy) Gets the OsidSession associated with the bulk issue administration service for the given oubliette.
OublietteBatchAdminSession	getOublietteBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk oubliette administration service.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk block administration service.

Parameters:

proxy - a proxy

Returns:

a BlockBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a BlockBatchAdminSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk issue administration service.

Parameters:

proxy - a proxy

Returns:

an IssueBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

an IssueBatchAdminSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk hold administration service.

Parameters:

proxy - a proxy

Returns:

a HoldBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a HoldBatchAdminSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy 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(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk oubliette administration service.

Parameters:

proxy - a proxy

Returns:

a OublietteBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteBatchAdmin() is false

Compliance:

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