OSID Logo
OSID Specifications
inquiry batch package
Version 3.1.0
Interfaceosid.inquiry.batch.InquiryBatchManager
Implementsosid.OsidManager
osid.inquiry.batch.InquiryBatchProfile
Used Byosid.inquiry.InquiryManager
Description

The inquiry batch manager provides access to inquiry batch sessions and provides interoperability tests for various aspects of this service. 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.

Returnosid.inquiry.batch.InquiryBatchAdminSession an InquiryBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInquiryBatchAdmin() is false
Complianceoptional This 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.IdinquestId the Id of the Inquest
Returnosid.inquiry.batch.InquiryBatchAdminSession an InquiryBatchAdminSession
ErrorsNOT_FOUND no Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInquiryBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInquiryBatchAdmin() and supportsVisibleFederation() are true
MethodgetAuditBatchAdminSession
Description

Gets the OsidSession associated with the bulk audit administration service.

Returnosid.inquiry.batch.AuditBatchAdminSession an AuditBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAuditBatchAdmin() is false
Complianceoptional This 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.IdinquestId the Id of the Inquest
Returnosid.inquiry.batch.AuditBatchAdminSession an AuditBatchAdminSession
ErrorsNOT_FOUND no Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAuditBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAuditBatchAdmin() and supportsVisibleFederation() are true
MethodgetResponseAdminSession
Description

Gets the OsidSession associated with the bulk response administration service.

Returnosid.inquiry.batch.ResponseBatchAdminSession a ResponseBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResponseBatchAdmin() is false
Complianceoptional This 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.IdinquestId the Id of the Inquest
Returnosid.inquiry.batch.ResponseBatchAdminSession a ResponseBatchAdminSession
ErrorsNOT_FOUND no Inquest found by the given Id
NULL_ARGUMENT inquestId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResponseBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsResponseBatchAdmin() and supportsVisibleFederation() are true
MethodgetInquestBatchAdminSession
Description

Gets the OsidSession associated with the bulk inquest administration service.

Returnosid.inquiry.batch.InquestBatchAdminSession a InquestBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInquestBatchAdmin() is false
Complianceoptional This method must be implemented if supportsInquestBatchAdmin() is true.