org.osid.inquiry.batch

Interface InquiryBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InquiryBatchProfile, OsidManager, OsidProfile, Sourceable

public interface InquiryBatchManager
extends OsidManager, InquiryBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AuditBatchAdminSession	getAuditBatchAdminSession() Gets the OsidSession associated with the bulk audit administration service.
AuditBatchAdminSession	getAuditBatchAdminSessionForInquest(Id inquestId) Gets the OsidSession associated with the bulk audit administration service for the given inquest.
InquestBatchAdminSession	getInquestBatchAdminSession() Gets the OsidSession associated with the bulk inquest administration service.
InquiryBatchAdminSession	getInquiryBatchAdminSession() Gets the OsidSession associated with the bulk inquiry administration service.
InquiryBatchAdminSession	getInquiryBatchAdminSessionForInquest(Id inquestId) Gets the OsidSession associated with the bulk inquiry administration service for the given inquest.
ResponseBatchAdminSession	getResponseAdminSession() Gets the OsidSession associated with the bulk response administration service.
ResponseBatchAdminSession	getResponseAdminSessionForInquest(Id inquestId) Gets the OsidSession associated with the bulk response administration service for the given inquest.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.inquiry.batch.InquiryBatchProfile

supportsAuditBatchAdmin, supportsInquestBatchAdmin, supportsInquiryBatchAdmin, supportsResponseBatchAdmin, 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

getInquiryBatchAdminSession

InquiryBatchAdminSession getInquiryBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk inquiry administration service.

Returns:

an InquiryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryBatchAdmin() is false

Compliance:

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

getInquiryBatchAdminSessionForInquest

InquiryBatchAdminSession getInquiryBatchAdminSessionForInquest(Id inquestId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an InquiryBatchAdminSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquiryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInquiryBatchAdmin() and supportsVisibleFederation() are true

getAuditBatchAdminSession

AuditBatchAdminSession getAuditBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk audit administration service.

Returns:

an AuditBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditBatchAdmin() is false

Compliance:

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

getAuditBatchAdminSessionForInquest

AuditBatchAdminSession getAuditBatchAdminSessionForInquest(Id inquestId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

an AuditBatchAdminSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAuditBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAuditBatchAdmin() and supportsVisibleFederation() are true

getResponseAdminSession

ResponseBatchAdminSession getResponseAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk response administration service.

Returns:

a ResponseBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseBatchAdmin() is false

Compliance:

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

getResponseAdminSessionForInquest

ResponseBatchAdminSession getResponseAdminSessionForInquest(Id inquestId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

Returns:

a ResponseBatchAdminSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResponseBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResponseBatchAdmin() and supportsVisibleFederation() are true

getInquestBatchAdminSession

InquestBatchAdminSession getInquestBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk inquest administration service.

Returns:

a InquestBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestBatchAdmin() is false

Compliance:

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