Interface AuditInquestSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditInquestSession
extends OsidSession

This session provides methods to retrieve Audit to Inquest mappings. An Audit 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	canLookupAuditInquestMappings()	Tests if this user can perform lookups of audit/inquest mappings.
IdList	getAuditIdsByInquest(Id inquestId)	Gets the list of Audit Ids associated with a Inquest .
IdList	getAuditIdsByInquests(IdList inquestIds)	Gets the list of Audit Ids corresponding to a list of Inquests .
AuditList	getAuditsByInquest(Id inquestId)	Gets the list of audits associated with a Inquest .
AuditList	getAuditsByInquests(IdList inquestIds)	Gets the list of audits corresponding to a list of Inquests .
IdList	getInquestIdsByAudit(Id auditId)	Gets the Inquest Ids mapped to an Audit .
InquestList	getInquestsByAudit(Id auditId)	Gets the Inquests mapped to an Audit .
void	useComparativeAuditInquestView()	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	usePlenaryAuditInquestView()	A complete view of the Audit 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

canLookupAuditInquestMappings

boolean canLookupAuditInquestMappings()

Tests if this user can perform lookups of audit/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.

useComparativeAuditInquestView

void useComparativeAuditInquestView()

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.

usePlenaryAuditInquestView

void usePlenaryAuditInquestView()

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

getAuditIdsByInquest

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

Gets the list of Audit Ids associated with a Inquest .

Parameters:

inquestId - Id of the Inquest

Returns:

list of related audit 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.

getAuditsByInquest

AuditList getAuditsByInquest(Id inquestId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of audits associated with a Inquest .

Parameters:

inquestId - Id of the Inquest

Returns:

list of related audits

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.

getAuditIdsByInquests

IdList getAuditIdsByInquests(IdList inquestIds)
                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inquestIds - list of inquest Ids

Returns:

list of audit Ids

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditsByInquests

AuditList getAuditsByInquests(IdList inquestIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of audits corresponding to a list of Inquests .

Parameters:

inquestIds - list of inquest Ids

Returns:

list of audits

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestIdsByAudit

IdList getInquestIdsByAudit(Id auditId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Inquest Ids mapped to an Audit .

Parameters:

auditId - Id of an Audit

Returns:

list of inquests

Throws:

NotFoundException - auditId is not found

NullArgumentException - auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByAudit

InquestList getInquestsByAudit(Id auditId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Inquests mapped to an Audit .

Parameters:

auditId - Id of an Audit

Returns:

list of inquests

Throws:

NotFoundException - auditId is not found

NullArgumentException - auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.