org.osid.inquiry

Interface InquestLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface InquestLookupSession
extends OsidSession

This session provides methods for retrieving Inquest objects.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Inquests it can access, without breaking execution. However, an assessment may only be useful if all Inquests referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupInquests() Tests if this user can perform Inquest lookups.
Inquest	getInquest(Id inquestId) Gets the Inquest specified by its Id.
InquestList	getInquests() Gets all Inquests.
InquestList	getInquestsByGenusType(Type inquestGenusType) Gets an InquestList corresponding to the given inquest genus Type which does not include inquests of types derived from the specified Type.
InquestList	getInquestsByIds(IdList inquestIds) Gets an InquestList corresponding to the given IdList.
InquestList	getInquestsByParentGenusType(Type inquestGenusType) Gets an InquestList corresponding to the given inquest genus Type and include any additional inquests with genus types derived from the specified Type.
InquestList	getInquestsByProvider(Id resourceId) Gets an InquestList for the given provider.
InquestList	getInquestsByRecordType(Type inquestRecordType) Gets an InquestList containing the given inquest record Type.
void	useComparativeInquestView() 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	usePlenaryInquestView() A complete view of the Inquest returns is desired.

Methods inherited from interface org.osid.OsidSession

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

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupInquests

boolean canLookupInquests()

Tests if this user can perform Inquest lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeInquestView

void useComparativeInquestView()

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.

usePlenaryInquestView

void usePlenaryInquestView()

A complete view of the 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.

getInquest

Inquest getInquest(Id inquestId)
                   throws NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Gets the Inquest specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Inquest may have a different Id than requested, such as the case where a duplicate Id was assigned to an Inquest and retained for compatibility.

Parameters:

inquestId - Id of the Inquest

Returns:

the inquest

Throws:

NotFoundException - inquestId not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getInquestsByIds

InquestList getInquestsByIds(IdList inquestIds)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets an InquestList corresponding to the given IdList. In plenary mode, the returned list contains all of the inquests specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Inquests may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

inquestIds - the list of Ids to retrieve

Returns:

the returned Inquest list

Throws:

NotFoundException - an Id was not found

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByGenusType

InquestList getInquestsByGenusType(Type inquestGenusType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets an InquestList corresponding to the given inquest genus Type which does not include inquests of types derived from the specified Type. In plenary mode, the returned list contains all known inquests or an error results. Otherwise, the returned list may contain only those inquests that are accessible through this session.

Parameters:

inquestGenusType - an inquest genus type

Returns:

the returned Inquest list

Throws:

NullArgumentException - inquestGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByParentGenusType

InquestList getInquestsByParentGenusType(Type inquestGenusType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets an InquestList corresponding to the given inquest genus Type and include any additional inquests with genus types derived from the specified Type. In plenary mode, the returned list contains all known inquests or an error results. Otherwise, the returned list may contain only those inquests that are accessible through this session.

Parameters:

inquestGenusType - an inquest genus type

Returns:

the returned Inquest list

Throws:

NullArgumentException - inquestGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByRecordType

InquestList getInquestsByRecordType(Type inquestRecordType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets an InquestList containing the given inquest record Type. In plenary mode, the returned list contains all known inquests or an error results. Otherwise, the returned list may contain only those inquests that are accessible through this session.

Parameters:

inquestRecordType - an inquest record type

Returns:

the returned Inquest list

Throws:

NullArgumentException - inquestRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByProvider

InquestList getInquestsByProvider(Id resourceId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets an InquestList for the given provider. In plenary mode, the returned list contains all known inquests or an error results. Otherwise, the returned list may contain only those inquests that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Inquest list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquests

InquestList getInquests()
                        throws OperationFailedException,
                               PermissionDeniedException

Gets all Inquests. In plenary mode, the returned list contains all known inquests or an error results. Otherwise, the returned list may contain only those inquests that are accessible through this session.

Returns:

a list of Inquests

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.