Interface InquiryBatchManager

All Superinterfaces:

AutoCloseable, Closeable, InquiryBatchProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface InquiryBatchProfile

supportsAuditBatchAdmin, supportsInquestBatchAdmin, supportsInquiryBatchAdmin, supportsResponseBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAuditBatchAdmin()	Tests if bulk administration of audits is available.
boolean	supportsInquestBatchAdmin()	Tests if bulk administration of inquests is available.
boolean	supportsInquiryBatchAdmin()	Tests if bulk administration of inquiries is available.
boolean	supportsResponseBatchAdmin()	Tests if bulk administration of responses is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsInquiryBatchAdmin()} is {@code 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 {@code supportsInquiryBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAuditBatchAdmin()} is {@code 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 {@code supportsAuditBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsResponseBatchAdmin()} is {@code 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 {@code supportsResponseBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInquestBatchAdmin()} is {@code true} .