Interface AuditEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditEnablerLookupSession
extends OsidSession

This session provides methods for retrieving AuditEnablers .

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 audit enabler methods in this session operate, retrieve and pertain to audit enablers defined explicitly in the current inquest. Using an isolated view is useful for managing AuditEnablers with the AuditEnablerAdminSession .
• federated inquest view: All audit enabler methods in this session operate, retrieve and pertain to all audit enablers defined in this inquest and any other audit enablers implicitly available in this inquest through inquest inheritence.
• activee audit enabler view: All audit enabler lookup methods return active audit enablers.
• any status audit enabler view: audit 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	canLookupAuditEnablers()	Tests if this user can perform AuditEnablers lookups.
AuditEnabler	getAuditEnabler(Id auditEnablerId)	Gets the AuditEnabler specified by its Id .
AuditEnablerList	getAuditEnablers()	Gets all AuditEnablers .
AuditEnablerList	getAuditEnablersByGenusType(Type auditEnablerGenusType)	Gets an AuditEnablerList corresponding to the given audit enabler genus Type which does not include audit enablers of genus types derived from the specified Type .
AuditEnablerList	getAuditEnablersByIds(IdList auditEnablerIds)	Gets an AuditEnablerList corresponding to the given IdList .
AuditEnablerList	getAuditEnablersByParentGenusType(Type auditEnablerGenusType)	Gets an AuditEnablerList corresponding to the given audit enabler genus Type and include any additional audit enablers with genus types derived from the specified Type .
AuditEnablerList	getAuditEnablersByRecordType(Type auditEnablerRecordType)	Gets an AuditEnablerList containing the given audit enabler record Type .
AuditEnablerList	getAuditEnablersOnDate(DateTime from, DateTime to)	Gets an AuditEnablerList that are effective for the entire given date range but not confined to the date range.
AuditEnablerList	getAuditEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets an AuditEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
void	useActiveAuditEnablerView()	Only active audit enablers are returned by methods in this session.
void	useAnyStatusAuditEnablerView()	All active and inactive audit enablers are returned by methods in this session.
void	useComparativeAuditEnablerView()	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	usePlenaryAuditEnablerView()	A complete view of the AuditEnabler 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.

canLookupAuditEnablers

boolean canLookupAuditEnablers()

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

useComparativeAuditEnablerView

void useComparativeAuditEnablerView()

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.

usePlenaryAuditEnablerView

void usePlenaryAuditEnablerView()

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

useActiveAuditEnablerView

void useActiveAuditEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusAuditEnablerView

void useAnyStatusAuditEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getAuditEnabler

AuditEnabler getAuditEnabler(Id auditEnablerId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auditEnablerId - Id of the AuditEnabler

Returns:

the audit enabler

Throws:

NotFoundException - auditEnablerId not found

NullArgumentException - auditEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getAuditEnablersByIds

AuditEnablerList getAuditEnablersByIds(IdList auditEnablerIds)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auditEnablerIds - the list of Ids to retrieve

Returns:

the returned AuditEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - auditEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditEnablersByGenusType

AuditEnablerList getAuditEnablersByGenusType(Type auditEnablerGenusType)
                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

auditEnablerGenusType - an audit enabler genus type

Returns:

the returned AuditEnabler list

Throws:

NullArgumentException - auditEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditEnablersByParentGenusType

AuditEnablerList getAuditEnablersByParentGenusType(Type auditEnablerGenusType)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

auditEnablerGenusType - an audit enabler genus type

Returns:

the returned AuditEnabler list

Throws:

NullArgumentException - auditEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditEnablersByRecordType

AuditEnablerList getAuditEnablersByRecordType(Type auditEnablerRecordType)
                                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

auditEnablerRecordType - an audit enabler record type

Returns:

the returned AuditEnabler list

Throws:

NullArgumentException - auditEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditEnablersOnDate

AuditEnablerList getAuditEnablersOnDate(DateTime from,
 DateTime to)
                                 throws OperationFailedException,
PermissionDeniedException

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

Parameters:

from - a start date

to - an end date

Returns:

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

getAuditEnablersOnDateWithAgent

AuditEnablerList getAuditEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

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

getAuditEnablers

AuditEnablerList getAuditEnablers()
                           throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned AuditEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.