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