Interface InputEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InputEnablerLookupSession
extends OsidSession

This session provides methods for retrieving InputEnablers .

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 system view: All input enabler methods in this session operate, retrieve and pertain to input enablers defined explicitly in the current system. Using an isolated view is useful for managing InputEnablers with the InputEnablerAdminSession .
• federated system view: All input enabler methods in this session operate, retrieve and pertain to all input enablers defined in this system and any other input enablers implicitly available in this system through system inheritence.
• active input enabler view: All input enabler lookup methods return active input enablers.
• any status input enabler view: input 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	canLookupInputEnablers()	Tests if this user can perform InputEnablers lookups.
InputEnabler	getInputEnabler(Id inputEnablerId)	Gets the InputEnabler specified by its Id .
InputEnablerList	getInputEnablers()	Gets all InputEnablers .
InputEnablerList	getInputEnablersByGenusType(Type inputEnablerGenusType)	Gets an InputEnablerList corresponding to the given input enabler genus Type which does not include input enablers of genus types derived from the specified Type .
InputEnablerList	getInputEnablersByIds(IdList inputEnablerIds)	Gets an InputEnablerList corresponding to the given IdList .
InputEnablerList	getInputEnablersByParentGenusType(Type inputEnablerGenusType)	Gets an InputEnablerList corresponding to the given input enabler genus Type and include any additional input enablers with genus types derived from the specified Type .
InputEnablerList	getInputEnablersByRecordType(Type inputEnablerRecordType)	Gets an InputEnablerList containing the given input enabler record Type .
InputEnablerList	getInputEnablersOnDate(DateTime from, DateTime to)	Gets an InputEnablerList effective within the given date range.
InputEnablerList	getInputEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets an InputEnablerList effective during the entire given date range but not confined to the date range and evaluated against the given agent.
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	useActiveInputEnablerView()	Only active input enablers are returned by methods in this session.
void	useAnyStatusInputEnablerView()	All active and inactive input enablers are returned by methods in this session.
void	useComparativeInputEnablerView()	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	useFederatedSystemView()	Federates the view for methods in this session.
void	useIsolatedSystemView()	Isolates the view for methods in this session.
void	usePlenaryInputEnablerView()	A complete view of the InputEnabler 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

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
          throws OperationFailedException,
PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupInputEnablers

boolean canLookupInputEnablers()

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

useComparativeInputEnablerView

void useComparativeInputEnablerView()

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.

usePlenaryInputEnablerView

void usePlenaryInputEnablerView()

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

useFederatedSystemView

void useFederatedSystemView()

Federates the view for methods in this session. A federated view will include input enablers in systems which are children of this system in the system hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedSystemView

void useIsolatedSystemView()

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

Compliance:

mandatory - This method is must be implemented.

useActiveInputEnablerView

void useActiveInputEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusInputEnablerView

void useAnyStatusInputEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getInputEnabler

InputEnabler getInputEnabler(Id inputEnablerId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

inputEnablerId - Id of the InputEnabler

Returns:

the input enabler

Throws:

NotFoundException - inputEnablerId not found

NullArgumentException - inputEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getInputEnablersByIds

InputEnablerList getInputEnablersByIds(IdList inputEnablerIds)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

inputEnablerIds - the list of Ids to retrieve

Returns:

the returned InputEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - inputEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputEnablersByGenusType

InputEnablerList getInputEnablersByGenusType(Type inputEnablerGenusType)
                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inputEnablerGenusType - an input enabler genus type

Returns:

the returned InputEnabler list

Throws:

NullArgumentException - inputEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputEnablersByParentGenusType

InputEnablerList getInputEnablersByParentGenusType(Type inputEnablerGenusType)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inputEnablerGenusType - an input enabler genus type

Returns:

the returned InputEnabler list

Throws:

NullArgumentException - inputEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputEnablersByRecordType

InputEnablerList getInputEnablersByRecordType(Type inputEnablerRecordType)
                                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inputEnablerRecordType - an input enabler record type

Returns:

the returned InputEnabler list

Throws:

NullArgumentException - inputEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInputEnablersOnDate

InputEnablerList getInputEnablersOnDate(DateTime from,
 DateTime to)
                                 throws OperationFailedException,
PermissionDeniedException

Gets an InputEnablerList effective within the given date range. In plenary mode, the returned list contains all known input enablers or an error results. Otherwise, the returned list may contain only those input enablers that are accessible through this session. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned InputEnabler 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.

getInputEnablersOnDateWithAgent

InputEnablerList getInputEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                          throws OperationFailedException,
PermissionDeniedException

Gets an InputEnablerList effective during 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 input enablers or an error results. Otherwise, the returned list may contain only those input enablers that are accessible through this session. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned InputEnabler 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.

getInputEnablers

InputEnablerList getInputEnablers()
                           throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned InputEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.