org.osid.resourcing.rules

Interface AvailabilityEnablerRuleLookupSession

All Superinterfaces:

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

public interface AvailabilityEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve AvailabilityEnabler to Availability mappings. An Availability with multiple AvailabilityEnablers means any positive rule evaluation across the enablers result in an accessible Availability.

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
• isolated foundry view: All methods in this session operate, retrieve and pertain to availability enablers defined explicitly in the current foundry
• federated foundry view: All methods in this session operate, retrieve and pertain to all availability enablers defined in this foundry and any other availability enabler implicitly available in this foundry through foundry inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAvailabilityEnablerRules() Tests if this user can perform lookups of availability enabler/availability mappings.
AvailabilityList	getAvailabilitiesForAvailabilityEnabler(Id availabilityEnablerId) Gets the Availabilities mapped to an AvailabilityEnabler.
IdList	getAvailabilityEnablerIdsForAvailability(Id availabilityId) Gets the AvailabilityEnabler Id associated with an Availability.
AvailabilityEnablerList	getAvailabilityEnablersForAvailability(Id availabilityId) Gets the AvailabilityEnabler associated with an Availability.
IdList	getAvailabilityIdsForAvailabilityEnabler(Id availabilityEnablerId) Gets the Availability Ids mapped to an AvailabilityEnabler.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
void	useComparativeAvailabilityEnablerRuleView() 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	useFederatedFoundryView() Federates the view for methods in this session.
void	useIsolatedFoundryView() Isolates the view for methods in this session.
void	usePlenaryAvailabilityEnablerRuleView() A complete view of the AvailabilityEnabler and Availability 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

getFoundryId

Id getFoundryId()

Gets the Foundry Id associated with this session.

Returns:

the Foundry Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFoundry

Foundry getFoundry()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Foundry associated with this session.

Returns:

the foundry

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupAvailabilityEnablerRules

boolean canLookupAvailabilityEnablerRules()

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

useComparativeAvailabilityEnablerRuleView

void useComparativeAvailabilityEnablerRuleView()

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.

usePlenaryAvailabilityEnablerRuleView

void usePlenaryAvailabilityEnablerRuleView()

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

useFederatedFoundryView

void useFederatedFoundryView()

Federates the view for methods in this session. A federated view will include availability enabler in foundries which are children of this foundry in the foundry hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFoundryView

void useIsolatedFoundryView()

Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.

Compliance:

mandatory - This method is must be implemented.

getAvailabilityEnablerIdsForAvailability

IdList getAvailabilityEnablerIdsForAvailability(Id availabilityId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the AvailabilityEnabler Id associated with an Availability.

Parameters:

availabilityId - Id of the Availability

Returns:

the availability enabler Ids

Throws:

NotFoundException - availabilityId is not found

NullArgumentException - availabilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablersForAvailability

AvailabilityEnablerList getAvailabilityEnablersForAvailability(Id availabilityId)
                                                               throws NotFoundException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Gets the AvailabilityEnabler associated with an Availability.

Parameters:

availabilityId - Id of the Availability

Returns:

the availability enablers

Throws:

NotFoundException - availabilityId is not found

NullArgumentException - availabilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAvailabilityIdsForAvailabilityEnabler

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

Gets the Availability Ids mapped to an AvailabilityEnabler.

Parameters:

availabilityEnablerId - Id of an AvailabilityEnabler

Returns:

list of availability Ids

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.

getAvailabilitiesForAvailabilityEnabler

AvailabilityList getAvailabilitiesForAvailabilityEnabler(Id availabilityEnablerId)
                                                         throws NotFoundException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Gets the Availabilities mapped to an AvailabilityEnabler.

Parameters:

availabilityEnablerId - Id of an AvailabilityEnabler

Returns:

list of availabilities

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.