OSID Logo
OSID Specifications
resource batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.batch.ResourceBatchProxyManager
Implementsosid.OsidProxyManager
osid.resource.batch.ResourceBatchProfile
Description

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

  • ResourceBatchAdminSession: a session to manage resources in bulk
  • ResourceRelationshipBatchAdminSession: a session to manage resource relationships in bulk
  • BinBatchAdminSession: a session to create, modify and delete Bins in bulk
MethodgetResourceBatchAdminSession
Description

Gets the OsidSession associated with the bulk resource administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.batch.ResourceBatchAdminSessiona ResourceBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsResourceBatchAdmin() is true.
MethodgetResourceBatchAdminSessionForBin
Description

Gets the OsidSession associated with the bulk resource administration service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.batch.ResourceBatchAdminSessiona ResourceBatchAdminSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceBatchAdmin() and supportsVisibleFederation() are true
MethodgetResourceRelationshipBatchAdminSession
Description

Gets the OsidSession associated with the bulk resource administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.batch.ResourceRelationshipBatchAdminSessiona ResourceRelationshipBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceRelationshipBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsResourceRelationshipBatchAdmin() is true.
MethodgetResourceRelationshipBatchAdminSessionForBin
Description

Gets the OsidSession associated with the bulk resource relationship administration service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.batch.ResourceRelationshipBatchAdminSessiona ResourceRelationshipBatchAdminSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceRelationshipBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceRelationshipBatchAdmin() and supportsVisibleFederation() are true
MethodgetBinBatchAdminSession
Description

Gets the OsidSession associated with the bulk bin administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.batch.BinBatchAdminSessiona BinBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBinBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBinBatchAdmin() is true.