public interface AuditInquestAssignmentSession extends OsidSession
This session provides methods to re-assign Audit
to
Inquest
mappings. An Audit
may appear in
multiple Inquest
objects and removing the last reference to
an Audit
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 Audit
to another
Inquest
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAuditToInquest(Id auditId,
Id inquestId)
Adds an existing
Audit to a Inquest. |
boolean |
canAssignAudits()
Tests if this user can alter audit/inquest mappings.
|
boolean |
canAssignAuditsToInquest(Id inquestId)
Tests if this user can alter audit/inquest mappings.
|
IdList |
getAssignableInquestIds(Id inquestId)
Gets a list of inquests including and under the given inquest node in
which any audit can be assigned.
|
IdList |
getAssignableInquestIdsForAudit(Id inquestId,
Id auditId)
Gets a list of inquests including and under the given inquest node in
which a specific audit can be assigned.
|
void |
reassignAuditToInquest(Id auditId,
Id fromInquestId,
Id toInquestId)
Moves an
Inquiry from one Inquest to
another. |
void |
unassignAuditFromInquest(Id auditId,
Id inquestId)
Removes an
Audit from an Inquest. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAudits()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignAuditsToInquest(Id inquestId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment 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 getAssignableInquestIdsForAudit(Id inquestId, Id auditId) throws OperationFailedException
inquestId
- the Id
of the Inquest
auditId
- the Id
of the Audit
Ids
NullArgumentException
- inquestId
or
auditId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAuditToInquest(Id auditId, Id inquestId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Audit
to a Inquest.
auditId
- the Id
of the Audit
inquestId
- the Id
of the Inquest
AlreadyExistsException
- auditId
is
already assigned to inquestId
NotFoundException
- auditId
or
inquestId
not foundNullArgumentException
- auditId
or
inquestId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuditFromInquest(Id auditId, Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Audit
from an Inquest.
auditId
- the Id
of the Audit
inquestId
- the Id
of the Inquest
NotFoundException
- auditId
or
inquestId
not found or auditId
not
assigned to inquestId
NullArgumentException
- auditId
or
inquestId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignAuditToInquest(Id auditId, Id fromInquestId, Id toInquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquiry
from one Inquest
to
another. Mappings to other Inquests
are unaffected.auditId
- the Id
of the Audit
fromInquestId
- the Id
of the current
Inquest
toInquestId
- the Id
of the destination
Inquest
NotFoundException
- auditId, fromInquestId,
or toInquestId
not found or
auditiId
not mapped to fromInquestId
NullArgumentException
- auditId, fromInquestId,
or toInquestId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.