Interface AuditProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditProcessorEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignAuditProcessorEnablerToAuditProcessor(Id auditProcessorEnablerId, Id auditProcessorId)	Adds an existing AuditProcessorEnabler to an AuditProcessor.
boolean	canAssignAuditProcessorEnablers()	Tests if this user can alter audit processor enabler/audit processor mappings.
boolean	canSequenceAuditProcessorEnablers()	Tests if this user can order AuditProcessorEnablers.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
void	moveAuditProcessorEnablerAhead(Id auditProcessorEnablerId, Id auditProcessorId, Id referenceId)	Reorders audit processor enablers for an audit processor by moving the specified audit processor enabler in front of a reference audit processor enabler.
void	moveAuditProcessorEnablerBehind(Id auditProcessorEnablerId, Id auditProcessorId, Id referenceId)	Reorders audit processor enablers for an audit processor by moving the specified audit processor enabler behind a reference audit processor enabler.
void	orderAuditProcessorEnablers(Id[] auditProcessorEnablerIds, Id auditProcessorId)	Reorders a set of audit processor enablers for an audit processor.
void	unassignAuditProcessorEnablerFromAuditProcessor(Id auditProcessorEnablerId, Id auditProcessorId)	Removes an existing AuditProcessorEnabler from an AuditProcessor.

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.

canAssignAuditProcessorEnablers

boolean canAssignAuditProcessorEnablers()

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

assignAuditProcessorEnablerToAuditProcessor

void assignAuditProcessorEnablerToAuditProcessor(Id auditProcessorEnablerId,
 Id auditProcessorId)
                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuditProcessorEnabler to an AuditProcessor.

Parameters:

auditProcessorEnablerId - the Id of the AuditProcessorEnabler

auditProcessorId - the Id of the AuditProcessor

Throws:

AlreadyExistsException - auditProcessorEnablerId already applied to auditProcessorId

NotFoundException - auditProcessorEnablerId or auditProcessorId not found

NullArgumentException - auditProcessorEnablerId or auditProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuditProcessorEnablerFromAuditProcessor

void unassignAuditProcessorEnablerFromAuditProcessor(Id auditProcessorEnablerId,
 Id auditProcessorId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing AuditProcessorEnabler from an AuditProcessor.

Parameters:

auditProcessorEnablerId - the Id of the AuditProcessorEnabler

auditProcessorId - the Id of the AuditProcessor

Throws:

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

NullArgumentException - auditProcessorEnablerId or auditProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuditProcessorEnablers

boolean canSequenceAuditProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveAuditProcessorEnablerAhead

void moveAuditProcessorEnablerAhead(Id auditProcessorEnablerId,
 Id auditProcessorId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auditProcessorEnablerId - the Id of the AuditProcessorEnabler

auditProcessorId - the Id of the AuditProcessor

referenceId - the reference audit processor enabler Id

Throws:

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

NullArgumentException - auditProcessorEnablerId, auditProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuditProcessorEnablerBehind

void moveAuditProcessorEnablerBehind(Id auditProcessorEnablerId,
 Id auditProcessorId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auditProcessorEnablerId - the Id of the AuditProcessorEnabler

auditProcessorId - the Id of the AuditProcessor

referenceId - the reference audit processor Id

Throws:

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

NullArgumentException - auditProcessorEnablerId, auditProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuditProcessorEnablers

void orderAuditProcessorEnablers(Id[] auditProcessorEnablerIds,
 Id auditProcessorId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of audit processor enablers for an audit processor.

Parameters:

auditProcessorEnablerIds - the Ids for a set of AuditProcessorEnablers

auditProcessorId - the Id of the AuditProcessor

Throws:

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

NullArgumentException - auditProcessorEnablerIds or auditProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.