org.osid.room

Interface CampusQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

CampusSearchSession

public interface CampusQuerySession
extends OsidSession

This session provides methods for searching Campus objects. The search query is constructed using the CampusQuery. The campus record Type also specifies the record for the campus query.

Campuses may have a query record indicated by their respective record types. The query record is accessed via the CampusQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchCampuses() Tests if this user can perform Campus searches.
CampusList	getCampusesByQuery(CampusQuery campusQuery) Gets a list of Campuses matching the given campus query.
CampusQuery	getCampusQuery() Gets a campus 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

canSearchCampuses

boolean canSearchCampuses()

Tests if this user can perform Campus 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 opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCampusQuery

CampusQuery getCampusQuery()

Gets a campus query.

Returns:

the campus query

Compliance:

mandatory - This method must be implemented.

getCampusesByQuery

CampusList getCampusesByQuery(CampusQuery campusQuery)
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets a list of Campuses matching the given campus query.

Parameters:

campusQuery - the campus query

Returns:

the returned CampusList

Throws:

NullArgumentException - campusQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - campusQuery is not of this service

Compliance:

mandatory - This method must be implemented.