public interface CanonicalUnitProcessorEnablerLookupSession extends OsidSession
This session provides methods for retrieving
CanonicalUnitProcessorEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
CanonicalUnitProcessorEnablers
with the
CanonicalUnitProcessorEnablerAdminSession.
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 |
canLookupCanonicalUnitProcessorEnablers()
Tests if this user can perform
CanonicalUnitProcessorEnablers
lookups. |
CanonicalUnitProcessorEnabler |
getCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId)
Gets the
CanonicalUnitProcessorEnabler specified by its
Id. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablers()
Gets all
CanonicalUnitProcessorEnablers. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablersByGenusType(Type canonicalUnitProcessorEnablerGenusType)
Gets a
CanonicalUnitProcessorEnablerList corresponding
to the given canonical unit processor enabler genus Type
which does not include canonical unit processor enablers of
genus types derived from the specified Type. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablersByIds(IdList canonicalUnitProcessorEnablerIds)
Gets a
CanonicalUnitProcessorEnablerList corresponding
to the given IdList. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablersByParentGenusType(Type canonicalUnitProcessorEnablerGenusType)
Gets a
CanonicalUnitProcessorEnablerList corresponding
to the given canonical unit processor enabler genus Type
and include any additional canonical unit processor enablers
with genus types derived from the specified Type. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablersByRecordType(Type canonicalUnitProcessorEnablerRecordType)
Gets a
CanonicalUnitProcessorEnablerList containing the
given canonical unit processor enabler record Type. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablersOnDate(DateTime from,
DateTime to)
Gets a
CanonicalUnitProcessorEnablerList effective
within the given date range. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
CanonicalUnitProcessorEnablerList effective
during 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 |
useActiveCanonicalUnitProcessorEnablerView()
Only active canonical unit processor enablers are returned by methods
in this session.
|
void |
useAnyStatusCanonicalUnitProcessorEnablerView()
All active and inactive canonical unit processor enablers are returned
by methods in this session.
|
void |
useComparativeCanonicalUnitProcessorEnablerView()
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 |
usePlenaryCanonicalUnitProcessorEnablerView()
A complete view of the
CanonicalUnitProcessorEnabler
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 canLookupCanonicalUnitProcessorEnablers()
CanonicalUnitProcessorEnablers
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 useComparativeCanonicalUnitProcessorEnablerView()
mandatory
- This method is must be implemented. void usePlenaryCanonicalUnitProcessorEnablerView()
CanonicalUnitProcessorEnabler
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 useActiveCanonicalUnitProcessorEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusCanonicalUnitProcessorEnablerView()
mandatory
- This method is must be implemented. CanonicalUnitProcessorEnabler getCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CanonicalUnitProcessorEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a CanonicalUnitProcessorEnabler
and retained for compatibility.
In active mode, canonical unit processor enablers are returned that
are currently active. In any status mode, active and inactive
canonical unit processor enablers are returned.canonicalUnitProcessorEnablerId
- Id
of the
CanonicalUnitProcessorEnabler
NotFoundException
-
canonicalUnitProcessorEnablerId
not foundNullArgumentException
-
canonicalUnitProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByIds(IdList canonicalUnitProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerList
corresponding
to the given IdList.
In plenary mode, the returned list contains all of the
canonical unit processor 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
CanonicalUnitProcessorEnablers
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, canonical unit processor enablers are returned that
are currently active. In any status mode, active and inactive
canonical unit processor enablers are returned.canonicalUnitProcessorEnablerIds
- the list of Ids
to retrieve CanonicalUnitProcessorEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
-
canonicalUnitProcessorEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByGenusType(Type canonicalUnitProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerList
corresponding
to the given canonical unit processor enabler genus Type
which does not include canonical unit processor enablers of
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
canonical unit processor enablers or an error results. Otherwise, the
returned list may contain only those canonical unit processor enablers
that are accessible through this session.
In active mode, canonical unit processor enablers are returned that
are currently active. In any status mode, active and inactive
canonical unit processor enablers are returned.canonicalUnitProcessorEnablerGenusType
- a canonical unit
processor enabler genus type CanonicalUnitProcessorEnabler
listNullArgumentException
-
canonicalUnitProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByParentGenusType(Type canonicalUnitProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerList
corresponding
to the given canonical unit processor enabler genus Type
and include any additional canonical unit processor enablers
with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
canonical unit processor enablers or an error results. Otherwise, the
returned list may contain only those canonical unit processor enablers
that are accessible through this session.
In active mode, canonical unit processor enablers are returned that
are currently active. In any status mode, active and inactive
canonical unit processor enablers are returned.canonicalUnitProcessorEnablerGenusType
- a canonical unit
processor enabler genus type CanonicalUnitProcessorEnabler
listNullArgumentException
-
canonicalUnitProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByRecordType(Type canonicalUnitProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerList
containing the
given canonical unit processor enabler record Type.
In plenary mode, the returned list contains all known
canonical unit processor enablers or an error results. Otherwise, the
returned list may contain only those canonical unit processor enablers
that are accessible through this session.
In active mode, canonical unit processor enablers are returned that
are currently active. In any status mode, active and inactive
canonical unit processor enablers are returned.canonicalUnitProcessorEnablerRecordType
- a canonical unit
processor enabler record type CanonicalUnitProcessorEnabler
listNullArgumentException
-
canonicalUnitProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerList
effective
within the given date range.
In plenary mode, the returned list contains all known
canonical unit processor enablers or an error results. Otherwise, the
returned list may contain only those canonical unit processor enablers
that are accessible through this session.
In active mode, canonical unit processor enablers are returned that
are currently active. In any status mode, active and inactive
canonical unit processor enablers are returned.from
- a start dateto
- an end date CanonicalUnitProcessorEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerList
effective
during 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 processor enablers or an error results. Otherwise, the
returned list may contain only those canonical unit processor enablers
that are accessible through this session.
In active mode, canonical unit processor enablers are returned that
are currently active. In any status mode, active and inactive
canonical unit processor enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date CanonicalUnitProcessorEnabler
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. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablers() throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablers.
In plenary mode, the returned list contains all known canonical unit
processor enablers or an error results. Otherwise, the returned list
may contain only those canonical unit processor enablers that are
accessible through this session.
In active mode, canonical unit processor enablers are returned that
are currently active. In any status mode, active and inactive
canonical unit processor enablers are returned. CanonicalUnitProcessorEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.