Interface WorkFoundrySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface WorkFoundrySession
extends OsidSession

This session provides methods to retrieve Work to Foundry resourcings. A Work may appear in multiple Foundry objects. Each foundry 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	canLookupWorkFoundryAvailabilities()	Tests if this user can perform lookups of work/foundry resourcings.
FoundryList	getFoundriesByWork(Id workId)	Gets the Foundries mapped to a Work .
IdList	getFoundryIdsByWork(Id workId)	Gets the Foundry Ids mapped to a Work .
IdList	getWorkIdsByFoundries(IdList foundryIds)	Gets the list of Work Ids corresponding to a list of Foundries .
IdList	getWorkIdsByFoundry(Id foundryId)	Gets the list of Work Ids associated with a Foundry .
WorkList	getWorksByFoundries(IdList foundryIds)	Gets the list of Work corresponding to a list of Foundries .
WorkList	getWorksByFoundry(Id foundryId)	Gets the list of Works associated with a Foundry .
void	useComparativeWorkFoundryView()	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	usePlenaryWorkFoundryView()	A complete view of the Work and Foundry 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

canLookupWorkFoundryAvailabilities

boolean canLookupWorkFoundryAvailabilities()

Tests if this user can perform lookups of work/foundry resourcings. 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 intended as 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.

useComparativeWorkFoundryView

void useComparativeWorkFoundryView()

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.

usePlenaryWorkFoundryView

void usePlenaryWorkFoundryView()

A complete view of the Work and Foundry 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.

getWorkIdsByFoundry

IdList getWorkIdsByFoundry(Id foundryId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Work Ids associated with a Foundry .

Parameters:

foundryId - Id of the Foundry

Returns:

list of related work Ids

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorksByFoundry

WorkList getWorksByFoundry(Id foundryId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Works associated with a Foundry .

Parameters:

foundryId - Id of the Foundry

Returns:

list of related works

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkIdsByFoundries

IdList getWorkIdsByFoundries(IdList foundryIds)
                      throws OperationFailedException,
PermissionDeniedException

Gets the list of Work Ids corresponding to a list of Foundries .

Parameters:

foundryIds - list of foundry Ids

Returns:

list of work Ids

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorksByFoundries

WorkList getWorksByFoundries(IdList foundryIds)
                      throws OperationFailedException,
PermissionDeniedException

Gets the list of Work corresponding to a list of Foundries .

Parameters:

foundryIds - list of foundry Ids

Returns:

list of works

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundryIdsByWork

IdList getFoundryIdsByWork(Id workId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Foundry Ids mapped to a Work .

Parameters:

workId - Id of a Work

Returns:

list of foundries

Throws:

NotFoundException - workId is not found

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundriesByWork

FoundryList getFoundriesByWork(Id workId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Foundries mapped to a Work .

Parameters:

workId - Id of a Work

Returns:

list of foundries

Throws:

NotFoundException - workId is not found

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.