Interface AuditProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply AuditProcessors to Audits. Multiple AuditProcessors applied to an Audit may be sequenced such that the first positive evaluation results in the AuditProcessor used.

Method Summary

Modifier and Type	Method	Description
void	assignAuditProcessorToAudit(Id auditProcessorId, Id auditId)	Adds an existing AuditProcessor to an Audit.
boolean	canAssignAuditProcessors()	Tests if this user can alter audit processor/audit mappings.
boolean	canSequenceAuditProcessors()	Tests if this user can order AuditProcessors.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
void	moveAuditProcessorAhead(Id auditProcessorId, Id auditId, Id referenceId)	Reorders audit processors for an audit by moving the specified audit processor in front of a reference audit processor.
void	moveAuditProcessorBehind(Id auditProcessorId, Id auditId, Id referenceId)	Reorders audit processors for an audit by moving the specified audit processor behind a reference audit processor.
void	orderAuditProcessors(Id[] auditProcessorIds, Id auditId)	Reorders a set of audit processors for an audit.
void	unassignAuditProcessorFromAudit(Id auditProcessorId, Id auditId)	Removes an existing AuditProcessor from an Audit.

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.

canAssignAuditProcessors

boolean canAssignAuditProcessors()

Tests if this user can alter audit processor/audit mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignAuditProcessorToAudit

void assignAuditProcessorToAudit(Id auditProcessorId,
 Id auditId)
                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuditProcessor to an Audit.

Parameters:

auditProcessorId - the Id of the AuditProcessor

auditId - the Id of the Audit

Throws:

AlreadyExistsException - auditProcessorId already applied to auditId

NotFoundException - auditProcessorId or auditId not found

NullArgumentException - auditProcessorId or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuditProcessorFromAudit

void unassignAuditProcessorFromAudit(Id auditProcessorId,
 Id auditId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing AuditProcessor from an Audit.

Parameters:

auditProcessorId - the Id of the AuditProcessor

auditId - the Id of the Audit

Throws:

NotFoundException - auditProcessorId or auditId not found or auditProcessorId already applied to auditId

NullArgumentException - auditProcessorId or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuditProcessors

boolean canSequenceAuditProcessors()

Tests if this user can order AuditProcessors. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED.This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if AuditProcessor ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveAuditProcessorAhead

void moveAuditProcessorAhead(Id auditProcessorId,
 Id auditId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders audit processors for an audit by moving the specified audit processor in front of a reference audit processor.

Parameters:

auditProcessorId - the Id of the AuditProcessor

auditId - the Id of the Audit

referenceId - the reference audit processor Id

Throws:

NotFoundException - auditProcessorId auditId, or referenceId not found or, auditProcessorId or referenceId not related to auditId

NullArgumentException - auditProcessorId, auditId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuditProcessorBehind

void moveAuditProcessorBehind(Id auditProcessorId,
 Id auditId,
 Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders audit processors for an audit by moving the specified audit processor behind a reference audit processor.

Parameters:

auditProcessorId - the Id of the AuditProcessor

auditId - the Id of the Audit

referenceId - the reference audit processor Id

Throws:

NotFoundException - auditProcessorId, auditId, or referenceId not found or, auditProcessorId or referenceId not related to auditId

NullArgumentException - auditProcessorId, auditId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuditProcessors

void orderAuditProcessors(Id[] auditProcessorIds,
 Id auditId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of audit processors for an audit.

Parameters:

auditProcessorIds - the Ids for a set of AuditProcessors

auditId - the Id of the Audit

Throws:

NotFoundException - auditId not found or, an auditProcessorId not related to auditId

NullArgumentException - auditProcessorIds or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.