public interface SubscriptionEnablerQuerySession extends OsidSession
This session provides methods for searching among
SubscriptionEnabler
objects. The search query is constructed using
the SubscriptionEnablerQuery.
This session defines views that offer differing behaviors for searching.
Subscription enablers may have a query record indicated by their
respective record types. The query record is accessed via the
SubscriptionEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSubscriptionEnablers()
Tests if this user can perform
SubscriptionEnabler
lookups. |
Publisher |
getPublisher()
Gets the
Publisher associated with this session. |
Id |
getPublisherId()
Gets the
Publisher Id associated with
this session. |
SubscriptionEnablerQuery |
getSubscriptionEnablerQuery()
Gets a subscription enabler query.
|
SubscriptionEnablerList |
getSubscriptionEnablersByQuery(SubscriptionEnablerQuery subscriptionEnablerQuery)
Gets a list of
SubscriptionEnablers matching the given
subscription enabler query. |
void |
useFederatedPublisherView()
Federates the view for methods in this session.
|
void |
useIsolatedPublisherView()
Isolates the view for methods in this session.
|
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 canSearchSubscriptionEnablers()
SubscriptionEnabler
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 not offer lookup
operations to unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedPublisherView()
mandatory
- This method is must be implemented. void useIsolatedPublisherView()
mandatory
- This method is must be implemented. SubscriptionEnablerQuery getSubscriptionEnablerQuery()
mandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersByQuery(SubscriptionEnablerQuery subscriptionEnablerQuery) throws OperationFailedException, PermissionDeniedException
SubscriptionEnablers
matching the given
subscription enabler query.subscriptionEnablerQuery
- the subscription enabler query SubscriptionEnablerList
NullArgumentException
- subscriptionEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- subscriptionEnablerQuery
is not of this servicemandatory
- This method must be implemented.