public interface AuditLookupSession extends OsidSession
This session provides methods for retrieving Audits.
The
Audit
represents a set of inputs .
This session defines views that offer differing behaviors when retrieving multiple objects.
Audits
with the AuditAdminSession.
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 the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAudits()
Tests if this user can perform
Audit lookups. |
Audit |
getAudit(Id auditId)
Gets the
Audit specified by its Id. |
AuditList |
getAudits()
Gets all
Audits. |
AuditList |
getAuditsByGenusType(Type auditGenusType)
Gets an
AuditList corresponding to the given audit
genus Type which does not include audits of genus types
derived from the specified Type. |
AuditList |
getAuditsByIds(IdList auditIds)
Gets an
AuditList corresponding to the given
IdList. |
AuditList |
getAuditsByParentGenusType(Type auditGenusType)
Gets an
AuditList corresponding to the given audit
genus Type and include any additional audits with genus
types derived from the specified Type. |
AuditList |
getAuditsByProvider(Id resourceId)
Gets an
AuditList by provider. |
AuditList |
getAuditsByRecordType(Type auditRecordType)
Gets an
AuditList containing the given audit record
Type. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
useActiveAuditView()
Only active audits are returned from methods in this session.
|
void |
useAnyStatusAuditView()
Borth active and inactive audits are returned from methods in this
session.
|
void |
useComparativeAuditView()
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 |
usePlenaryAuditView()
A complete view of the
AuditConstrainer 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 canLookupAudits()
Audit
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 useComparativeAuditView()
mandatory
- This method is must be implemented. void usePlenaryAuditView()
AuditConstrainer
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 useActiveAuditView()
mandatory
- This method is must be implemented. void useAnyStatusAuditView()
mandatory
- This method is must be implemented. Audit getAudit(Id auditId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Audit
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Audit
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to
an Audit
and retained for compatibility.
In active mode, audits are returned that are currently active. In any
status mode, active and inactive audits are returned.auditId
- Id
of the Audit
NotFoundException
- auditId
not foundNullArgumentException
- auditId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AuditList getAuditsByIds(IdList auditIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuditList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
audits 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 Audits
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, audits are returned that are currently active. In any
status mode, active and inactive audits are returned.auditIds
- the list of Ids
to retrieve Audit
listNotFoundException
- an Id
was not foundNullArgumentException
- auditIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditList getAuditsByGenusType(Type auditGenusType) throws OperationFailedException, PermissionDeniedException
AuditList
corresponding to the given audit
genus Type
which does not include audits of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
audits or an error results. Otherwise, the returned list may contain
only those audits that are accessible through this session.
In active mode, audits are returned that are currently active. In any
status mode, active and inactive audits are returned.auditGenusType
- an audit genus type Audit
listNullArgumentException
- auditGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditList getAuditsByParentGenusType(Type auditGenusType) throws OperationFailedException, PermissionDeniedException
AuditList
corresponding to the given audit
genus Type
and include any additional audits with genus
types derived from the specified Type.
In plenary mode, the returned list contains all known
audits or an error results. Otherwise, the returned list may contain
only those audits that are accessible through this session.
In active mode, audits are returned that are currently active. In any
status mode, active and inactive audits are returned.auditGenusType
- an audit genus type Audit
listNullArgumentException
- auditGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditList getAuditsByRecordType(Type auditRecordType) throws OperationFailedException, PermissionDeniedException
AuditList
containing the given audit record
Type.
In plenary mode, the returned list contains all known
audits or an error results. Otherwise, the returned list may contain
only those audits that are accessible through this session.
In active mode, audits are returned that are currently active. In any
status mode, active and inactive audits are returned.auditRecordType
- an audit record type Audit
listNullArgumentException
- auditRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditList getAuditsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
AuditList
by provider.
In plenary mode, the returned list contains all known
audits or an error results. Otherwise, the returned list may contain
only those audits that are accessible through this session.
In active mode, audits are returned that are currently active. In any
status mode, active and inactive audits are returned.resourceId
- a resource Id
Audit
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditList getAudits() throws OperationFailedException, PermissionDeniedException
Audits.
In plenary mode, the returned list contains all known audits or an
error results. Otherwise, the returned list may contain only those
audits that are accessible through this session.
In active mode, audits are returned that are currently active. In any
status mode, active and inactive audits are returned. Audits
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.