Interface AuditConstrainerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditConstrainerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignAuditConstrainerToAudit(Id auditConstrainerId, Id auditId)	Adds an existing AuditConstrainer to an Audit.
boolean	canAssignAuditConstrainers()	Tests if this user can alter audit constrainer/audit mappings.
boolean	canSequenceAuditConstrainers()	Tests if this user can order AuditConstrainers.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
void	moveAuditConstrainerAhead(Id auditConstrainerId, Id auditId, Id referenceId)	Reorders audit constrainers for an audit by moving the specified audit constrainer in front of a reference audit constrainer.
void	moveAuditConstrainerBehind(Id auditConstrainerId, Id auditId, Id referenceId)	Reorders audit constrainers for an audit by moving the specified audit constrainer behind a reference audit constrainer.
void	orderAuditConstrainers(Id[] auditConstrainerIds, Id auditId)	Reorders a set of audit constrainers for an audit.
void	unassignAuditConstrainerFromAudit(Id auditConstrainerId, Id auditId)	Removes an existing AuditConstrainer 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.

canAssignAuditConstrainers

boolean canAssignAuditConstrainers()

Tests if this user can alter audit constrainer/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.

assignAuditConstrainerToAudit

void assignAuditConstrainerToAudit(Id auditConstrainerId,
 Id auditId)
                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuditConstrainer to an Audit.

Parameters:

auditConstrainerId - the Id of the AuditConstrainer

auditId - the Id of the Audit

Throws:

AlreadyExistsException - auditConstrainerId already applied to auditId

NotFoundException - auditConstrainerId or auditId not found

NullArgumentException - auditConstrainerId or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuditConstrainerFromAudit

void unassignAuditConstrainerFromAudit(Id auditConstrainerId,
 Id auditId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing AuditConstrainer from an Audit.

Parameters:

auditConstrainerId - the Id of the AuditConstrainer

auditId - the Id of the Audit

Throws:

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

NullArgumentException - auditConstrainerId or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuditConstrainers

boolean canSequenceAuditConstrainers()

Tests if this user can order AuditConstrainers. 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 AuditConstrainer ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveAuditConstrainerAhead

void moveAuditConstrainerAhead(Id auditConstrainerId,
 Id auditId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders audit constrainers for an audit by moving the specified audit constrainer in front of a reference audit constrainer.

Parameters:

auditConstrainerId - the Id of the AuditConstrainer

auditId - the Id of the Audit

referenceId - the reference audit constrainer Id

Throws:

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

NullArgumentException - auditConstrainerId, auditId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuditConstrainerBehind

void moveAuditConstrainerBehind(Id auditConstrainerId,
 Id auditId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders audit constrainers for an audit by moving the specified audit constrainer behind a reference audit constrainer.

Parameters:

auditConstrainerId - the Id of the AuditConstrainer

auditId - the Id of the Audit

referenceId - the reference audit constrainer Id

Throws:

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

NullArgumentException - auditConstrainerId, auditId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuditConstrainers

void orderAuditConstrainers(Id[] auditConstrainerIds,
 Id auditId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of audit constrainers for an audit.

Parameters:

auditConstrainerIds - the Ids for a set of AuditConstrainers

auditId - the Id of the Audit

Throws:

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

NullArgumentException - auditConstrainerIds or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.