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