public interface SubscriptionSmartPublisherSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A SubscriptionQuery
can be retrieved from this
session and mapped to this Publisher
to create a virtual
collection of Subscriptions.
The subscriptions may be
sequenced using the SubscriptionSearchOrder
from this
session.
This Publisher
has a default query that matches any
subscription and a default search order that specifies no sequencing. The
queries may be examined using a SubscriptionQueryInspector.
The query may be modified by converting the inspector back to a
SubscriptionQuery.
Modifier and Type | Method and Description |
---|---|
void |
applySubscriptionQuery(SubscriptionQuery subscriptionQuery)
Applies a subscription query to this publisher.
|
void |
applySubscriptionSequencing(SubscriptionSearchOrder subscriptionSearchOrder)
Applies a subscription 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. |
SubscriptionQuery |
getSubscriptionQuery()
Gets a subscription query.
|
SubscriptionQuery |
getSubscriptionQueryFromInspector(SubscriptionQueryInspector subscriptionQueryInspector)
Gets a subscription query from an inspector.
|
SubscriptionSearchOrder |
getSubscriptionSearchOrder()
Gets a subscription search order.
|
SubscriptionQueryInspector |
inspectSubscriptionQuery()
Gets a subscription 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. Publisher
associated with this sessionOperationFailedException
- 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. SubscriptionQuery getSubscriptionQuery()
mandatory
- This method must be implemented. SubscriptionSearchOrder getSubscriptionSearchOrder()
mandatory
- This method must be implemented. void applySubscriptionQuery(SubscriptionQuery subscriptionQuery) throws OperationFailedException, PermissionDeniedException
subscriptionQuery
- the subscription queryNullArgumentException
- subscriptionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- subscriptionQuery
not of this servicemandatory
- This method must be implemented. SubscriptionQueryInspector inspectSubscriptionQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySubscriptionSequencing(SubscriptionSearchOrder subscriptionSearchOrder) throws OperationFailedException, PermissionDeniedException
subscriptionSearchOrder
- the subscription search orderNullArgumentException
- subscriptionSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- subscriptionSearchOrder
not of this servicemandatory
- This method must be implemented. SubscriptionQuery getSubscriptionQueryFromInspector(SubscriptionQueryInspector subscriptionQueryInspector)
subscriptionQueryInspector
- a query inspectorNullArgumentException
-
subscriptionQueryInspector
is null
UnsupportedException
-
subscriptionQueryInspector
is not of this servicemandatory
- This method must be implemented.