org.osid.inquiry.rules

Interface InquiryEnablerInquestSession

All Superinterfaces:

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

public interface InquiryEnablerInquestSession
extends OsidSession

This session provides methods to retrieve InquiryEnabler to Inquest mappings. An InquiryEnabler 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

Methods

Modifier and Type	Method and Description
boolean	canLookupInquiryEnablerInquestMappings() Tests if this user can perform lookups of inquiry enabler/inquest mappings.
IdList	getInquestIdsByInquiryEnabler(Id inquiryEnablerId) Gets the Inquest Ids mapped to an InquiryEnabler.
InquestList	getInquestsByInquiryEnabler(Id inquiryEnablerId) Gets the Inquests mapped to an InquiryEnabler.
IdList	getInquiryEnablerIdsByInquest(Id inquestId) Gets the list of InquiryEnablerIds associated with an Inquest.
IdList	getInquiryEnablerIdsByInquests(IdList inquestIds) Gets the list of InquiryEnabler Ids corresponding to a list of Inquests.
InquiryEnablerList	getInquiryEnablersByInquest(Id inquestId) Gets the list of inquiry enablers associated with an Inquest.
InquiryEnablerList	getInquiryEnablersByInquests(IdList inquestIds) Gets the list of inquiry enablers corresponding to a list of Inquests.
void	useComparativeInquiryEnablerInquestView() 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	usePlenaryInquiryEnablerInquestView() A complete view of the InquiryEnabler and 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

canLookupInquiryEnablerInquestMappings

boolean canLookupInquiryEnablerInquestMappings()

Tests if this user can perform lookups of inquiry enabler/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.

useComparativeInquiryEnablerInquestView

void useComparativeInquiryEnablerInquestView()

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.

usePlenaryInquiryEnablerInquestView

void usePlenaryInquiryEnablerInquestView()

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

getInquiryEnablerIdsByInquest

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

Gets the list of InquiryEnablerIds associated with an Inquest.

Parameters:

inquestId - Id of the Inquest

Returns:

list of related inquiry enabler 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.

getInquiryEnablersByInquest

InquiryEnablerList getInquiryEnablersByInquest(Id inquestId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets the list of inquiry enablers associated with an Inquest.

Parameters:

inquestId - Id of the Inquest

Returns:

list of related inquiry enablers

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.

getInquiryEnablerIdsByInquests

IdList getInquiryEnablerIdsByInquests(IdList inquestIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

inquestIds - list of inquest Ids

Returns:

list of inquiry enabler Ids

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiryEnablersByInquests

InquiryEnablerList getInquiryEnablersByInquests(IdList inquestIds)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the list of inquiry enablers corresponding to a list of Inquests.

Parameters:

inquestIds - list of inquest Ids

Returns:

list of inquiry enablers

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestIdsByInquiryEnabler

IdList getInquestIdsByInquiryEnabler(Id inquiryEnablerId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the Inquest Ids mapped to an InquiryEnabler.

Parameters:

inquiryEnablerId - Id of an InquiryEnabler

Returns:

list of inquests

Throws:

NotFoundException - inquiryEnablerId is not found

NullArgumentException - inquiryEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByInquiryEnabler

InquestList getInquestsByInquiryEnabler(Id inquiryEnablerId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the Inquests mapped to an InquiryEnabler.

Parameters:

inquiryEnablerId - Id of an InquiryEnabler

Returns:

list of inquests

Throws:

NotFoundException - inquiryEnablerId is not found

NullArgumentException - inquiryEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.