public interface SubscriptionEnablerLookupSession extends OsidSession
This session provides methods for retrieving
SubscriptionEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
SubscriptionEnablers
with the
SubscriptionEnablerAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSubscriptionEnablers()
Tests if this user can perform
SubscriptionEnablers
lookups. |
Publisher |
getPublisher()
Gets the
Publisher associated with this session. |
Id |
getPublisherId()
Gets the
Publisher Id associated with
this session. |
SubscriptionEnabler |
getSubscriptionEnabler(Id subscriptionEnablerId)
Gets the
SubscriptionEnabler specified by its
Id. |
SubscriptionEnablerList |
getSubscriptionEnablers()
Gets all
SubscriptionEnablers. |
SubscriptionEnablerList |
getSubscriptionEnablersByGenusType(Type subscriptionEnablerGenusType)
Gets a
SubscriptionEnablerList corresponding to the
given subscription enabler genus Type which does not
include subscription enablers of genus types derived from the
specified Type. |
SubscriptionEnablerList |
getSubscriptionEnablersByIds(IdList subscriptionEnablerIds)
Gets a
SubscriptionEnablerList corresponding to the
given IdList. |
SubscriptionEnablerList |
getSubscriptionEnablersByParentGenusType(Type subscriptionEnablerGenusType)
Gets a
SubscriptionEnablerList corresponding to the
given subscription enabler genus Type and include any
additional subscription enablers with genus types derived from the
specified Type. |
SubscriptionEnablerList |
getSubscriptionEnablersByRecordType(Type subscriptionEnablerRecordType)
Gets a
SubscriptionEnablerList containing the given
subscription enabler record Type. |
SubscriptionEnablerList |
getSubscriptionEnablersOnDate(DateTime from,
DateTime to)
Gets a
SubscriptionEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
SubscriptionEnablerList |
getSubscriptionEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
SubscriptionEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent. |
void |
useActiveSubscriptionEnablerView()
Only active subscription enablers are returned by methods in this
session.
|
void |
useAnyStatusSubscriptionEnablerView()
All active and inactive subscription enablers are returned by methods
in this session.
|
void |
useComparativeSubscriptionEnablerView()
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 |
useFederatedPublisherView()
Federates the view for methods in this session.
|
void |
useIsolatedPublisherView()
Isolates the view for methods in this session.
|
void |
usePlenarySubscriptionEnablerView()
A complete view of the
SubscriptionEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPublisherId()
Publisher
Id
associated with
this session. Publisher Id
associated with this sessionmandatory
- This method must be implemented. Publisher getPublisher() throws OperationFailedException, PermissionDeniedException
Publisher
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupSubscriptionEnablers()
SubscriptionEnablers
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 useComparativeSubscriptionEnablerView()
mandatory
- This method is must be implemented. void usePlenarySubscriptionEnablerView()
SubscriptionEnabler
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 useFederatedPublisherView()
mandatory
- This method is must be implemented. void useIsolatedPublisherView()
mandatory
- This method is must be implemented. void useActiveSubscriptionEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusSubscriptionEnablerView()
mandatory
- This method is must be implemented. SubscriptionEnabler getSubscriptionEnabler(Id subscriptionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
SubscriptionEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a SubscriptionEnabler
and retained for
compatibility.
In active mode, subscription are returned that are currently active.
In any status mode, active and inactive subscription are returned.subscriptionEnablerId
- Id
of the
SubscriptionEnabler
NotFoundException
- subscriptionEnablerId
not foundNullArgumentException
- subscriptionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. SubscriptionEnablerList getSubscriptionEnablersByIds(IdList subscriptionEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
subscription 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 SubscriptionEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, subscription are returned that are currently active.
In any status mode, active and inactive subscription are returned.subscriptionEnablerIds
- the list of Ids
to
retrieve SubscriptionEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- subscriptionEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersByGenusType(Type subscriptionEnablerGenusType) throws OperationFailedException, PermissionDeniedException
SubscriptionEnablerList
corresponding to the
given subscription enabler genus Type
which does not
include subscription enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
subscription enablers or an error results. Otherwise, the returned
list may contain only those subscription enablers that are accessible
through this session.
In active mode, subscription are returned that are currently active.
In any status mode, active and inactive subscription are returned.subscriptionEnablerGenusType
- a subscription enabler genus type SubscriptionEnabler
listNullArgumentException
-
subscriptionEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersByParentGenusType(Type subscriptionEnablerGenusType) throws OperationFailedException, PermissionDeniedException
SubscriptionEnablerList
corresponding to the
given subscription enabler genus Type
and include any
additional subscription enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
subscription enablers or an error results. Otherwise, the returned
list may contain only those subscription enablers that are accessible
through this session.
In active mode, subscription are returned that are currently active.
In any status mode, active and inactive subscription are returned.subscriptionEnablerGenusType
- a subscription enabler genus type SubscriptionEnabler
listNullArgumentException
-
subscriptionEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersByRecordType(Type subscriptionEnablerRecordType) throws OperationFailedException, PermissionDeniedException
SubscriptionEnablerList
containing the given
subscription enabler record Type.
In plenary mode, the returned list contains all known
subscription enablers or an error results. Otherwise, the returned
list may contain only those subscription enablers that are accessible
through this session.
In active mode, subscription are returned that are currently active.
In any status mode, active and inactive subscription are returned.subscriptionEnablerRecordType
- a subscription enabler record
type SubscriptionEnabler
listNullArgumentException
-
subscriptionEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
SubscriptionEnablerList
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
subscription enablers or an error results. Otherwise, the returned
list may contain only those subscription enablers that are accessible
through this session.
In active mode, subscription are returned that are currently active.
In any status mode, active and inactive subscription are returned.from
- a start dateto
- an end date SubscriptionEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
SubscriptionEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent.
In plenary mode, the returned list contains all known
subscription enablers or an error results. Otherwise, the returned
list may contain only those subscription enablers that are accessible
through this session.
In active mode, subscription are returned that are currently active.
In any status mode, active and inactive subscription are returned.agentId
- an agent Idfrom
- a start dateto
- an end date SubscriptionEnabler
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. SubscriptionEnablerList getSubscriptionEnablers() throws OperationFailedException, PermissionDeniedException
SubscriptionEnablers.
In plenary mode, the returned list contains all known subscription
enablers or an error results. Otherwise, the returned list may contain
only those subscription enablers that are accessible through this
session.
In active mode, subscription are returned that are currently active.
In any status mode, active and inactive subscription are returned. SubscriptionEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.