Interface InquiryEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InquiryEnablerLookupSession
extends OsidSession

This session provides methods for retrieving InquiryEnablers .

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
• isolated inquest view: All inquiry enabler methods in this session operate, retrieve and pertain to inquiry enablers defined explicitly in the current inquest. Using an isolated view is useful for managing InquiryEnablers with the InquiryEnablerAdminSession .
• federated inquest view: All inquiry enabler methods in this session operate, retrieve and pertain to all inquiry enablers defined in this inquest and any other inquiry enablers implicitly available in this inquest through inquest inheritence.
• activee inquiry enabler view: All inquiry enabler lookup methods return active inquiry enablers.
• any status inquiry enabler view: inquiry enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupInquiryEnablers()	Tests if this user can perform InquiryEnablers lookups.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
InquiryEnabler	getInquiryEnabler(Id inquiryEnablerId)	Gets the InquiryEnabler specified by its Id .
InquiryEnablerList	getInquiryEnablers()	Gets all InquiryEnablers .
InquiryEnablerList	getInquiryEnablersByGenusType(Type inquiryEnablerGenusType)	Gets an InquiryEnablerList corresponding to the given inquiry enabler genus Type which does not include inquiry enablers of genus types derived from the specified Type .
InquiryEnablerList	getInquiryEnablersByIds(IdList inquiryEnablerIds)	Gets an InquiryEnablerList corresponding to the given IdList .
InquiryEnablerList	getInquiryEnablersByParentGenusType(Type inquiryEnablerGenusType)	Gets an InquiryEnablerList corresponding to the given inquiry enabler genus Type and include any additional inquiry enablers with genus types derived from the specified Type .
InquiryEnablerList	getInquiryEnablersByRecordType(Type inquiryEnablerRecordType)	Gets an InquiryEnablerList containing the given inquiry enabler record Type .
InquiryEnablerList	getInquiryEnablersOnDate(DateTime from, DateTime to)	Gets an InquiryEnablerList that are effective for the entire given date range but not confined to the date range.
InquiryEnablerList	getInquiryEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets an InquiryEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent.
void	useActiveInquiryEnablerView()	Only active inquiry enablers are returned by methods in this session.
void	useAnyStatusInquiryEnablerView()	All active and inactive inquiry enablers are returned by methods in this session.
void	useComparativeInquiryEnablerView()	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	useFederatedInquestView()	Federates the view for methods in this session.
void	useIsolatedInquestView()	Isolates the view for methods in this session.
void	usePlenaryInquiryEnablerView()	A complete view of the InquiryEnabler 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

getInquestId

Id getInquestId()

Gets the Inquest Id associated with this session.

Returns:

the Inquest Id associated with this session

Compliance:

mandatory - This method must be implemented.

getInquest

Inquest getInquest()
            throws OperationFailedException,
PermissionDeniedException

Gets the Inquest associated with this session.

Returns:

the inquest

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupInquiryEnablers

boolean canLookupInquiryEnablers()

Tests if this user can perform InquiryEnablers 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.

useComparativeInquiryEnablerView

void useComparativeInquiryEnablerView()

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.

usePlenaryInquiryEnablerView

void usePlenaryInquiryEnablerView()

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

useFederatedInquestView

void useFederatedInquestView()

Federates the view for methods in this session. A federated view will include inquiry enablers in inquests which are children of this inquest in the inquest hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedInquestView

void useIsolatedInquestView()

Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only.

Compliance:

mandatory - This method is must be implemented.

useActiveInquiryEnablerView

void useActiveInquiryEnablerView()

Only active inquiry enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusInquiryEnablerView

void useAnyStatusInquiryEnablerView()

All active and inactive inquiry enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getInquiryEnabler

InquiryEnabler getInquiryEnabler(Id inquiryEnablerId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the InquiryEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned InquiryEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to an InquiryEnabler and retained for compatibility. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.

Parameters:

inquiryEnablerId - Id of the InquiryEnabler

Returns:

the inquiry enabler

Throws:

NotFoundException - inquiryEnablerId not found

NullArgumentException - inquiryEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getInquiryEnablersByIds

InquiryEnablerList getInquiryEnablersByIds(IdList inquiryEnablerIds)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets an InquiryEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the inquiry enablers 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 InquiryEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.

Parameters:

inquiryEnablerIds - the list of Ids to retrieve

Returns:

the returned InquiryEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - inquiryEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiryEnablersByGenusType

InquiryEnablerList getInquiryEnablersByGenusType(Type inquiryEnablerGenusType)
                                          throws OperationFailedException,
PermissionDeniedException

Gets an InquiryEnablerList corresponding to the given inquiry enabler genus Type which does not include inquiry enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.

Parameters:

inquiryEnablerGenusType - an inquiry enabler genus type

Returns:

the returned InquiryEnabler list

Throws:

NullArgumentException - inquiryEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiryEnablersByParentGenusType

InquiryEnablerList getInquiryEnablersByParentGenusType(Type inquiryEnablerGenusType)
                                                throws OperationFailedException,
PermissionDeniedException

Gets an InquiryEnablerList corresponding to the given inquiry enabler genus Type and include any additional inquiry enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.

Parameters:

inquiryEnablerGenusType - an inquiry enabler genus type

Returns:

the returned InquiryEnabler list

Throws:

NullArgumentException - inquiryEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiryEnablersByRecordType

InquiryEnablerList getInquiryEnablersByRecordType(Type inquiryEnablerRecordType)
                                           throws OperationFailedException,
PermissionDeniedException

Gets an InquiryEnablerList containing the given inquiry enabler record Type . In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.

Parameters:

inquiryEnablerRecordType - an inquiry enabler record type

Returns:

the returned InquiryEnabler list

Throws:

NullArgumentException - inquiryEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiryEnablersOnDate

InquiryEnablerList getInquiryEnablersOnDate(DateTime from,
 DateTime to)
                                     throws OperationFailedException,
PermissionDeniedException

Gets an InquiryEnablerList that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive inquiry enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned InquiryEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiryEnablersOnDateWithAgent

InquiryEnablerList getInquiryEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                              throws OperationFailedException,
PermissionDeniedException

Gets an InquiryEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive inquiry enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned InquiryEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquiryEnablers

InquiryEnablerList getInquiryEnablers()
                               throws OperationFailedException,
PermissionDeniedException

Gets all InquiryEnablers . In plenary mode, the returned list contains all known inquiry enablers or an error results. Otherwise, the returned list may contain only those inquiry enablers that are accessible through this session. In active mode, inquiry enablers are returned that are currently active. In any status mode, active and inactive inquiry enablers are returned.

Returns:

the returned InquiryEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.