public interface InquiryLookupSession extends OsidSession
This session provides methods for retrieving Inquiry
objects. The Inquiry
represents a fixed connection between
two Inquiries.
This session defines views that offer differing behaviors when retrieving multiple objects.
Inquiries
with the InquiryAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedInquestView()
and
useIsolatedInquestView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupInquiries()
Tests if this user can perform
Inquiry lookups. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
InquiryList |
getInquiries()
Gets all
Inquiries. |
InquiryList |
getInquiriesByGenusType(Type inquiryGenusType)
Gets an
InquiryList corresponding to the given inquiry
genus Type which does not include inquiries of genus
types derived from the specified Type. |
InquiryList |
getInquiriesByIds(IdList inquiryIds)
Gets an
InquiryList corresponding to the given
IdList. |
InquiryList |
getInquiriesByParentGenusType(Type inquiryGenusType)
Gets an
InquiryList corresponding to the given inquiry
genus Type and include any additional inquiries with
genus types derived from the specified Type. |
InquiryList |
getInquiriesByRecordType(Type inquiryRecordType)
Gets an
InquiryList containing the given inquiry record
Type. |
InquiryList |
getInquiriesForAudit(Id auditId)
Gets a list of inquiries for a supplied audit.
|
Inquiry |
getInquiry(Id inquiryId)
Gets the
Inquiry specified by its Id. |
void |
useActiveInquiryView()
Only active inquiries are returned by methods in this session.
|
void |
useAnyStatusInquiryView()
All inquiries of any active or inactive status are returned by methods
in this session.
|
void |
useComparativeInquiryView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedInquestView()
Federates the view for methods in this session.
|
void |
useIsolatedInquestView()
Isolates the view for methods in this session.
|
void |
usePlenaryInquiryView()
A complete view of the
Inquiry returns is desired. |
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 canLookupInquiries()
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 opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeInquiryView()
mandatory
- This method is must be implemented. void usePlenaryInquiryView()
Inquiry
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedInquestView()
mandatory
- This method is must be implemented. void useIsolatedInquestView()
mandatory
- This method is must be implemented. void useActiveInquiryView()
mandatory
- This method is must be implemented. void useAnyStatusInquiryView()
mandatory
- This method is must be implemented. Inquiry getInquiry(Id inquiryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Inquiry
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Inquiry
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to
an Inquiry
and retained for compatibility.
In active mode, inquiries are returned that are currently active. In
any status mode, both active and inactive inquiries are returned.inquiryId
- Id
of the Inquiry
NotFoundException
- inquiryId
not foundNullArgumentException
- inquiryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. InquiryList getInquiriesByIds(IdList inquiryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
InquiryList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
inquiries specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Inquiries
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, inquiries are returned that are currently active. In
any status mode, both active and inactive inquiries are returned.inquiryIds
- the list of Ids
to retrieve Inquiry
listNotFoundException
- an Id
was not foundNullArgumentException
- inquiryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryList getInquiriesByGenusType(Type inquiryGenusType) throws OperationFailedException, PermissionDeniedException
InquiryList
corresponding to the given inquiry
genus Type
which does not include inquiries of genus
types derived from the specified Type.
In plenary mode, the returned list contains all known
inquiries or an error results. Otherwise, the returned list may
contain only those inquiries that are accessible through this session.
In active mode, inquiries are returned that are currently active. In
any status mode, both active and inactive inquiries are returned.inquiryGenusType
- an inquiry genus type Inquiry
listNullArgumentException
- inquiryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryList getInquiriesByParentGenusType(Type inquiryGenusType) throws OperationFailedException, PermissionDeniedException
InquiryList
corresponding to the given inquiry
genus Type
and include any additional inquiries with
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
inquiries or an error results. Otherwise, the returned list may
contain only those inquiries that are accessible through this session.
In effective mode, inquiries are returned that are currently
effective. In any effective mode, effective inquiries and those
currently expired are returned.inquiryGenusType
- an inquiry genus type Inquiry
listNullArgumentException
- inquiryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryList getInquiriesByRecordType(Type inquiryRecordType) throws OperationFailedException, PermissionDeniedException
InquiryList
containing the given inquiry record
Type.
In plenary mode, the returned list contains all known
inquiries or an error results. Otherwise, the returned list may
contain only those inquiries that are accessible through this session.
In active mode, inquiries are returned that are currently active. In
any status mode, both active and inactive inquiries are returned.inquiryRecordType
- an inquiry record type Inquiry
listNullArgumentException
- inquiryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryList getInquiriesForAudit(Id auditId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
inquiries or an error results. Otherwise, the returned list may
contain only those inquiries that are accessible through this session.
In active mode, inquiries are returned that are currently active. In
any status mode, both active and inactive inquiries are returned.auditId
- an audit Id
Inquiry
listNullArgumentException
- auditId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InquiryList getInquiries() throws OperationFailedException, PermissionDeniedException
Inquiries.
In plenary mode, the returned list contains all known
inquiries or an error results. Otherwise, the returned list may
contain only those inquiries that are accessible through this session.
In active mode, inquiries are returned that are currently active. In
any status mode, both active and inactive inquiries are returned. Inquiries
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.