public interface AuditEnablerLookupSession extends OsidSession
This session provides methods for retrieving AuditEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
AuditEnablers
with the AuditEnablerAdminSession.
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 useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAuditEnablers()
Tests if this user can perform
AuditEnablers lookups. |
AuditEnabler |
getAuditEnabler(Id auditEnablerId)
Gets the
AuditEnabler specified by its Id. |
AuditEnablerList |
getAuditEnablers()
Gets all
AuditEnablers. |
AuditEnablerList |
getAuditEnablersByGenusType(Type auditEnablerGenusType)
Gets an
AuditEnablerList corresponding to the given
audit enabler genus Type which does not include audit
enablers of genus types derived from the specified Type. |
AuditEnablerList |
getAuditEnablersByIds(IdList auditEnablerIds)
Gets an
AuditEnablerList corresponding to the given
IdList. |
AuditEnablerList |
getAuditEnablersByParentGenusType(Type auditEnablerGenusType)
Gets an
AuditEnablerList corresponding to the given
audit enabler genus Type and include any additional
audit enablers with genus types derived from the specified
Type. |
AuditEnablerList |
getAuditEnablersByRecordType(Type auditEnablerRecordType)
Gets an
AuditEnablerList containing the given audit
enabler record Type. |
AuditEnablerList |
getAuditEnablersOnDate(DateTime from,
DateTime to)
Gets an
AuditEnablerList that are effective for the
entire given date range but not confined to the date range. |
AuditEnablerList |
getAuditEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
AuditEnablerList that are effective for the
entire given date range but not confined to the date range and
evaluated against the given agent. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
useActiveAuditEnablerView()
Only active audit enablers are returned by methods in this session.
|
void |
useAnyStatusAuditEnablerView()
All active and inactive audit enablers are returned by methods in this
session.
|
void |
useComparativeAuditEnablerView()
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 |
usePlenaryAuditEnablerView()
A complete view of the
AuditEnabler 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 canLookupAuditEnablers()
AuditEnablers
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 useComparativeAuditEnablerView()
mandatory
- This method is must be implemented. void usePlenaryAuditEnablerView()
AuditEnabler
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 useActiveAuditEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusAuditEnablerView()
mandatory
- This method is must be implemented. AuditEnabler getAuditEnabler(Id auditEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuditEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AuditEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an AuditEnabler
and retained for
compatibility.
In active mode, audit enablers are returned that are currently active.
In any status mode, active and inactive audit enablers are returned.auditEnablerId
- Id
of the AuditEnabler
NotFoundException
- auditEnablerId
not
foundNullArgumentException
- auditEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AuditEnablerList getAuditEnablersByIds(IdList auditEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuditEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
audit enablers 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 AuditEnablers
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, audit enablers are returned that are currently active.
In any status mode, active and inactive audit enablers are returned.auditEnablerIds
- the list of Ids
to retrieve AuditEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- auditEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditEnablerList getAuditEnablersByGenusType(Type auditEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AuditEnablerList
corresponding to the given
audit enabler genus Type
which does not include audit
enablers of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
audit enablers or an error results. Otherwise, the returned list may
contain only those audit enablers that are accessible through this
session.
In active mode, audit enablers are returned that are currently active.
In any status mode, active and inactive audit enablers are returned.auditEnablerGenusType
- an audit enabler genus type AuditEnabler
listNullArgumentException
- auditEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditEnablerList getAuditEnablersByParentGenusType(Type auditEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AuditEnablerList
corresponding to the given
audit enabler genus Type
and include any additional
audit enablers with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
audit enablers or an error results. Otherwise, the returned list may
contain only those audit enablers that are accessible through this
session.
In active mode, audit enablers are returned that are currently active.
In any status mode, active and inactive audit enablers are returned.auditEnablerGenusType
- an audit enabler genus type AuditEnabler
listNullArgumentException
- auditEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditEnablerList getAuditEnablersByRecordType(Type auditEnablerRecordType) throws OperationFailedException, PermissionDeniedException
AuditEnablerList
containing the given audit
enabler record Type.
In plenary mode, the returned list contains all known
audit enablers or an error results. Otherwise, the returned list may
contain only those audit enablers that are accessible through this
session.
In active mode, audit enablers are returned that are currently active.
In any status mode, active and inactive audit enablers are returned.auditEnablerRecordType
- an audit enabler record type AuditEnabler
listNullArgumentException
- auditEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditEnablerList getAuditEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AuditEnablerList
that are effective for the
entire given date range but not confined to the date range.
In plenary mode, the returned list contains all known
audit enablers or an error results. Otherwise, the returned list may
contain only those audit enablers that are accessible through this
session.
In active mode, audit enablers are returned that are currently active
in addition to being effective during the given date range. In any
status mode, active and inactive audit enablers are returned.from
- a start dateto
- an end date AuditEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditEnablerList getAuditEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AuditEnablerList
that are effective for the
entire given date range but not confined to the date range and
evaluated against the given agent.
In plenary mode, the returned list contains all known
audit enablers or an error results. Otherwise, the returned list may
contain only those audit enablers that are accessible through this
session.
In active mode, audit enablers are returned that are currently active
in addition to being effective during the given date range. In any
status mode, active and inactive audit enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date AuditEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditEnablerList getAuditEnablers() throws OperationFailedException, PermissionDeniedException
AuditEnablers.
In plenary mode, the returned list contains all known audit enablers
or an error results. Otherwise, the returned list may contain only
those audit enablers that are accessible through this session.
In active mode, audit enablers are returned that are currently active.
In any status mode, active and inactive audit enablers are returned. AuditEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.