org.osid.resourcing

Interface FoundryQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

FoundrySearchSession

public interface FoundryQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchFoundries() Tests if this user can perform Foundry searches.
FoundryList	getFoundriesByQuery(FoundryQuery foundryQuery) Gets a list of Foundries matching the given foundry query.
FoundryQuery	getFoundryQuery() Gets a foundry query.

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

canSearchFoundries

boolean canSearchFoundries()

Tests if this user can perform Foundry searches. 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.

getFoundryQuery

FoundryQuery getFoundryQuery()

Gets a foundry query.

Returns:

the foundry query

Compliance:

mandatory - This method must be implemented.

getFoundriesByQuery

FoundryList getFoundriesByQuery(FoundryQuery foundryQuery)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets a list of Foundries matching the given foundry query.

Parameters:

foundryQuery - the foundry query query

Returns:

the returned FoundryList

Throws:

NullArgumentException - foundryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - foundryQuery is not of this service

Compliance:

mandatory - This method must be implemented.