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
).
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAuditEnablers()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignAuditEnablersToInquest(Id inquestId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.inquestId
- the Id
of the Inquest
false
if mapping is not authorized, true
otherwiseNullArgumentException
- inquestId
is
null
mandatory
- This method must be implemented. IdList getAssignableInquestIds(Id inquestId) throws OperationFailedException
inquestId
- the Id
of the Inquest
Ids
NullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableInquestIdsForAuditEnabler(Id inquestId, Id auditEnablerId) throws OperationFailedException
inquestId
- the Id
of the Inquest
auditEnablerId
- the Id
of the
AuditEnabler
Ids
NullArgumentException
- inquestId
or
auditEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAuditEnablerToInquest(Id auditEnablerId, Id inquestId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AuditEnabler
to an Inquest.
auditEnablerId
- the Id
of the
AuditEnabler
inquestId
- the Id
of the Inquest
AlreadyExistsException
- auditEnablerId
already assigned to inquestId
NotFoundException
- auditEnablerId
or
inquestId
not foundNullArgumentException
- auditEnablerId
or inquestId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuditEnablerFromInquest(Id auditEnablerId, Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuditEnabler
from an Inquest.
auditEnablerId
- the Id
of the
AuditEnabler
inquestId
- the Id
of the Inquest
NotFoundException
- auditEnablerId
or
inquestId
not found or auditEnablerId
already assigned to inquestId
NullArgumentException
- auditEnablerId
or inquestId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignAuditEnablerEnablerToInquest(Id auditEnablerId, Id fromInquestId, Id toInquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuditEnabler
from one Inquest
to another. Mappings to other Inquests
are unaffected.auditEnablerId
- the Id
of the
AuditEnabler
fromInquestId
- the Id
of the current
Inquest
toInquestId
- the Id
of the destination
Inquest
NotFoundException
- auditEnabler, fromInquestId,
or toInquestId
not found or
auditEnabler
not mapped to fromInquestId
NullArgumentException
- auditEnabler,
fromInquestId,
or toInquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.