public interface SubscriptionEnablerSmartPublisherSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
publishers. A SubscriptionEnablerQuery
can be retrieved
from this session and mapped to this Publisher
to create a
virtual collection of subscription enablers. The subscription enablers may
be sequenced using the SubscriptionEnablerSearchOrder
from
this session.
This Publisher
has a default query that matches any
subscription enabler and a default search order that specifies no
sequencing. The queries may be examined using a
SubscriptionEnablerQueryInspector.
The query may be modified by
converting the inspector back to a SubscriptionEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applySubscriptionEnablerQuery(SubscriptionEnablerQuery subscriptionEnablerQuery)
Applies a subscription enabler query to this publisher.
|
void |
applySubscriptionEnablerSequencing(SubscriptionEnablerSearchOrder subscriptionEnablerSearchOrder)
Applies a subscription enabler search order to this publisher.
|
boolean |
canManageSmartPublishers()
Tests if this user can manage smart publishers.
|
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.
|
SubscriptionEnablerQuery |
getSubscriptionEnablerQueryFromInspector(SubscriptionEnablerQueryInspector subscriptionEnablerQueryInspector)
Gets a subscription enabler query from an inspector.
|
SubscriptionEnablerSearchOrder |
getSubscriptionEnablerSearchOrder()
Gets a subscription enabler search order.
|
SubscriptionEnablerQueryInspector |
inspectSubscriptionEnablerQuery()
Gets a subscription enabler query inspector for this publisher.
|
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 canManageSmartPublishers()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart publisher management is not
authorized, true
otherwisemandatory
- This method must be implemented. SubscriptionEnablerQuery getSubscriptionEnablerQuery()
mandatory
- This method must be implemented. SubscriptionEnablerSearchOrder getSubscriptionEnablerSearchOrder()
mandatory
- This method must be implemented. void applySubscriptionEnablerQuery(SubscriptionEnablerQuery subscriptionEnablerQuery) throws OperationFailedException, PermissionDeniedException
subscriptionEnablerQuery
- the subscription enabler queryNullArgumentException
- subscriptionEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- subscriptionEnablerQuery
not of this servicemandatory
- This method must be implemented. SubscriptionEnablerQueryInspector inspectSubscriptionEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySubscriptionEnablerSequencing(SubscriptionEnablerSearchOrder subscriptionEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
subscriptionEnablerSearchOrder
- the subscription enabler search
orderNullArgumentException
-
subscriptionEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
subscriptionEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. SubscriptionEnablerQuery getSubscriptionEnablerQueryFromInspector(SubscriptionEnablerQueryInspector subscriptionEnablerQueryInspector)
subscriptionEnablerQueryInspector
- a subscription enabler query
inspectorNullArgumentException
-
subscriptionEnablerQueryInspector
is null
UnsupportedException
-
subscriptionEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.