Interface ParameterProcessorEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ParameterProcessorEnablerLookupSession
extends OsidSession

This session provides methods for retrieving ParameterProcessorEnablers .

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 configuration view: All parameter processor enabler methods in this session operate, retrieve and pertain to parameter processor enablers defined explicitly in the current configuration. Using an isolated view is useful for managing ParameterProcessorEnablers with the ParameterProcessorEnablerAdminSession .
• federated configuration view: All parameter processor enabler methods in this session operate, retrieve and pertain to all parameter processor enablers defined in this configuration and any other parameter processor enablers implicitly available in this configuration through configuration inheritence.
• active parameter processor enabler view: All parameter processor enabler lookup methods return active parameter processor enablers.
• any status parameter processor enabler view: Parameter processor 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	canLookupParameterProcessorEnablers()	Tests if this user can perform ParameterProcessorEnablers lookups.
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
ParameterProcessorEnabler	getParameterProcessorEnabler(Id parameterProcessorEnablerId)	Gets the ParameterProcessorEnabler specified by its Id .
ParameterProcessorEnablerList	getParameterProcessorEnablers()	Gets all ParameterProcessorEnablers .
ParameterProcessorEnablerList	getParameterProcessorEnablersByGenusType(Type parameterProcessorEnablerGenusType)	Gets a ParameterProcessorEnablerList corresponding to the given parameter processor enabler genus Type which does not include parameter processor enablers of genus types derived from the specified Type .
ParameterProcessorEnablerList	getParameterProcessorEnablersByIds(IdList parameterProcessorEnablerIds)	Gets a ParameterProcessorEnablerList corresponding to the given IdList .
ParameterProcessorEnablerList	getParameterProcessorEnablersByParentGenusType(Type parameterProcessorEnablerGenusType)	Gets a ParameterProcessorEnablerList corresponding to the given parameter processor enabler genus Type and include any additional parameter processor enablers with genus types derived from the specified Type .
ParameterProcessorEnablerList	getParameterProcessorEnablersByRecordType(Type parameterProcessorEnablerRecordType)	Gets a ParameterProcessorEnablerList containing the given parameter processor enabler record Type .
ParameterProcessorEnablerList	getParameterProcessorEnablersOnDate(DateTime from, DateTime to)	Gets a ParameterProcessorEnablerList that are effective for the entire given date range but not confined to the date range.
ParameterProcessorEnablerList	getParameterProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a ParameterProcessorEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent.
void	useActiveParameterProcessorEnablerView()	Only active parameter processor enablers are returned by methods in this session.
void	useAnyStatusParameterProcessorEnablerView()	All active and inactive parameter processor enablers are returned by methods in this session.
void	useComparativeParameterProcessorEnablerView()	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	useFederatedConfigurationView()	Federates the view for methods in this session.
void	useIsolatedConfigurationView()	Isolates the view for methods in this session.
void	usePlenaryParameterProcessorEnablerView()	A complete view of the ParameterProcessorEnabler 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

getConfigurationId

Id getConfigurationId()

Gets the Configuration Id associated with this session.

Returns:

the Configuration Id associated with this session

Compliance:

mandatory - This method must be implemented.

getConfiguration

Configuration getConfiguration()
                        throws OperationFailedException,
PermissionDeniedException

Gets the Configuration associated with this session.

Returns:

the configuration

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupParameterProcessorEnablers

boolean canLookupParameterProcessorEnablers()

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

useComparativeParameterProcessorEnablerView

void useComparativeParameterProcessorEnablerView()

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.

usePlenaryParameterProcessorEnablerView

void usePlenaryParameterProcessorEnablerView()

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

useFederatedConfigurationView

void useFederatedConfigurationView()

Federates the view for methods in this session. A federated view will include parameter processor enablers in configurations which are children of this configuration in the configuration hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedConfigurationView

void useIsolatedConfigurationView()

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

Compliance:

mandatory - This method is must be implemented.

useActiveParameterProcessorEnablerView

void useActiveParameterProcessorEnablerView()

Only active parameter processor enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusParameterProcessorEnablerView

void useAnyStatusParameterProcessorEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getParameterProcessorEnabler

ParameterProcessorEnabler getParameterProcessorEnabler(Id parameterProcessorEnablerId)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerId - Id of the ParameterProcessorEnabler

Returns:

the parameter processor enabler

Throws:

NotFoundException - parameterProcessorEnablerId not found

NullArgumentException - parameterProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getParameterProcessorEnablersByIds

ParameterProcessorEnablerList getParameterProcessorEnablersByIds(IdList parameterProcessorEnablerIds)
                                                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerIds - the list of Ids to retrieve

Returns:

the returned ParameterProcessorEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - parameterProcessorEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablersByGenusType

ParameterProcessorEnablerList getParameterProcessorEnablersByGenusType(Type parameterProcessorEnablerGenusType)
                                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerGenusType - a parameter processor enabler genus type

Returns:

the returned ParameterProcessorEnabler list

Throws:

NullArgumentException - parameterProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablersByParentGenusType

ParameterProcessorEnablerList getParameterProcessorEnablersByParentGenusType(Type parameterProcessorEnablerGenusType)
                                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerGenusType - a parameter processor enabler genus type

Returns:

the returned ParameterProcessorEnabler list

Throws:

NullArgumentException - parameterProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablersByRecordType

ParameterProcessorEnablerList getParameterProcessorEnablersByRecordType(Type parameterProcessorEnablerRecordType)
                                                                 throws OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerRecordType - a parameter processor enabler record type

Returns:

the returned ParameterProcessorEnabler list

Throws:

NullArgumentException - parameterProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablersOnDate

ParameterProcessorEnablerList getParameterProcessorEnablersOnDate(DateTime from,
 DateTime to)
                                                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

from - a start date

to - an end date

Returns:

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

getParameterProcessorEnablersOnDateWithAgent

ParameterProcessorEnablerList getParameterProcessorEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

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

getParameterProcessorEnablers

ParameterProcessorEnablerList getParameterProcessorEnablers()
                                                     throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned ParameterProcessorEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.