org.osid.resourcing.rules

Interface AvailabilityEnablerFoundrySession

All Superinterfaces:

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

public interface AvailabilityEnablerFoundrySession
extends OsidSession

This session provides methods to retrieve AvailabilityEnabler to Foundry mappings. an AvailabilityEnabler 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

Methods

Modifier and Type	Method and Description
boolean	canLookupAvailabilityEnablerFoundryMappings() Tests if this user can perform lookups of availability enabler/foundry mappings.
IdList	getAvailabilityEnablerIdsByFoundries(IdList foundryIds) Gets the list of AvailabilityEnabler Ids corresponding to a list of Foundries.
IdList	getAvailabilityEnablerIdsByFoundry(Id foundryId) Gets the list of AvailabilityEnablerIds associated with a Foundry.
AvailabilityEnablerList	getAvailabilityEnablersByFoundries(IdList foundryIds) Gets the list of availability enabler corresponding to a list of Foundries.
AvailabilityEnablerList	getAvailabilityEnablersByFoundry(Id foundryId) Gets the list of availability enabler associated with a Foundry.
IdList	getFoundryIdsByAvailabilityEnabler(Id availabilityEnablerId) Gets the Foundry Ids mapped to an AvailabilityEnabler.
FoundryList	getFoundrysByAvailabilityEnabler(Id availabilityEnablerId) Gets the Foundries mapped to an AvailabilityEnabler.
void	useComparativeAvailabilityEnablerFoundryView() 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	usePlenaryAvailabilityEnablerFoundryView() A complete view of the AvailabilityEnabler and Foundry 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

canLookupAvailabilityEnablerFoundryMappings

boolean canLookupAvailabilityEnablerFoundryMappings()

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

useComparativeAvailabilityEnablerFoundryView

void useComparativeAvailabilityEnablerFoundryView()

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.

usePlenaryAvailabilityEnablerFoundryView

void usePlenaryAvailabilityEnablerFoundryView()

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

getAvailabilityEnablerIdsByFoundry

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

Gets the list of AvailabilityEnablerIds associated with a Foundry.

Parameters:

foundryId - Id of the Foundry

Returns:

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

getAvailabilityEnablersByFoundry

AvailabilityEnablerList getAvailabilityEnablersByFoundry(Id foundryId)
                                                         throws NotFoundException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Gets the list of availability enabler associated with a Foundry.

Parameters:

foundryId - Id of the Foundry

Returns:

list of related availability enablers

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.

getAvailabilityEnablerIdsByFoundries

IdList getAvailabilityEnablerIdsByFoundries(IdList foundryIds)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

foundryIds - list of foundry Ids

Returns:

list of availability enabler Ids

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablersByFoundries

AvailabilityEnablerList getAvailabilityEnablersByFoundries(IdList foundryIds)
                                                           throws OperationFailedException,
                                                                  PermissionDeniedException

Gets the list of availability enabler corresponding to a list of Foundries.

Parameters:

foundryIds - list of foundry Ids

Returns:

list of availability enablers

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundryIdsByAvailabilityEnabler

IdList getFoundryIdsByAvailabilityEnabler(Id availabilityEnablerId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the Foundry Ids mapped to an AvailabilityEnabler.

Parameters:

availabilityEnablerId - Id of an AvailabilityEnabler

Returns:

list of foundries

Throws:

NotFoundException - availabilityEnablerId is not found

NullArgumentException - availabilityEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundrysByAvailabilityEnabler

FoundryList getFoundrysByAvailabilityEnabler(Id availabilityEnablerId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets the Foundries mapped to an AvailabilityEnabler.

Parameters:

availabilityEnablerId - Id of an AvailabilityEnabler

Returns:

list of foundries

Throws:

NotFoundException - availabilityEnablerId is not found

NullArgumentException - availabilityEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.