OSID Logo
OSID Specifications
inquiry batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.batch.InquiryBatchProxyManager
Implementsosid.OsidProxyManager
osid.inquiry.batch.InquiryBatchProfile
Description

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

  • InquiryBatchAdminSession: a session to create, modify and delete Inquiries in bulk
  • AuditBatchAdminSession: a session to create, modify and delete Audits in bulk
  • ResponseBatchAdminSession: a session to create, modify and delete Responses in bulk
  • InquestBatchAdminSession: a session to create, modify and delete Inquests in bulk

MethodgetInquiryBatchAdminSession
Description

Gets the OsidSession associated with the bulk inquiry administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.batch.InquiryBatchAdminSessionan InquiryBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsInquiryBatchAdmin() is true.
MethodgetInquiryBatchAdminSessionForInquest
Description

Gets the OsidSession associated with the bulk inquiry administration service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.batch.InquiryBatchAdminSessionan InquiryBatchAdminSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquiryBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInquiryBatchAdmin() and supportsVisibleFederation() are true
MethodgetAuditBatchAdminSession
Description

Gets the OsidSession associated with the bulk audit administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.batch.AuditBatchAdminSessionan AuditBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAuditBatchAdmin() is true.
MethodgetAuditBatchAdminSessionForInquest
Description

Gets the OsidSession associated with the bulk audit administration service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.batch.AuditBatchAdminSessionan AuditBatchAdminSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuditBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuditBatchAdmin() and supportsVisibleFederation() are true
MethodgetResponseAdminSession
Description

Gets the OsidSession associated with the bulk response administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.batch.ResponseBatchAdminSessiona ResponseBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsResponseBatchAdmin() is true.
MethodgetResponseAdminSessionForInquest
Description

Gets the OsidSession associated with the bulk response administration service for the given inquest.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.proxy.Proxyproxya proxy
Returnosid.inquiry.batch.ResponseBatchAdminSessiona ResponseBatchAdminSession
ErrorsNOT_FOUNDno Inquest found by the given Id
NULL_ARGUMENT inquestId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResponseBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResponseBatchAdmin() and supportsVisibleFederation() are true
MethodgetInquestBatchAdminSession
Description

Gets the OsidSession associated with the bulk inquest administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.inquiry.batch.InquestBatchAdminSessiona InquestBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInquestBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsInquestBatchAdmin() is true.