org.osid.subscription.rules

Interface SubscriptionEnablerSmartPublisherSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPublisherId

Id getPublisherId()

Gets the Publisher Id associated with this session.

Returns:

the Publisher Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPublisher

Publisher getPublisher()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Publisher associated with this session.

Returns:

the publisher

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartPublishers

boolean canManageSmartPublishers()

Tests if this user can manage smart publishers. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart publisher management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablerQuery

SubscriptionEnablerQuery getSubscriptionEnablerQuery()

Gets a subscription enabler query.

Returns:

the subscription enabler query

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablerSearchOrder

SubscriptionEnablerSearchOrder getSubscriptionEnablerSearchOrder()

Gets a subscription enabler search order.

Returns:

the subscription enabler search order

Compliance:

mandatory - This method must be implemented.

applySubscriptionEnablerQuery

void applySubscriptionEnablerQuery(SubscriptionEnablerQuery subscriptionEnablerQuery)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies a subscription enabler query to this publisher.

Parameters:

subscriptionEnablerQuery - the subscription enabler query

Throws:

NullArgumentException - subscriptionEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - subscriptionEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSubscriptionEnablerQuery

SubscriptionEnablerQueryInspector inspectSubscriptionEnablerQuery()
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

Gets a subscription enabler query inspector for this publisher.

Returns:

the subscription enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySubscriptionEnablerSequencing

void applySubscriptionEnablerSequencing(SubscriptionEnablerSearchOrder subscriptionEnablerSearchOrder)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Applies a subscription enabler search order to this publisher.

Parameters:

subscriptionEnablerSearchOrder - the subscription enabler search order

Throws:

NullArgumentException - subscriptionEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - subscriptionEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablerQueryFromInspector

SubscriptionEnablerQuery getSubscriptionEnablerQueryFromInspector(SubscriptionEnablerQueryInspector subscriptionEnablerQueryInspector)

Gets a subscription enabler query from an inspector.

Parameters:

subscriptionEnablerQueryInspector - a subscription enabler query inspector

Returns:

the subscription enabler query

Throws:

NullArgumentException - subscriptionEnablerQueryInspector is null

UnsupportedException - subscriptionEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.