org.osid.subscription.rules

Interface SubscriptionEnablerLookupSession

All Superinterfaces:

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

public interface SubscriptionEnablerLookupSession
extends OsidSession

This session provides methods for retrieving SubscriptionEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated publisher view: All subscription enabler methods in this session operate, retrieve and pertain to subscription enablers defined explicitly in the current publisher. Using an isolated view is useful for managing SubscriptionEnablers with the SubscriptionEnablerAdminSession.
• federated publisher view: All subscription enabler methods in this session operate, retrieve and pertain to all subscription enablers defined in this publisher and any other subscription enablers implicitly available in this publisher through publisher inheritence.
• active subscription enabler view: All subscription enabler lookup methods return active subscription enablers.
• any status subscription enabler view: Subscription enablers of any active or inactive status are returned from methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupSubscriptionEnablers() Tests if this user can perform SubscriptionEnablers lookups.
Publisher	getPublisher() Gets the Publisher associated with this session.
Id	getPublisherId() Gets the Publisher Id associated with this session.
SubscriptionEnabler	getSubscriptionEnabler(Id subscriptionEnablerId) Gets the SubscriptionEnabler specified by its Id.
SubscriptionEnablerList	getSubscriptionEnablers() Gets all SubscriptionEnablers.
SubscriptionEnablerList	getSubscriptionEnablersByGenusType(Type subscriptionEnablerGenusType) Gets a SubscriptionEnablerList corresponding to the given subscription enabler genus Type which does not include subscription enablers of genus types derived from the specified Type.
SubscriptionEnablerList	getSubscriptionEnablersByIds(IdList subscriptionEnablerIds) Gets a SubscriptionEnablerList corresponding to the given IdList.
SubscriptionEnablerList	getSubscriptionEnablersByParentGenusType(Type subscriptionEnablerGenusType) Gets a SubscriptionEnablerList corresponding to the given subscription enabler genus Type and include any additional subscription enablers with genus types derived from the specified Type.
SubscriptionEnablerList	getSubscriptionEnablersByRecordType(Type subscriptionEnablerRecordType) Gets a SubscriptionEnablerList containing the given subscription enabler record Type.
SubscriptionEnablerList	getSubscriptionEnablersOnDate(DateTime from, DateTime to) Gets a SubscriptionEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
SubscriptionEnablerList	getSubscriptionEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) Gets a SubscriptionEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveSubscriptionEnablerView() Only active subscription enablers are returned by methods in this session.
void	useAnyStatusSubscriptionEnablerView() All active and inactive subscription enablers are returned by methods in this session.
void	useComparativeSubscriptionEnablerView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedPublisherView() Federates the view for methods in this session.
void	useIsolatedPublisherView() Isolates the view for methods in this session.
void	usePlenarySubscriptionEnablerView() A complete view of the SubscriptionEnabler returns is desired.

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.

canLookupSubscriptionEnablers

boolean canLookupSubscriptionEnablers()

Tests if this user can perform SubscriptionEnablers 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 opt not to offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSubscriptionEnablerView

void useComparativeSubscriptionEnablerView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenarySubscriptionEnablerView

void usePlenarySubscriptionEnablerView()

A complete view of the SubscriptionEnabler returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedPublisherView

void useFederatedPublisherView()

Federates the view for methods in this session. A federated view will include subscription enablers in publishers which are children of this publisher in the publisher hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedPublisherView

void useIsolatedPublisherView()

Isolates the view for methods in this session. An isolated view restricts lookups to this publisher only.

Compliance:

mandatory - This method is must be implemented.

useActiveSubscriptionEnablerView

void useActiveSubscriptionEnablerView()

Only active subscription enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusSubscriptionEnablerView

void useAnyStatusSubscriptionEnablerView()

All active and inactive subscription enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getSubscriptionEnabler

SubscriptionEnabler getSubscriptionEnabler(Id subscriptionEnablerId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the SubscriptionEnabler specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned SubscriptionEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a SubscriptionEnabler and retained for compatibility. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parameters:

subscriptionEnablerId - Id of the SubscriptionEnabler

Returns:

the subscription enabler

Throws:

NotFoundException - subscriptionEnablerId not found

NullArgumentException - subscriptionEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getSubscriptionEnablersByIds

SubscriptionEnablerList getSubscriptionEnablersByIds(IdList subscriptionEnablerIds)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets a SubscriptionEnablerList corresponding to the given IdList. In plenary mode, the returned list contains all of the subscription enablers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible SubscriptionEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parameters:

subscriptionEnablerIds - the list of Ids to retrieve

Returns:

the returned SubscriptionEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - subscriptionEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablersByGenusType

SubscriptionEnablerList getSubscriptionEnablersByGenusType(Type subscriptionEnablerGenusType)
                                                           throws OperationFailedException,
                                                                  PermissionDeniedException

Gets a SubscriptionEnablerList corresponding to the given subscription enabler genus Type which does not include subscription enablers of genus types derived from the specified Type. In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parameters:

subscriptionEnablerGenusType - a subscription enabler genus type

Returns:

the returned SubscriptionEnabler list

Throws:

NullArgumentException - subscriptionEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablersByParentGenusType

SubscriptionEnablerList getSubscriptionEnablersByParentGenusType(Type subscriptionEnablerGenusType)
                                                                 throws OperationFailedException,
                                                                        PermissionDeniedException

Gets a SubscriptionEnablerList corresponding to the given subscription enabler genus Type and include any additional subscription enablers with genus types derived from the specified Type. In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parameters:

subscriptionEnablerGenusType - a subscription enabler genus type

Returns:

the returned SubscriptionEnabler list

Throws:

NullArgumentException - subscriptionEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablersByRecordType

SubscriptionEnablerList getSubscriptionEnablersByRecordType(Type subscriptionEnablerRecordType)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets a SubscriptionEnablerList containing the given subscription enabler record Type. In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parameters:

subscriptionEnablerRecordType - a subscription enabler record type

Returns:

the returned SubscriptionEnabler list

Throws:

NullArgumentException - subscriptionEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablersOnDate

SubscriptionEnablerList getSubscriptionEnablersOnDate(DateTime from,
                                                    DateTime to)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a SubscriptionEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned SubscriptionEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablersOnDateWithAgent

SubscriptionEnablerList getSubscriptionEnablersOnDateWithAgent(Id agentId,
                                                             DateTime from,
                                                             DateTime to)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets a SubscriptionEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned SubscriptionEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablers

SubscriptionEnablerList getSubscriptionEnablers()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets all SubscriptionEnablers. In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Returns:

the returned SubscriptionEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.