public interface CanonicalUnitEnablerLookupSession extends OsidSession
This session provides methods for retrieving
CanonicalUnitEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
CanonicalUnitEnablers
with the
CanonicalUnitEnablerAdminSession.
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 |
canLookupCanonicalUnitEnablers()
Tests if this user can perform
CanonicalUnitEnablers
lookups. |
CanonicalUnitEnabler |
getCanonicalUnitEnabler(Id canonicalUnitEnablerId)
Gets the
CanonicalUnitEnabler specified by its
Id. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablers()
Gets all
CanonicalUnitEnablers. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersByGenusType(Type canonicalUnitEnablerGenusType)
Gets a
CanonicalUnitEnablerList corresponding to the
given canonical unit enabler genus Type which does not
include canonical unit enablers of genus types derived from the
specified Type. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersByIds(IdList canonicalUnitEnablerIds)
Gets a
CanonicalUnitEnablerList corresponding to the
given IdList. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersByParentGenusType(Type canonicalUnitEnablerGenusType)
Gets a
CanonicalUnitEnablerList corresponding to the
given canonical unit enabler genus Type and include any
additional canonical unit enablers with genus types derived from the
specified Type. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersByRecordType(Type canonicalUnitEnablerRecordType)
Gets a
CanonicalUnitEnablerList containing the given
canonical unit enabler record Type. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersOnDate(DateTime from,
DateTime to)
Gets a
CanonicalUnitEnablerList that are effective for
the entire given date range but not confined to the date range. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
CanonicalUnitEnablerList that are effective for
the entire given date range but not confined to the date range and
evaluated against the given agent. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
useActiveCanonicalUnitEnablerView()
Only active canonical unit enablers are returned by methods in this
session.
|
void |
useAnyStatusCanonicalUnitEnablerView()
All active and inactive canonical unit enablers are returned by
methods in this session.
|
void |
useComparativeCanonicalUnitEnablerView()
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 |
useFederatedCatalogueView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogueView()
Isolates the view for methods in this session.
|
void |
usePlenaryCanonicalUnitEnablerView()
A complete view of the
CanonicalUnitEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCanonicalUnitEnablers()
CanonicalUnitEnablers
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 useComparativeCanonicalUnitEnablerView()
mandatory
- This method is must be implemented. void usePlenaryCanonicalUnitEnablerView()
CanonicalUnitEnabler
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 useFederatedCatalogueView()
mandatory
- This method is must be implemented. void useIsolatedCatalogueView()
mandatory
- This method is must be implemented. void useActiveCanonicalUnitEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusCanonicalUnitEnablerView()
mandatory
- This method is must be implemented. CanonicalUnitEnabler getCanonicalUnitEnabler(Id canonicalUnitEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CanonicalUnitEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a CanonicalUnitEnabler
and retained for
compatibility.
In active mode, canonical unit enablers are returned that are
currently active. In any status mode, active and inactive canonical
unit enablers are returned.canonicalUnitEnablerId
- Id
of the
CanonicalUnitEnabler
NotFoundException
- canonicalUnitEnablerId
not foundNullArgumentException
- canonicalUnitEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CanonicalUnitEnablerList getCanonicalUnitEnablersByIds(IdList canonicalUnitEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
canonical unit 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 CanonicalUnitEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, canonical unit enablers are returned that are
currently active. In any status mode, active and inactive canonical
unit enablers are returned.canonicalUnitEnablerIds
- the list of Ids
to
retrieve CanonicalUnitEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- canonicalUnitEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitEnablerList getCanonicalUnitEnablersByGenusType(Type canonicalUnitEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CanonicalUnitEnablerList
corresponding to the
given canonical unit enabler genus Type
which does not
include canonical unit enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
canonical unit enablers or an error results. Otherwise, the returned
list may contain only those canonical unit enablers that are
accessible through this session.
In active mode, canonical unit enablers are returned that are
currently active. In any status mode, active and inactive canonical
unit enablers are returned.canonicalUnitEnablerGenusType
- a canonical unit enabler genus
type CanonicalUnitEnabler
listNullArgumentException
-
canonicalUnitEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitEnablerList getCanonicalUnitEnablersByParentGenusType(Type canonicalUnitEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CanonicalUnitEnablerList
corresponding to the
given canonical unit enabler genus Type
and include any
additional canonical unit enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
canonical unit enablers or an error results. Otherwise, the returned
list may contain only those canonical unit enablers that are
accessible through this session.
In active mode, canonical unit enablers are returned that are
currently active. In any status mode, active and inactive canonical
unit enablers are returned.canonicalUnitEnablerGenusType
- a canonical unit enabler genus
type CanonicalUnitEnabler
listNullArgumentException
-
canonicalUnitEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitEnablerList getCanonicalUnitEnablersByRecordType(Type canonicalUnitEnablerRecordType) throws OperationFailedException, PermissionDeniedException
CanonicalUnitEnablerList
containing the given
canonical unit enabler record Type.
In plenary mode, the returned list contains all known
canonical unit enablers or an error results. Otherwise, the returned
list may contain only those canonical unit enablers that are
accessible through this session.
In active mode, canonical unit enablers are returned that are
currently active. In any status mode, active and inactive canonical
unit enablers are returned.canonicalUnitEnablerRecordType
- a canonical unit enabler record
type CanonicalUnitEnabler
listNullArgumentException
-
canonicalUnitEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitEnablerList getCanonicalUnitEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CanonicalUnitEnablerList
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
canonical unit enablers or an error results. Otherwise, the returned
list may contain only those canonical unit enablers that are
accessible through this session.
In active mode, canonical unit enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive canonical unit enablers
are returned.from
- a start dateto
- an end date CanonicalUnitEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitEnablerList getCanonicalUnitEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CanonicalUnitEnablerList
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
canonical unit enablers or an error results. Otherwise, the returned
list may contain only those canonical unit enablers that are
accessible through this session.
In active mode, canonical unit enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive canonical unit enablers
are returned.agentId
- an agent Idfrom
- a start dateto
- an end date CanonicalUnitEnabler
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. CanonicalUnitEnablerList getCanonicalUnitEnablers() throws OperationFailedException, PermissionDeniedException
CanonicalUnitEnablers.
In plenary mode, the returned list contains all known canonical unit
enablers or an error results. Otherwise, the returned list may contain
only those canonical unit enablers that are accessible through this
session.
In active mode, canonical unit enablers are returned that are
currently active. In any status mode, active and inactive canonical
unit enablers are returned. CanonicalUnitEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.