Interface DispatchPublisherSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DispatchPublisherSession
extends OsidSession

This session provides methods to retrieve Dispatch to Publisher mappings. A Dispatch 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	canLookupDispatchPublisherMappings()	Tests if this user can perform lookups of dispatch/publisher mappings.
DispatchList	getDispatchesByPublisher(Id publisherId)	Gets the list of Dispatches associated with a Publisher .
DispatchList	getDispatchesByPublishers(IdList publisherIds)	Gets the list of Dispatches corresponding to a list of Publishers .
IdList	getDispatchIdsByPublisher(Id publisherId)	Gets the list of Dispatch Ids associated with a Publisher .
IdList	getDispatchIdsByPublishers(IdList publisherIds)	Gets the list of Dispatch Ids corresponding to a list of Publisher objects.
IdList	getPublisherIdsByDispatch(Id dispatchId)	Gets the list of Publisher Ids mapped to a Dispatch .
PublisherList	getPublishersByDispatch(Id dispatchId)	Gets the list of Publisher objects mapped to a Dispatch .
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 Dispatch 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

canLookupDispatchPublisherMappings

boolean canLookupDispatchPublisherMappings()

Tests if this user can perform lookups of dispatch/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 Dispatch 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.

getDispatchIdsByPublisher

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

Gets the list of Dispatch Ids associated with a Publisher .

Parameters:

publisherId - Id of a Publisher

Returns:

list of related dispatch 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.

getDispatchesByPublisher

DispatchList getDispatchesByPublisher(Id publisherId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Dispatches associated with a Publisher .

Parameters:

publisherId - Id of a Publisher

Returns:

list of related dispatches

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.

getDispatchIdsByPublishers

IdList getDispatchIdsByPublishers(IdList publisherIds)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

publisherIds - list of publisher Ids

Returns:

list of dispatch Ids

Throws:

NullArgumentException - publisherIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDispatchesByPublishers

DispatchList getDispatchesByPublishers(IdList publisherIds)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

publisherIds - list of publisher Ids

Returns:

list of dispatches

Throws:

NullArgumentException - publisherIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPublisherIdsByDispatch

IdList getPublisherIdsByDispatch(Id dispatchId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Publisher Ids mapped to a Dispatch .

Parameters:

dispatchId - Id of a Dispatch

Returns:

list of publisher Ids

Throws:

NotFoundException - dispatchId is not found

NullArgumentException - dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPublishersByDispatch

PublisherList getPublishersByDispatch(Id dispatchId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Publisher objects mapped to a Dispatch .

Parameters:

dispatchId - Id of a Dispatch

Returns:

list of publishers

Throws:

NotFoundException - dispatchId is not found

NullArgumentException - dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.