org.osid.resourcing

Interface AvailabilityQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

AvailabilitySearchSession

public interface AvailabilityQuerySession
extends OsidSession

This session provides methods for searching among Availability objects. The search query is constructed using the AvailabilityQuery.

This session defines views that offer differing behaviors for searching.

• federated foundry view: searches include availabilities in foundries of which this foundry is an ancestor in the foundry hierarchy
• isolated foundry view: searches are restricted to availabilities in this foundry

Availabilities may have a query record indicated by their respective record types. The query record is accessed via the AvailabilityQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchAvailabilities() Tests if this user can perform Availability lookups.
AvailabilityList	getAvailabilitiesByQuery(AvailabilityQuery availabilityQuery) Gets a list of Availabilities matching the given availability query.
AvailabilityQuery	getAvailabilityQuery() Gets an availability query.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
void	useFederatedFoundryView() Federates the view for methods in this session.
void	useIsolatedFoundryView() Isolates the view for methods in this session.

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.

canSearchAvailabilities

boolean canSearchAvailabilities()

Tests if this user can perform Availability lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedFoundryView

void useFederatedFoundryView()

Federates the view for methods in this session. A federated view will include availabilities 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.

getAvailabilityQuery

AvailabilityQuery getAvailabilityQuery()

Gets an availability query.

Returns:

the availability query

Compliance:

mandatory - This method must be implemented.

getAvailabilitiesByQuery

AvailabilityList getAvailabilitiesByQuery(AvailabilityQuery availabilityQuery)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a list of Availabilities matching the given availability query.

Parameters:

availabilityQuery - the availability query

Returns:

the returned AvailabilityList

Throws:

NullArgumentException - availabilityQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - availabilityQuery is not of this service

Compliance:

mandatory - This method must be implemented.