public interface OfferingConstrainerEnablerLookupSession extends OsidSession
This session provides methods for retrieving
OfferingConstrainerEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
OfferingConstrainerEnablers
with the
OfferingConstrainerEnablerAdminSession.
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 |
canLookupOfferingConstrainerEnablers()
Tests if this user can perform
OfferingConstrainerEnablers
lookups. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
OfferingConstrainerEnabler |
getOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
Gets the
OfferingConstrainerEnabler specified by its
Id. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablers()
Gets all
OfferingConstrainerEnablers. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersByGenusType(Type offeringConstrainerEnablerGenusType)
Gets an
OfferingConstrainerEnablerList corresponding to
the given offering constrainer enabler genus Type which
does not include offering constrainer enablers of genus types derived
from the specified Type. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersByIds(IdList offeringConstrainerEnablerIds)
Gets an
OfferingConstrainerEnablerList corresponding to
the given IdList. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersByParentGenusType(Type offeringConstrainerEnablerGenusType)
Gets an
OfferingConstrainerEnablerList corresponding to
the given offering constrainer enabler genus Type and
include any additional offering constrainer enablers with genus types
derived from the specified Type. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersByRecordType(Type offeringConstrainerEnablerRecordType)
Gets an
OfferingConstrainerEnablerList containing the
given offering constrainer enabler record Type. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersOnDate(DateTime from,
DateTime to)
Gets an
OfferingConstrainerEnablerList that are
effective for the entire given date range but not confined to the date
range. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
OfferingConstrainerEnablerList that are
effective for the entire given date range but not confined to the date
range and evaluated against the given agent. |
void |
useActiveOfferingConstrainerEnablerView()
Only active offering constrainer enablers are returned by methods in
this session.
|
void |
useAnyStatusOfferingConstrainerEnablerView()
All active and inactive offering constrainer enablers are returned by
methods in this session.
|
void |
useComparativeOfferingConstrainerEnablerView()
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 |
usePlenaryOfferingConstrainerEnablerView()
A complete view of the
OfferingConstrainerEnabler
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 canLookupOfferingConstrainerEnablers()
OfferingConstrainerEnablers
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 useComparativeOfferingConstrainerEnablerView()
mandatory
- This method is must be implemented. void usePlenaryOfferingConstrainerEnablerView()
OfferingConstrainerEnabler
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 useActiveOfferingConstrainerEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusOfferingConstrainerEnablerView()
mandatory
- This method is must be implemented. OfferingConstrainerEnabler getOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
OfferingConstrainerEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to an OfferingConstrainerEnabler
and retained for compatibility.
In active mode, offering constrainer enablers are returned that are
currently active. In any status mode, active and inactive offering
constrainer enablers are returned.offeringConstrainerEnablerId
- Id
of the
OfferingConstrainerEnabler
NotFoundException
- offeringConstrainerEnablerId
not foundNullArgumentException
-
offeringConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. OfferingConstrainerEnablerList getOfferingConstrainerEnablersByIds(IdList offeringConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablerList
corresponding to
the given IdList.
In plenary mode, the returned list contains all of the
offering constrainer 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
OfferingConstrainerEnablers
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, offering constrainer enablers are returned that are
currently active. In any status mode, active and inactive offering
constrainer enablers are returned.offeringConstrainerEnablerIds
- the list of Ids
to retrieve OfferingConstrainerEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
-
offeringConstrainerEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfferingConstrainerEnablerList getOfferingConstrainerEnablersByGenusType(Type offeringConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablerList
corresponding to
the given offering constrainer enabler genus Type
which
does not include offering constrainer enablers of genus types derived
from the specified Type.
In plenary mode, the returned list contains all known
offering constrainer enablers or an error results. Otherwise, the
returned list may contain only those offering constrainer enablers
that are accessible through this session.
In active mode, offering constrainer enablers are returned that are
currently active. In any status mode, active and inactive offering
constrainer enablers are returned.offeringConstrainerEnablerGenusType
- an offering constrainer
enabler genus type OfferingConstrainerEnabler
listNullArgumentException
-
offeringConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfferingConstrainerEnablerList getOfferingConstrainerEnablersByParentGenusType(Type offeringConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablerList
corresponding to
the given offering constrainer enabler genus Type
and
include any additional offering constrainer enablers with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
offering constrainer enablers or an error results. Otherwise, the
returned list may contain only those offering constrainer enablers
that are accessible through this session.
In active mode, offering constrainer enablers are returned that are
currently active. In any status mode, active and inactive offering
constrainer enablers are returned.offeringConstrainerEnablerGenusType
- an offering constrainer
enabler genus type OfferingConstrainerEnabler
listNullArgumentException
-
offeringConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfferingConstrainerEnablerList getOfferingConstrainerEnablersByRecordType(Type offeringConstrainerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablerList
containing the
given offering constrainer enabler record Type.
In plenary mode, the returned list contains all known
offering constrainer enablers or an error results. Otherwise, the
returned list may contain only those offering constrainer enablers
that are accessible through this session.
In active mode, offering constrainer enablers are returned that are
currently active. In any status mode, active and inactive offering
constrainer enablers are returned.offeringConstrainerEnablerRecordType
- an offering constrainer
enabler record type OfferingConstrainerEnabler
listNullArgumentException
-
offeringConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfferingConstrainerEnablerList getOfferingConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablerList
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
offering constrainer enablers or an error results. Otherwise, the
returned list may contain only those offering constrainer enablers
that are accessible through this session.
In active mode, offering constrainer enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive offering constrainer
enablers are returned.from
- a start dateto
- an end date OfferingConstrainerEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfferingConstrainerEnablerList getOfferingConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablerList
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
offering constrainer enablers or an error results. Otherwise, the
returned list may contain only those offering constrainer enablers
that are accessible through this session.
In active mode, offering constrainer enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive offering constrainer
enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date OfferingConstrainerEnabler
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. OfferingConstrainerEnablerList getOfferingConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablers.
In plenary mode, the returned list contains all known offering
constrainer enablers or an error results. Otherwise, the returned list
may contain only those offering constrainer enablers that are
accessible through this session.
In active mode, offering constrainer enablers are returned that are
currently active. In any status mode, active and inactive offering
constrainer enablers are returned. OfferingConstrainerEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.