public interface ResponseAdminSession extends OsidSession
This session creates, updates, and deletes Responses.
The data for create and update is provided by the consumer via the form
object. OsidForms
are requested for each create or update
and may not be reused.
Create and update operations differ in their usage. To create a
Response,
a ResponseForm
is requested using
getResponseFormForCreate()
specifying the desired inquiry,
resource, and record Types
or none if no record
Types
are needed. The returned ResponseForm
will
indicate that it is to be used with a create operation and can be used to
examine metdata or validate data prior to creation. Once the
ResponseForm
is submiited to a create operation, it cannot be
reused with another create operation unless the first operation was
unsuccessful. Each ResponseForm
corresponds to an attempted
transaction.
For updates, ResponseForms
are requested to the
Response
Id
that is to be updated using
getResponseFormForUpdate().
Similarly, the ResponseForm
has metadata about the data that can be updated and it can perform
validation before submitting the update. The ResponseForm
can only be used once for a successful update and cannot be reused.
The delete operations delete Responses.
To unmap a
Response
from the current Inquest,
the
ResponseInquestAssignmentSession
should be used. These
delete operations attempt to remove the Response
itself
thus removing it from all known Inquest
catalogs.
This session includes an Id
aliasing mechanism to
assign an external Id
to an internally assigned Id.
Modifier and Type | Method and Description |
---|---|
void |
aliasResponse(Id responseId,
Id aliasId)
Adds an
Id to a Response for the purpose
of creating compatibility. |
boolean |
canCreateResponses()
Tests if this user can create responses.
|
boolean |
canCreateResponseWithRecordTypes(Type[] responseRecordTypes)
Tests if this user can create a single
Response using
the desired record types. |
boolean |
canDeleteResponses()
Tests if this user can delete responses.
|
boolean |
canManageResponseAliases()
Tests if this user can manage
Id aliases for
Responses. |
boolean |
canUpdateResponses()
Tests if this user can update responses.
|
Response |
createResponse(ResponseForm responseForm)
Creates a new
Response. |
void |
deleteResponse(Id responseId)
Deletes a
Response. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
ResponseForm |
getResponseFormForCreate(Id inquiryId,
Id resourceId,
Type[] responseRecordTypes)
Gets the response form for creating new responses.
|
ResponseForm |
getResponseFormForUpdate(Id responseId)
Gets the response form for updating an existing response.
|
void |
updateResponse(ResponseForm responseForm)
Updates an existing response.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestId()
Inquest
Id
associated with this
session. Inquest Id
associated with this sessionmandatory
- This method must be implemented. Inquest getInquest() throws OperationFailedException, PermissionDeniedException
Inquest
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateResponses()
Response
will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer create operations to an
unauthorized user. false
if Response
creation is
not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateResponseWithRecordTypes(Type[] responseRecordTypes)
Response
using
the desired record types. While
ControlManager.getResponseRecordTypes()
can be used to examine
which records are supported, this method tests which record(s) are
required for creating a specific Response.
Providing an
empty array tests if a Response
can be created with no
records.responseRecordTypes
- array of response record types true
if Response
creation using
the specified record Types
is supported,
false
otherwiseNullArgumentException
- responseRecordTypes
is null
mandatory
- This method must be implemented. ResponseForm getResponseFormForCreate(Id inquiryId, Id resourceId, Type[] responseRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquiryId
- the Id
for the inquiryresourceId
- the Id
for the responding resourceresponseRecordTypes
- array of response record typesNotFoundException
- inquiryId
or
resourceId
is not foundNullArgumentException
- inquiryId,
resourceId, or responseRecordTypes
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. Response createResponse(ResponseForm responseForm) throws OperationFailedException, PermissionDeniedException
Response.
responseForm
- the form for this Response
Response
IllegalStateException
- responseForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- responseForm
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- responseForm
did
not originate from getResponseFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateResponses()
Response
will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer update operations to an
unauthorized user. false
if Response
modification
is not authorized, true
otherwisemandatory
- This method must be implemented. ResponseForm getResponseFormForUpdate(Id responseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
responseId
- the Id
of the Response
NotFoundException
- responseId
is not
foundNullArgumentException
- responseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateResponse(ResponseForm responseForm) throws OperationFailedException, PermissionDeniedException
responseForm
- the form containing the elements to be updatedIllegalStateException
- responseForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- responseForm
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- responseForm
did
not originate from getResponseFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteResponses()
Response
will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer delete operations to an
unauthorized user. false
if Response
deletion is
not authorized, true
otherwisemandatory
- This method must be implemented. void deleteResponse(Id responseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Response.
responseId
- the Id
of the Response
to removeNotFoundException
- responseId
not foundNullArgumentException
- responseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageResponseAliases()
Id
aliases for
Responses.
A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if Response
aliasing is
not authorized, true
otherwisemandatory
- This method must be implemented. void aliasResponse(Id responseId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a Response
for the purpose
of creating compatibility. The primary Id
of the
Response
is determined by the provider. The new Id
performs as an alias to the primary Id
. If the
alias is a pointer to another response, it is reassigned to the given
response Id.
responseId
- the Id
of a Response
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- responseId
not foundNullArgumentException
- responseId
or
aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.