Interface ActionEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActionEnablerLookupSession
extends OsidSession

This session provides methods for retrieving ActionEnablers .

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 action enabler methods in this session operate, retrieve and pertain to action enablers defined explicitly in the current system. Using an isolated view is useful for managing ActionEnablers with the ActionEnablerAdminSession .
• federated system view: All action enabler methods in this session operate, retrieve and pertain to all action enablers defined in this system and any other action enablers implicitly available in this system through system inheritence.
• activee action enabler view: All action enabler lookup methods return active action enablers.
• any status action enabler view: action 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	canLookupActionEnablers()	Tests if this user can perform ActionEnablers lookups.
ActionEnabler	getActionEnabler(Id actionEnablerId)	Gets the ActionEnabler specified by its Id .
ActionEnablerList	getActionEnablers()	Gets all ActionEnablers .
ActionEnablerList	getActionEnablersByGenusType(Type actionEnablerGenusType)	Gets an ActionEnablerList corresponding to the given action enabler genus Type which does not include action enablers of genus types derived from the specified Type .
ActionEnablerList	getActionEnablersByIds(IdList actionEnablerIds)	Gets an ActionEnablerList corresponding to the given IdList .
ActionEnablerList	getActionEnablersByParentGenusType(Type actionEnablerGenusType)	Gets an ActionEnablerList corresponding to the given action enabler genus Type and include any additional action enablers with genus types derived from the specified Type .
ActionEnablerList	getActionEnablersByRecordType(Type actionEnablerRecordType)	Gets an ActionEnablerList containing the given action enabler record Type .
ActionEnablerList	getActionEnablersOnDate(DateTime from, DateTime to)	Gets an ActionEnablerList that are effective for the entire given date range but not confined to the date range.
ActionEnablerList	getActionEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets an ActionEnablerList that are effective for 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	useActiveActionEnablerView()	Only active action enablers are returned by methods in this session.
void	useAnyStatusActionEnablerView()	All active and inactive action enablers are returned by methods in this session.
void	useComparativeActionEnablerView()	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	usePlenaryActionEnablerView()	A complete view of the ActionEnabler 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.

canLookupActionEnablers

boolean canLookupActionEnablers()

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

useComparativeActionEnablerView

void useComparativeActionEnablerView()

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.

usePlenaryActionEnablerView

void usePlenaryActionEnablerView()

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

useActiveActionEnablerView

void useActiveActionEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusActionEnablerView

void useAnyStatusActionEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getActionEnabler

ActionEnabler getActionEnabler(Id actionEnablerId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

actionEnablerId - Id of the ActionEnabler

Returns:

the action enabler

Throws:

NotFoundException - actionEnablerId not found

NullArgumentException - actionEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getActionEnablersByIds

ActionEnablerList getActionEnablersByIds(IdList actionEnablerIds)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

actionEnablerIds - the list of Ids to retrieve

Returns:

the returned ActionEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - actionEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionEnablersByGenusType

ActionEnablerList getActionEnablersByGenusType(Type actionEnablerGenusType)
                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

actionEnablerGenusType - an action enabler genus type

Returns:

the returned ActionEnabler list

Throws:

NullArgumentException - actionEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionEnablersByParentGenusType

ActionEnablerList getActionEnablersByParentGenusType(Type actionEnablerGenusType)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

actionEnablerGenusType - an action enabler genus type

Returns:

the returned ActionEnabler list

Throws:

NullArgumentException - actionEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionEnablersByRecordType

ActionEnablerList getActionEnablersByRecordType(Type actionEnablerRecordType)
                                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

actionEnablerRecordType - an action enabler record type

Returns:

the returned ActionEnabler list

Throws:

NullArgumentException - actionEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionEnablersOnDate

ActionEnablerList getActionEnablersOnDate(DateTime from,
 DateTime to)
                                   throws OperationFailedException,
PermissionDeniedException

Gets an ActionEnablerList 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 action enablers or an error results. Otherwise, the returned list may contain only those action enablers that are accessible through this session. In active mode, action enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive action enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

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

getActionEnablersOnDateWithAgent

ActionEnablerList getActionEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                            throws OperationFailedException,
PermissionDeniedException

Gets an ActionEnablerList 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 action enablers or an error results. Otherwise, the returned list may contain only those action enablers that are accessible through this session. In active mode, action enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive action enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

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

getActionEnablers

ActionEnablerList getActionEnablers()
                             throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned ActionEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.