Interface SubscriptionPublisherSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SubscriptionPublisherSession
extends OsidSession

This session provides methods to retrieve Subscription to Publisher mappings. A Subscription may appear in multiple Publishers . Each Publisher may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupSubscriptionPublisherMappings()	Tests if this user can perform lookups of subscription/publisher mappings.
IdList	getPublisherIdsBySubscription(Id subscriptionId)	Gets the list of Publisher Ids mapped to a Subscription .
PublisherList	getPublishersBySubscription(Id subscriptionId)	Gets the list of Publisher objects mapped to a Subscription .
IdList	getSubscriptionIdsByPublisher(Id publisherId)	Gets the list of Subscription Ids associated with a Publisher .
IdList	getSubscriptionIdsByPublishers(IdList publisherIds)	Gets the list of Subscription Ids corresponding to a list of Publisher objects.
SubscriptionList	getSubscriptionsByPublisher(Id publisherId)	Gets the list of Subscriptions associated with a Publisher .
SubscriptionList	getSubscriptionsByPublishers(IdList publisherIds)	Gets the list of Subscriptions corresponding to a list of Publishers .
void	useComparativePublisherView()	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	usePlenaryPublisherView()	A complete view of the Subscription and Publisher returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupSubscriptionPublisherMappings

boolean canLookupSubscriptionPublisherMappings()

Tests if this user can perform lookups of subscription/publisher mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativePublisherView

void useComparativePublisherView()

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.

usePlenaryPublisherView

void usePlenaryPublisherView()

A complete view of the Subscription and Publisher 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.

getSubscriptionIdsByPublisher

IdList getSubscriptionIdsByPublisher(Id publisherId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Subscription Ids associated with a Publisher .

Parameters:

publisherId - Id of a Subscription

Returns:

list of related subscription Ids

Throws:

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionsByPublisher

SubscriptionList getSubscriptionsByPublisher(Id publisherId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Subscriptions associated with a Publisher .

Parameters:

publisherId - Id of a Subscription

Returns:

list of related subscriptions

Throws:

NotFoundException - publisherId is not found

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionIdsByPublishers

IdList getSubscriptionIdsByPublishers(IdList publisherIds)
                               throws OperationFailedException,
PermissionDeniedException

Gets the list of Subscription Ids corresponding to a list of Publisher objects.

Parameters:

publisherIds - list of publisher Ids

Returns:

list of subscription Ids

Throws:

NullArgumentException - publisherIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionsByPublishers

SubscriptionList getSubscriptionsByPublishers(IdList publisherIds)
                                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Subscriptions corresponding to a list of Publishers .

Parameters:

publisherIds - list of publisher Ids

Returns:

list of subscriptions

Throws:

NullArgumentException - publisherIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPublisherIdsBySubscription

IdList getPublisherIdsBySubscription(Id subscriptionId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Publisher Ids mapped to a Subscription .

Parameters:

subscriptionId - Id of a Subscription

Returns:

list of publisher Ids

Throws:

NotFoundException - subscriptionId is not found

NullArgumentException - subscriptionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPublishersBySubscription

PublisherList getPublishersBySubscription(Id subscriptionId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Publisher objects mapped to a Subscription .

Parameters:

subscriptionId - Id of a Subscription

Returns:

list of publishers

Throws:

NotFoundException - subscriptionId is not found

NullArgumentException - subscriptionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.