org.osid.inquiry.batch

Interface InquiryBatchProxyManager

All Superinterfaces:

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

public interface InquiryBatchProxyManager
extends OsidProxyManager, InquiryBatchProfile

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

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk inquiry administration service.

Parameters:

proxy - a proxy

Returns:

an InquiryBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an InquiryBatchAdminSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk audit administration service.

Parameters:

proxy - a proxy

Returns:

an AuditBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

an AuditBatchAdminSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId or proxy 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(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk response administration service.

Parameters:

proxy - a proxy

Returns:

a ResponseBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

inquestId - the Id of the Inquest

proxy - a proxy

Returns:

a ResponseBatchAdminSession

Throws:

NotFoundException - no Inquest found by the given Id

NullArgumentException - inquestId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk inquest administration service.

Parameters:

proxy - a proxy

Returns:

a InquestBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInquestBatchAdmin() is false

Compliance:

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