Interface EffortFoundrySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EffortFoundrySession
extends OsidSession

This session provides methods to retrieve Effort to Foundry mappings. An Effort 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	canLookupEffortFoundryMappings()	Tests if this user can perform lookups of effort/foundry mappings.
IdList	getEffortIdsByFoundries(IdList foundryIds)	Gets the list of Effort Ids corresponding to a list of Foundries .
IdList	getEffortIdsByFoundry(Id foundryId)	Gets the list of Effort Ids associated with a Foundry .
EffortList	getEffortsByFoundries(IdList foundryIds)	Gets the list of Effort corresponding to a list of Foundries .
EffortList	getEffortsByFoundry(Id foundryId)	Gets the list of Efforts associated with a Foundry .
FoundryList	getFoundriesByEffort(Id effortId)	Gets the Foundries mapped to an Effort .
IdList	getFoundryIdsByEffort(Id effortId)	Gets the Foundry Ids mapped to an Effort .
void	useComparativeEffortFoundryView()	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	usePlenaryEffortFoundryView()	A complete view of the Effort 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

canLookupEffortFoundryMappings

boolean canLookupEffortFoundryMappings()

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

useComparativeEffortFoundryView

void useComparativeEffortFoundryView()

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.

usePlenaryEffortFoundryView

void usePlenaryEffortFoundryView()

A complete view of the Effort 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.

getEffortIdsByFoundry

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

Gets the list of Effort Ids associated with a Foundry .

Parameters:

foundryId - Id of the Foundry

Returns:

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

getEffortsByFoundry

EffortList getEffortsByFoundry(Id foundryId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Efforts associated with a Foundry .

Parameters:

foundryId - Id of the Foundry

Returns:

list of related efforts

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.

getEffortIdsByFoundries

IdList getEffortIdsByFoundries(IdList foundryIds)
                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

foundryIds - list of foundry Ids

Returns:

list of effort Ids

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsByFoundries

EffortList getEffortsByFoundries(IdList foundryIds)
                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

foundryIds - list of foundry Ids

Returns:

list of efforts

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundryIdsByEffort

IdList getFoundryIdsByEffort(Id effortId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Foundry Ids mapped to an Effort .

Parameters:

effortId - Id of an Effort

Returns:

list of foundries

Throws:

NotFoundException - effortId is not found

NullArgumentException - effortId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundriesByEffort

FoundryList getFoundriesByEffort(Id effortId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Foundries mapped to an Effort .

Parameters:

effortId - Id of an Effort

Returns:

list of foundries

Throws:

NotFoundException - effortId is not found

NullArgumentException - effortId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.