public interface ActionEnablerLookupSession extends OsidSession
This session provides methods for retrieving ActionEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
ActionEnablers
with the
ActionEnablerAdminSession.
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 |
canLookupActionEnablers()
Tests if this user can perform
ActionEnablers lookups. |
ActionEnabler |
getActionEnabler(Id actionEnablerId)
Gets the
ActionEnabler specified by its Id. |
ActionEnablerList |
getActionEnablers()
Gets all
ActionEnablers. |
ActionEnablerList |
getActionEnablersByGenusType(Type actionEnablerGenusType)
Gets an
ActionEnablerList corresponding to the given
action enabler genus Type which does not include action
enablers of genus types derived from the specified Type. |
ActionEnablerList |
getActionEnablersByIds(IdList actionEnablerIds)
Gets an
ActionEnablerList corresponding to the given
IdList. |
ActionEnablerList |
getActionEnablersByParentGenusType(Type actionEnablerGenusType)
Gets an
ActionEnablerList corresponding to the given
action enabler genus Type and include any additional
action enablers with genus types derived from the specified
Type. |
ActionEnablerList |
getActionEnablersByRecordType(Type actionEnablerRecordType)
Gets an
ActionEnablerList containing the given action
enabler record Type. |
ActionEnablerList |
getActionEnablersOnDate(DateTime from,
DateTime to)
Gets an
ActionEnablerList that are effective for the
entire given date range but not confined to the date range. |
ActionEnablerList |
getActionEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
ActionEnablerList that are effective for the
entire given date range but not confined to the date range and
evaluated against the given agent. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useActiveActionEnablerView()
Only active action enablers are returned by methods in this session.
|
void |
useAnyStatusActionEnablerView()
All active and inactive action enablers are returned by methods in
this session.
|
void |
useComparativeActionEnablerView()
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 |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenaryActionEnablerView()
A complete view of the
ActionEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupActionEnablers()
ActionEnablers
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 useComparativeActionEnablerView()
mandatory
- This method is must be implemented. void usePlenaryActionEnablerView()
ActionEnabler
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 useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. void useActiveActionEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusActionEnablerView()
mandatory
- This method is must be implemented. ActionEnabler getActionEnabler(Id actionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActionEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ActionEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an ActionEnabler
and retained for
compatibility.
In active mode, action enablers are returned that are currently
active. In any status mode, active and inactive action enablers are
returned.actionEnablerId
- Id
of the ActionEnabler
NotFoundException
- actionEnablerId
not
foundNullArgumentException
- actionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ActionEnablerList getActionEnablersByIds(IdList actionEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActionEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
action 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 ActionEnablers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, action enablers are returned that are currently
active. In any status mode, active and inactive action enablers are
returned.actionEnablerIds
- the list of Ids
to retrieve ActionEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- actionEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActionEnablerList getActionEnablersByGenusType(Type actionEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ActionEnablerList
corresponding to the given
action enabler genus Type
which does not include action
enablers of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
action enablers or an error results. Otherwise, the returned list may
contain only those action enablers that are accessible through this
session.
In active mode, action enablers are returned that are currently
active. In any status mode, active and inactive action enablers are
returned.actionEnablerGenusType
- an action enabler genus type ActionEnabler
listNullArgumentException
- actionEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActionEnablerList getActionEnablersByParentGenusType(Type actionEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ActionEnablerList
corresponding to the given
action enabler genus Type
and include any additional
action enablers with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
action enablers or an error results. Otherwise, the returned list may
contain only those action enablers that are accessible through this
session.
In active mode, action enablers are returned that are currently
active. In any status mode, active and inactive action enablers are
returned.actionEnablerGenusType
- an action enabler genus type ActionEnabler
listNullArgumentException
- actionEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActionEnablerList getActionEnablersByRecordType(Type actionEnablerRecordType) throws OperationFailedException, PermissionDeniedException
ActionEnablerList
containing the given action
enabler record Type.
In plenary mode, the returned list contains all known
action enablers or an error results. Otherwise, the returned list may
contain only those action enablers that are accessible through this
session.
In active mode, action enablers are returned that are currently
active. In any status mode, active and inactive action enablers are
returned.actionEnablerRecordType
- an action enabler record type ActionEnabler
listNullArgumentException
- actionEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActionEnablerList getActionEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActionEnablerList
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
action enablers or an error results. Otherwise, the returned list may
contain only those action enablers that are accessible through this
session.
In active mode, action enablers are returned that are currently active
in addition to being effective during the given date range. In any
status mode, active and inactive action enablers are returned.from
- a start dateto
- an end date ActionEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActionEnablerList getActionEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ActionEnablerList
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
action enablers or an error results. Otherwise, the returned list may
contain only those action enablers that are accessible through this
session.
In active mode, action enablers are returned that are currently active
in addition to being effective during the given date range. In any
status mode, active and inactive action enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date ActionEnabler
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. ActionEnablerList getActionEnablers() throws OperationFailedException, PermissionDeniedException
ActionEnablers.
In plenary mode, the returned list contains all known action enablers
or an error results. Otherwise, the returned list may contain only
those action enablers that are accessible through this session.
In active mode, action enablers are returned that are currently
active. In any status mode, active and inactive action enablers are
returned. ActionEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.