Interface AuditConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditConstrainerEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignAuditConstrainerEnablerToAuditConstrainer(Id auditConstrainerEnablerId, Id auditConstrainerId)	Adds an existing AuditConstrainerEnabler to an AuditConstrainer.
boolean	canAssignAuditConstrainerEnablers()	Tests if this user can alter audit constrainer enabler/audit constrainer mappings.
boolean	canSequenceAuditConstrainerEnablers()	Tests if this user can order AuditConstrainerEnablers.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
void	moveAuditConstrainerEnablerAhead(Id auditConstrainerEnablerId, Id auditConstrainerId, Id referenceId)	Reorders audit constrainer enablers for an audit constrainer by moving the specified audit constrainer enabler in front of a reference audit constrainer enabler.
void	moveAuditConstrainerEnablerBehind(Id auditConstrainerEnablerId, Id auditConstrainerId, Id referenceId)	Reorders audit constrainer enablers for an audit constrainer by moving the specified audit constrainer enabler behind a reference audit constrainer enabler.
void	orderAuditConstrainerEnablers(Id[] auditConstrainerEnablerIds, Id auditConstrainerId)	Reorders a set of audit constrainer enablers for an audit constrainer.
void	unassignAuditConstrainerEnablerFromAuditConstrainer(Id auditConstrainerEnablerId, Id auditConstrainerId)	Removes an existing AuditConstrainerEnabler from an AuditConstrainer.

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.

canAssignAuditConstrainerEnablers

boolean canAssignAuditConstrainerEnablers()

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

assignAuditConstrainerEnablerToAuditConstrainer

void assignAuditConstrainerEnablerToAuditConstrainer(Id auditConstrainerEnablerId,
 Id auditConstrainerId)
                                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing AuditConstrainerEnabler to an AuditConstrainer.

Parameters:

auditConstrainerEnablerId - the Id of the AuditConstrainerEnabler

auditConstrainerId - the Id of the AuditConstrainer

Throws:

AlreadyExistsException - auditConstrainerEnablerId already applied to auditConstrainerId

NotFoundException - auditConstrainerEnablerId or auditConstrainerId not found

NullArgumentException - auditConstrainerEnablerId or auditConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuditConstrainerEnablerFromAuditConstrainer

void unassignAuditConstrainerEnablerFromAuditConstrainer(Id auditConstrainerEnablerId,
 Id auditConstrainerId)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing AuditConstrainerEnabler from an AuditConstrainer.

Parameters:

auditConstrainerEnablerId - the Id of the AuditConstrainerEnabler

auditConstrainerId - the Id of the AuditConstrainer

Throws:

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

NullArgumentException - auditConstrainerEnablerId or auditConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuditConstrainerEnablers

boolean canSequenceAuditConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveAuditConstrainerEnablerAhead

void moveAuditConstrainerEnablerAhead(Id auditConstrainerEnablerId,
 Id auditConstrainerId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auditConstrainerEnablerId - the Id of the AuditConstrainerEnabler

auditConstrainerId - the Id of the AuditConstrainer

referenceId - the reference audit constrainer enabler Id

Throws:

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

NullArgumentException - auditConstrainerEnablerId, auditConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuditConstrainerEnablerBehind

void moveAuditConstrainerEnablerBehind(Id auditConstrainerEnablerId,
 Id auditConstrainerId,
 Id referenceId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auditConstrainerEnablerId - the Id of the AuditConstrainerEnabler

auditConstrainerId - the Id of the AuditConstrainer

referenceId - the reference audit constrainer Id

Throws:

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

NullArgumentException - auditConstrainerEnablerId, auditConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuditConstrainerEnablers

void orderAuditConstrainerEnablers(Id[] auditConstrainerEnablerIds,
 Id auditConstrainerId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auditConstrainerEnablerIds - the Ids for a set of AuditConstrainerEnablers

auditConstrainerId - the Id of the AuditConstrainer

Throws:

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

NullArgumentException - auditConstrainerEnablerIds or auditConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.