Interface ResponseAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

ResponseBatchAdminSession

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getInquestId

Id getInquestId()

Gets the Inquest Id associated with this session.

Returns:

the Inquest Id associated with this session

Compliance:

mandatory - This method must be implemented.

getInquest

Inquest getInquest()
            throws OperationFailedException,
PermissionDeniedException

Gets the Inquest associated with this session.

Returns:

the inquest

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateResponses

boolean canCreateResponses()

Tests if this user can create responses. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a 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.

Returns:

false if Response creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateResponseWithRecordTypes

boolean canCreateResponseWithRecordTypes(Type[] responseRecordTypes)

Tests if this user can create a single 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.

Parameters:

responseRecordTypes - array of response record types

Returns:

true if Response creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - responseRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getResponseFormForCreate

ResponseForm getResponseFormForCreate(Id inquiryId,
 Id resourceId,
 Type[] responseRecordTypes)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the response form for creating new responses. A new form should be requested for each create transaction.

Parameters:

inquiryId - the Id for the inquiry

resourceId - the Id for the responding resource

responseRecordTypes - array of response record types

Returns:

the response form

Throws:

NotFoundException - inquiryId or resourceId is not found

NullArgumentException - inquiryId , resourceId, or responseRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createResponse

Response createResponse(ResponseForm responseForm)
                 throws OperationFailedException,
PermissionDeniedException

Creates a new Response .

Parameters:

responseForm - the form for this Response

Returns:

the new Response

Throws:

IllegalStateException - responseForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - responseForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - responseForm did not originate from getResponseFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateResponses

boolean canUpdateResponses()

Tests if this user can update responses. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a 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.

Returns:

false if Response modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getResponseFormForUpdate

ResponseForm getResponseFormForUpdate(Id responseId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the response form for updating an existing response. A new response form should be requested for each update transaction.

Parameters:

responseId - the Id of the Response

Returns:

the response form

Throws:

NotFoundException - responseId is not found

NullArgumentException - responseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateResponse

void updateResponse(ResponseForm responseForm)
             throws OperationFailedException,
PermissionDeniedException

Updates an existing response.

Parameters:

responseForm - the form containing the elements to be updated

Throws:

IllegalStateException - responseForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - responseForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - responseForm did not originate from getResponseFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteResponses

boolean canDeleteResponses()

Tests if this user can delete responses. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a 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.

Returns:

false if Response deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteResponse

void deleteResponse(Id responseId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Response .

Parameters:

responseId - the Id of the Response to remove

Throws:

NotFoundException - responseId not found

NullArgumentException - responseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageResponseAliases

boolean canManageResponseAliases()

Tests if this user can manage 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.

Returns:

false if Response aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasResponse

void aliasResponse(Id responseId,
 Id aliasId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an 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 .

Parameters:

responseId - the Id of a Response

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - responseId not found

NullArgumentException - responseId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.