org.osid.subscription

Interface SubscriptionSmartPublisherSession

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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 associated with this session

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.

getSubscriptionQuery

SubscriptionQuery getSubscriptionQuery()

Gets a subscription query.

Returns:

the subscription query

Compliance:

mandatory - This method must be implemented.

getSubscriptionSearchOrder

SubscriptionSearchOrder getSubscriptionSearchOrder()

Gets a subscription search order.

Returns:

the subscription search order

Compliance:

mandatory - This method must be implemented.

applySubscriptionQuery

void applySubscriptionQuery(SubscriptionQuery subscriptionQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a subscription query to this publisher.

Parameters:

subscriptionQuery - the subscription query

Throws:

NullArgumentException - subscriptionQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - subscriptionQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSubscriptionQuery

SubscriptionQueryInspector inspectSubscriptionQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a subscription query inspector for this publisher.

Returns:

the subscriptions query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySubscriptionSequencing

void applySubscriptionSequencing(SubscriptionSearchOrder subscriptionSearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a subscription search order to this publisher.

Parameters:

subscriptionSearchOrder - the subscription search order

Throws:

NullArgumentException - subscriptionSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - subscriptionSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSubscriptionQueryFromInspector

SubscriptionQuery getSubscriptionQueryFromInspector(SubscriptionQueryInspector subscriptionQueryInspector)

Gets a subscription query from an inspector.

Parameters:

subscriptionQueryInspector - a query inspector

Returns:

the subscription query

Throws:

NullArgumentException - subscriptionQueryInspector is null

UnsupportedException - subscriptionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.