org.osid.control

Interface SystemQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

SystemSearchSession

public interface SystemQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchSystems() Tests if this user can perform System searches.
SystemQuery	getSystemQuery() Gets a system query.
SystemList	getSystemsByQuery(SystemQuery systemQuery) Gets a list of Systems matching the given system 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

canSearchSystems

boolean canSearchSystems()

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

getSystemQuery

SystemQuery getSystemQuery()

Gets a system query.

Returns:

the system query

Compliance:

mandatory - This method must be implemented.

getSystemsByQuery

SystemList getSystemsByQuery(SystemQuery systemQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets a list of Systems matching the given system query.

Parameters:

systemQuery - the system query

Returns:

the returned SystemList

Throws:

NullArgumentException - systemQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - systemQuery is not of this service

Compliance:

mandatory - This method must be implemented.