Interface AuditProcessorInquestSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditProcessorInquestSession
extends OsidSession

This session provides methods to retrieve AuditProcessor to Inquest mappings. An AuditProcessor may appear in multiple Inquests. Each inque st 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	canLookupAuditProcessorInquestMappings()	Tests if this user can perform lookups of audit processor/inquest mappings.
IdList	getAuditProcessorIdsByInquest(Id inquestId)	Gets the list of AuditProcessorIds associated with an Inquest .
IdList	getAuditProcessorIdsByInquests(IdList inquestIds)	Gets the list of AuditConstrainerIds corresponding to a list of Inquests .
AuditProcessorList	getAuditProcessorsByInquest(Id inquestId)	Gets the list of AuditProcessors associated with an Inquest .
AuditProcessorList	getAuditProcessorsByInquests(IdList inquestIds)	Gets the list of AuditConstrainers corresponding to a list of Inquests .
IdList	getInquestIdsByAuditProcessor(Id auditProcessorId)	Gets the Inquest Ids mapped to an AuditProcessor .
InquestList	getInquestsByAuditProcessor(Id auditProcessorId)	Gets the Inquests mapped to an AuditConstrainer .
void	useComparativeAuditProcessorInquestView()	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	usePlenaryAuditProcessorInquestView()	A complete view of the AuditProcessor 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

canLookupAuditProcessorInquestMappings

boolean canLookupAuditProcessorInquestMappings()

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

useComparativeAuditProcessorInquestView

void useComparativeAuditProcessorInquestView()

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.

usePlenaryAuditProcessorInquestView

void usePlenaryAuditProcessorInquestView()

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

getAuditProcessorIdsByInquest

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

Gets the list of AuditProcessorIds associated with an Inquest .

Parameters:

inquestId - Id of the Inquest

Returns:

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

getAuditProcessorsByInquest

AuditProcessorList getAuditProcessorsByInquest(Id inquestId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of AuditProcessors associated with an Inquest .

Parameters:

inquestId - Id of the Inquest

Returns:

list of related audit processors

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.

getAuditProcessorIdsByInquests

IdList getAuditProcessorIdsByInquests(IdList inquestIds)
                               throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inquestIds - list of inquest Ids

Returns:

list of audit processor Ids

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuditProcessorsByInquests

AuditProcessorList getAuditProcessorsByInquests(IdList inquestIds)
                                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inquestIds - list of inquest Ids

Returns:

list of audit processors

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestIdsByAuditProcessor

IdList getInquestIdsByAuditProcessor(Id auditProcessorId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Inquest Ids mapped to an AuditProcessor .

Parameters:

auditProcessorId - Id of an AuditProcessor

Returns:

list of inquest Ids

Throws:

NotFoundException - auditProcessorId is not found

NullArgumentException - auditProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestsByAuditProcessor

InquestList getInquestsByAuditProcessor(Id auditProcessorId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Inquests mapped to an AuditConstrainer .

Parameters:

auditProcessorId - Id of an AuditProcessor

Returns:

list of inquests

Throws:

NotFoundException - auditProcessorId is not found

NullArgumentException - auditProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.