public interface AuthorizationEnablerLookupSession extends OsidSession
This session provides methods for retrieving
AuthorizationEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
AuthorizationEnablers
with the
AuthorizationEnablerAdminSession.
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 |
canLookupAuthorizationEnablers()
Tests if this user can perform
AuthorizationEnablers
lookups. |
AuthorizationEnabler |
getAuthorizationEnabler(Id authorizationEnablerId)
Gets the
AuthorizationEnabler specified by its
Id. |
AuthorizationEnablerList |
getAuthorizationEnablers()
Gets all
AuthorizationEnablers. |
AuthorizationEnablerList |
getAuthorizationEnablersByGenusType(Type authorizationEnablerGenusType)
Gets an
AuthorizationEnablerList corresponding to the
given authorization enabler genus Type which does not
include authorization enablers of genus types derived from the
specified Type. |
AuthorizationEnablerList |
getAuthorizationEnablersByIds(IdList authorizationEnablerIds)
Gets an
AuthorizationEnablerList corresponding to the
given IdList. |
AuthorizationEnablerList |
getAuthorizationEnablersByParentGenusType(Type authorizationEnablerGenusType)
Gets an
AuthorizationEnablerList corresponding to the
given authorization enabler genus Type and include any
additional authorization enablers with genus types derived from the
specified Type. |
AuthorizationEnablerList |
getAuthorizationEnablersByRecordType(Type authorizationEnablerRecordType)
Gets an
AuthorizationEnablerList containing the given
authorization enabler record Type. |
AuthorizationEnablerList |
getAuthorizationEnablersOnDate(DateTime from,
DateTime to)
Gets an
AuthorizationEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
AuthorizationEnablerList |
getAuthorizationEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
AuthorizationEnablerList that are effective for
the entire given date range and evaluated against the given agent. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
useActiveAuthorizationEnablerView()
Only active authorization enablers are returned by methods in this
session.
|
void |
useAnyStatusAuthorizationEnablerView()
All active and inactive authorization enablers are returned by methods
in this session.
|
void |
useComparativeAuthorizationEnablerView()
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 |
useFederatedVaultView()
Federates the view for methods in this session.
|
void |
useIsolatedVaultView()
Isolates the view for methods in this session.
|
void |
usePlenaryAuthorizationEnablerView()
A complete view of the
AuthorizationEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAuthorizationEnablers()
AuthorizationEnablers
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 useComparativeAuthorizationEnablerView()
mandatory
- This method is must be implemented. void usePlenaryAuthorizationEnablerView()
AuthorizationEnabler
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 useFederatedVaultView()
mandatory
- This method is must be implemented. void useIsolatedVaultView()
mandatory
- This method is must be implemented. void useActiveAuthorizationEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusAuthorizationEnablerView()
mandatory
- This method is must be implemented. AuthorizationEnabler getAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuthorizationEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AuthorizationEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to an AuthorizationEnabler
and retained
for compatibility.
In active mode, authorization enablers are returned that are currently
active. In any status mode, active and inactive authorization enablers
are returned.authorizationEnablerId
- Id
of the
AuthorizationEnabler
NotFoundException
- authorizationEnablerId
not foundNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AuthorizationEnablerList getAuthorizationEnablersByIds(IdList authorizationEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuthorizationEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
authorization 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 AuthorizationEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, authorization enablers are returned that are currently
active. In any status mode, active and inactive authorization enablers
are returned.authorizationEnablerIds
- the list of Ids
to
retrieve AuthorizationEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- authorizationEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationEnablerList getAuthorizationEnablersByGenusType(Type authorizationEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerList
corresponding to the
given authorization enabler genus Type
which does not
include authorization enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
authorization enablers or an error results. Otherwise, the returned
list may contain only those authorization enablers that are accessible
through this session.
In active mode, authorization enablers are returned that are currently
active. In any status mode, active and inactive authorization enablers
are returned.authorizationEnablerGenusType
- an authorization enabler genus
type AuthorizationEnabler
listNullArgumentException
-
authorizationEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationEnablerList getAuthorizationEnablersByParentGenusType(Type authorizationEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerList
corresponding to the
given authorization enabler genus Type
and include any
additional authorization enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
authorization enablers or an error results. Otherwise, the returned
list may contain only those authorization enablers that are accessible
through this session.
In active mode, authorization enablers are returned that are currently
active. In any status mode, active and inactive authorization enablers
are returned.authorizationEnablerGenusType
- an authorization enabler genus
type AuthorizationEnabler
listNullArgumentException
-
authorizationEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationEnablerList getAuthorizationEnablersByRecordType(Type authorizationEnablerRecordType) throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerList
containing the given
authorization enabler record Type.
In plenary mode, the returned list contains all known
authorization enablers or an error results. Otherwise, the returned
list may contain only those authorization enablers that are accessible
through this session.
In active mode, authorization enablers are returned that are currently
active. In any status mode, active and inactive authorization enablers
are returned.authorizationEnablerRecordType
- an authorization enabler record
type AuthorizationEnabler
listNullArgumentException
-
authorizationEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationEnablerList getAuthorizationEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range for any agent.
In plenary mode, the returned list contains all known authorization
enablers or an error results. Otherwise, the returned list may contain
only those authorization enablers that are accessible through this
session.
In active mode, authorization enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive authorization enablers are
returned.from
- a start dateto
- an end date AuthorizationEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationEnablerList getAuthorizationEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerList
that are effective for
the entire given date range and evaluated against the given agent.
In plenary mode, the returned list contains all known authorization
enablers or an error results. Otherwise, the returned list may contain
only those authorization enablers that are accessible through this
session.
In active mode, authorization enablers are returned that are currently
active in addition to being effective in the given date range for the
given agent. In any status mode, active and inactive authorization
enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date AuthorizationEnabler
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. AuthorizationEnablerList getAuthorizationEnablers() throws OperationFailedException, PermissionDeniedException
AuthorizationEnablers.
In plenary mode, the returned list contains all known
authorization enablers or an error results. Otherwise, the returned
list may contain only those authorization enablers that are accessible
through this session.
In active mode, authorization enablers are returned that are currently
active. In any status mode, active and inactive authorization enablers
are returned. AuthorizationEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.