org.osid.inquiry.rules

Interface AuditEnablerRuleApplicationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AuditEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply AuditEnablers to Audits. An Audit with multiple AuditEnablers means any positive rule evaluation across the enablers result in an effective Audit.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignAuditEnablerToAudit(Id auditEnablerId, Id auditId) Adds an existing AuditEnabler to an Audit.
boolean	canAssignAuditEnablers() Tests if this user can alter audit enabler/audit mappings.
boolean	canSequenceAuditEnablers() Tests if this user can order AuditEnablers.
Inquest	getInquest() Gets the Inquest associated with this session.
Id	getInquestId() Gets the Inquest Id associated with this session.
void	moveAuditEnablerAhead(Id auditEnablerId, Id auditId, Id referenceId) Reorders audit enablers for an audit by moving the specified audit enabler in front of a reference audit enabler.
void	moveAuditEnablerBehind(Id auditEnablerId, Id auditId, Id referenceId) Reorders audit enablers for an inquiry by moving the specified audit enabler behind a reference audit enabler.
void	orderAuditEnablers(Id[] auditEnablerIds, Id auditId) Reorders a set of audit enablers for an audit.
void	unassignAuditEnablerFromAudit(Id auditEnablerId, Id auditId) Removes an AuditEnabler from an Audit.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canAssignAuditEnablers

boolean canAssignAuditEnablers()

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

assignAuditEnablerToAudit

void assignAuditEnablerToAudit(Id auditEnablerId,
                             Id auditId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Adds an existing AuditEnabler to an Audit.

Parameters:

auditEnablerId - the Id of the AuditEnabler

auditId - the Id of the Audit

Throws:

AlreadyExistsException - auditEnablerId already applied to auditId

NotFoundException - auditEnablerId or auditId not found

NullArgumentException - auditEnablerId or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuditEnablerFromAudit

void unassignAuditEnablerFromAudit(Id auditEnablerId,
                                 Id auditId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Removes an AuditEnabler from an Audit.

Parameters:

auditEnablerId - the Id of the AuditEnabler

auditId - the Id of the Audit

Throws:

NotFoundException - auditEnablerId or auditId not found or auditEnablerId not applied to auditId

NullArgumentException - auditEnablerId or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceAuditEnablers

boolean canSequenceAuditEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveAuditEnablerAhead

void moveAuditEnablerAhead(Id auditEnablerId,
                         Id auditId,
                         Id referenceId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

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

Parameters:

auditEnablerId - the Id of an AuditEnabler

auditId - the Id of an Audit

referenceId - the reference audit enabler Id

Throws:

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

NullArgumentException - auditEnablerId, auditId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveAuditEnablerBehind

void moveAuditEnablerBehind(Id auditEnablerId,
                          Id auditId,
                          Id referenceId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

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

Parameters:

auditEnablerId - the Id of an AuditEnabler

auditId - the Id of an Audit

referenceId - the reference audit enabler Id

Throws:

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

NullArgumentException - auditEnablerId, auditId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderAuditEnablers

void orderAuditEnablers(Id[] auditEnablerIds,
                      Id auditId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Reorders a set of audit enablers for an audit.

Parameters:

auditEnablerIds - the Ids for a set of AuditEnablers

auditId - the Id of an Audit

Throws:

NotFoundException - inquiryConstraienrId not found or, an auditEnablerId not related to auditId

NullArgumentException - auditEnablerIds or auditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.