Interface AuditEnablerInquestSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditEnablerInquestSession
extends OsidSession

This session provides methods to retrieve AuditEnabler to Inquest mappings. An AuditEnabler may appear in multiple Inquest objects. Each inquest may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupAuditEnablerInquestMappings()	Tests if this user can perform lookups of audit enabler/inquest mappings.
IdList	getAuditEnablerIdsByInquest(Id inquestId)	Gets the list of AuditEnablerIds associated with an Inquest .
IdList	getAuditEnablerIdsByInquests(IdList inquestIds)	Gets the list of AuditEnabler Ids corresponding to a list of Inquests .
AuditEnablerList	getAuditEnablersByInquest(Id inquestId)	Gets the list of audit enablers associated with an Inquest .
AuditEnablerList	getAuditEnablersByInquests(IdList inquestIds)	Gets the list of audit enablers corresponding to a list of Inquests .
IdList	getInquestIdsByAuditEnabler(Id auditEnablerId)	Gets the Inquest Ids mapped to an AuditEnabler .
InquestList	getInquestsByAuditEnabler(Id auditEnablerId)	Gets the Inquests mapped to an AuditEnabler .
void	useComparativeAuditEnablerInquestView()	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	usePlenaryAuditEnablerInquestView()	A complete view of the AuditEnabler and Inquest 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

canLookupAuditEnablerInquestMappings

boolean canLookupAuditEnablerInquestMappings()

Tests if this user can perform lookups of audit enabler/inquest mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAuditEnablerInquestView

void useComparativeAuditEnablerInquestView()

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.

usePlenaryAuditEnablerInquestView

void usePlenaryAuditEnablerInquestView()

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

getAuditEnablerIdsByInquest

IdList getAuditEnablerIdsByInquest(Id inquestId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of AuditEnablerIds associated with an Inquest .

Parameters:

inquestId - Id of the Inquest

Returns:

list of related audit enabler Ids

Throws:

NotFoundException - inquestId is not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditEnablersByInquest

AuditEnablerList getAuditEnablersByInquest(Id inquestId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of audit enablers associated with an Inquest .

Parameters:

inquestId - Id of the Inquest

Returns:

list of related audit enablers

Throws:

NotFoundException - inquestId is not found

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditEnablerIdsByInquests

IdList getAuditEnablerIdsByInquests(IdList inquestIds)
                             throws OperationFailedException,
PermissionDeniedException

Gets the list of AuditEnabler Ids corresponding to a list of Inquests .

Parameters:

inquestIds - list of inquest Ids

Returns:

list of audit enabler Ids

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditEnablersByInquests

AuditEnablerList getAuditEnablersByInquests(IdList inquestIds)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the list of audit enablers corresponding to a list of Inquests .

Parameters:

inquestIds - list of inquest Ids

Returns:

list of audit enablers

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestIdsByAuditEnabler

IdList getInquestIdsByAuditEnabler(Id auditEnablerId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Inquest Ids mapped to an AuditEnabler .

Parameters:

auditEnablerId - Id of an AuditEnabler

Returns:

list of inquests

Throws:

NotFoundException - auditEnablerId is not found

NullArgumentException - auditEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByAuditEnabler

InquestList getInquestsByAuditEnabler(Id auditEnablerId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Inquests mapped to an AuditEnabler .

Parameters:

auditEnablerId - Id of an AuditEnabler

Returns:

list of inquests

Throws:

NotFoundException - auditEnablerId is not found

NullArgumentException - auditEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.