Interface InquiryInquestSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InquiryInquestSession
extends OsidSession

This session provides methods to retrieve Inquiry to Inquest mappings. An Inquiry may appear in multiple Inquest objects. Each inquest may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupInquiryInquestMappings()	Tests if this user can perform lookups of inquiry/inquest mappings.
IdList	getInquestIdsByInquiry(Id inquiryId)	Gets the Inquest Ids mapped to an Inquiry .
InquestList	getInquestsByInquiry(Id inquiryId)	Gets the Inquests mapped to an Inquiry .
InquiryList	getInquiriesByInquest(Id inquestId)	Gets the list of Inquiries associated with an Inquest .
InquiryList	getInquiriesByInquests(IdList inquestIds)	Gets the list of Inquiry corresponding to a list of Inquests .
IdList	getInquiryIdsByInquest(Id inquestId)	Gets the list of Inquiry Ids associated with an Inquest .
IdList	getInquiryIdsByInquests(IdList inquestIds)	Gets the list of Inquiry Ids corresponding to a list of Inquests .
void	useComparativeInquiryInquestView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryInquiryInquestView()	A complete view of the Inquiry and Inquest returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

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

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupInquiryInquestMappings

boolean canLookupInquiryInquestMappings()

Tests if this user can perform lookups of inquiry/inquest mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeInquiryInquestView

void useComparativeInquiryInquestView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryInquiryInquestView

void usePlenaryInquiryInquestView()

A complete view of the Inquiry and Inquest returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getInquiryIdsByInquest

IdList getInquiryIdsByInquest(Id inquestId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Inquiry Ids associated with an Inquest .

Parameters:

inquestId - Id of the Inquest

Returns:

list of related inquiry Ids

Throws:

NotFoundException - inquestId is not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiriesByInquest

InquiryList getInquiriesByInquest(Id inquestId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Inquiries associated with an Inquest .

Parameters:

inquestId - Id of the Inquest

Returns:

list of related inquiries

Throws:

NotFoundException - inquestId is not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiryIdsByInquests

IdList getInquiryIdsByInquests(IdList inquestIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Inquiry Ids corresponding to a list of Inquests .

Parameters:

inquestIds - list of inquest Ids

Returns:

list of inquiry Ids

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiriesByInquests

InquiryList getInquiriesByInquests(IdList inquestIds)
                            throws OperationFailedException,
PermissionDeniedException

Gets the list of Inquiry corresponding to a list of Inquests .

Parameters:

inquestIds - list of inquest Ids

Returns:

list of inquiries

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestIdsByInquiry

IdList getInquestIdsByInquiry(Id inquiryId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Inquest Ids mapped to an Inquiry .

Parameters:

inquiryId - Id of an Inquiry

Returns:

list of inquests

Throws:

NotFoundException - inquiryId is not found

NullArgumentException - inquiryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByInquiry

InquestList getInquestsByInquiry(Id inquiryId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Inquests mapped to an Inquiry .

Parameters:

inquiryId - Id of an Inquiry

Returns:

list of inquests

Throws:

NotFoundException - inquiryId is not found

NullArgumentException - inquiryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.