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 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. |
changeBranch, initialize, rollbackService
close
supportsBlockBatchAdmin, supportsHoldBatchAdmin, supportsIssueBatchAdmin, supportsOublietteBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
BlockBatchAdminSession getBlockBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk block
administration service. BlockBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlockBatchAdmin()
is false
optional
- This method must be implemented if
supportsBlockBatchAdmin()
is true.
BlockBatchAdminSession getBlockBatchAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk block
administration service for the given oubliette.oublietteId
- the Id
of the Oubliette
BlockBatchAdminSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlockBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBlockBatchAdmin()
and
supportsVisibleFederation()
are true
IssueBatchAdminSession getIssueBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk issue
administration service. IssueBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueBatchAdmin()
is false
optional
- This method must be implemented if
supportsIssueBatchAdmin()
is true.
IssueBatchAdminSession getIssueBatchAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk issue
administration service for the given oubliette.oublietteId
- the Id
of the Oubliette
IssueBatchAdminSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsIssueBatchAdmin()
and
supportsVisibleFederation()
are true
HoldBatchAdminSession getHoldBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk hold
administration service. HoldBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldBatchAdmin()
is false
optional
- This method must be implemented if
supportsHoldBatchAdmin()
is true.
HoldBatchAdminSession getHoldBatchAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk hold
administration service for the given oubliette.oublietteId
- the Id
of the Oubliette
HoldBatchAdminSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldBatchAdmin()
and
supportsVisibleFederation()
are true
OublietteBatchAdminSession getOublietteBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk oubliette
administration service. OublietteBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOublietteBatchAdmin()
is false
optional
- This method must be implemented if
supportsOublietteBatchAdmin()
is true.