org.osid.inquiry.rules

Interface AuditEnablerInquestAssignmentSession

All Superinterfaces:

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

public interface AuditEnablerInquestAssignmentSession
extends OsidSession

This session provides methods to re-assign AuditEnabler to Inquest mappings. An AuditEnabler may appear in multiple Inquest objects and removing the last reference to an AuditEnabler is the equivalent of deleting it. Each Inquest may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an AuditEnabler to another Inquest is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignAuditEnablerToInquest(Id auditEnablerId, Id inquestId) Adds an existing AuditEnabler to an Inquest.
boolean	canAssignAuditEnablers() Tests if this user can alter audit enabler/inquest mappings.
boolean	canAssignAuditEnablersToInquest(Id inquestId) Tests if this user can alter audit enabler/inquest mappings.
IdList	getAssignableInquestIds(Id inquestId) Gets a list of inquests including and under the given inquest node in which any audit enabler can be assigned.
IdList	getAssignableInquestIdsForAuditEnabler(Id inquestId, Id auditEnablerId) Gets a list of inquests including and under the given inquest node in which a specific audit enabler can be assigned.
void	reassignAuditEnablerEnablerToInquest(Id auditEnablerId, Id fromInquestId, Id toInquestId) Moves an AuditEnabler from one Inquest to another.
void	unassignAuditEnablerFromInquest(Id auditEnablerId, Id inquestId) Removes an AuditEnabler from an Inquest.

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

canAssignAuditEnablers

boolean canAssignAuditEnablers()

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

canAssignAuditEnablersToInquest

boolean canAssignAuditEnablersToInquest(Id inquestId)

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

Parameters:

inquestId - the Id of the Inquest

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - inquestId is null

Compliance:

mandatory - This method must be implemented.

getAssignableInquestIds

IdList getAssignableInquestIds(Id inquestId)
                               throws OperationFailedException

Gets a list of inquests including and under the given inquest node in which any audit enabler can be assigned.

Parameters:

inquestId - the Id of the Inquest

Returns:

list of assignable inquest Ids

Throws:

NullArgumentException - inquestId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableInquestIdsForAuditEnabler

IdList getAssignableInquestIdsForAuditEnabler(Id inquestId,
                                            Id auditEnablerId)
                                              throws OperationFailedException

Gets a list of inquests including and under the given inquest node in which a specific audit enabler can be assigned.

Parameters:

inquestId - the Id of the Inquest

auditEnablerId - the Id of the AuditEnabler

Returns:

list of assignable inquest Ids

Throws:

NullArgumentException - inquestId or auditEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignAuditEnablerToInquest

void assignAuditEnablerToInquest(Id auditEnablerId,
                               Id inquestId)
                                 throws AlreadyExistsException,
                                        NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Adds an existing AuditEnabler to an Inquest.

Parameters:

auditEnablerId - the Id of the AuditEnabler

inquestId - the Id of the Inquest

Throws:

AlreadyExistsException - auditEnablerId already assigned to inquestId

NotFoundException - auditEnablerId or inquestId not found

NullArgumentException - auditEnablerId or inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignAuditEnablerFromInquest

void unassignAuditEnablerFromInquest(Id auditEnablerId,
                                   Id inquestId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Removes an AuditEnabler from an Inquest.

Parameters:

auditEnablerId - the Id of the AuditEnabler

inquestId - the Id of the Inquest

Throws:

NotFoundException - auditEnablerId or inquestId not found or auditEnablerId already assigned to inquestId

NullArgumentException - auditEnablerId or inquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignAuditEnablerEnablerToInquest

void reassignAuditEnablerEnablerToInquest(Id auditEnablerId,
                                        Id fromInquestId,
                                        Id toInquestId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Moves an AuditEnabler from one Inquest to another. Mappings to other Inquests are unaffected.

Parameters:

auditEnablerId - the Id of the AuditEnabler

fromInquestId - the Id of the current Inquest

toInquestId - the Id of the destination Inquest

Throws:

NotFoundException - auditEnabler, fromInquestId, or toInquestId not found or auditEnabler not mapped to fromInquestId

NullArgumentException - auditEnabler, fromInquestId, or toInquestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.