public interface AcknowledgementSession extends OsidSession
This session defines methods for evaluating and responding to inquiries for users.
Modifier and Type | Method and Description |
---|---|
boolean |
canCreateResponseWithRecordTypes(Type[] responseRecordTypes)
Tests if this user can create a single
Response using
the desired record types. |
boolean |
canGetMyInquiries()
Tests if this user can perform
Inquiry lookups. |
boolean |
canRespond()
Tests if this user can create responses.
|
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
InquiryList |
getMyInquiries(Id auditId)
Gets the inquiries needing a response for the resource related to this
agent.
|
ResponseForm |
getResponseForm(Id inquiryId,
Type[] responseRecordTypes)
Gets the response form for creating new responses from this agent.
|
Response |
respond(ResponseForm responseForm)
Creates a new
Response from this agent. |
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 canGetMyInquiries()
Inquiry
lookups. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. InquiryList getMyInquiries(Id auditId) throws OperationFailedException, PermissionDeniedException
auditId
- the Id
of an Audit
InquiryList
NullArgumentException
- auditId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRespond()
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 getResponseForm(Id inquiryId, Type[] responseRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquiryId
- the Id
for the inquiryresponseRecordTypes
- array of response record typesNotFoundException
- inquiryId
is not
foundNullArgumentException
- inquiryId
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 respond(ResponseForm responseForm) throws OperationFailedException, PermissionDeniedException
Response
from this agent.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.