org.osid.control

Interface SettingQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

SettingSearchSession

public interface SettingQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

• federated system view: searches include settings in systems of which this system is an ancestor in the system hierarchy
• isolated system view: searches are restricted to settings in this system

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchSettings() Tests if this user can perform Setting lookups.
SettingQuery	getSettingQuery() Gets a setting query.
SettingList	getSettingsByQuery(SettingQuery settingQuery) Gets a list of Settings matching the given setting query.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
void	useFederatedSystemView() Federates the view for methods in this session.
void	useIsolatedSystemView() 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

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchSettings

boolean canSearchSettings()

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

useFederatedSystemView

void useFederatedSystemView()

Federates the view for methods in this session. A federated view will include settings in systems which are children of this system in the system hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedSystemView

void useIsolatedSystemView()

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

Compliance:

mandatory - This method is must be implemented.

getSettingQuery

SettingQuery getSettingQuery()

Gets a setting query.

Returns:

the setting query

Compliance:

mandatory - This method must be implemented.

getSettingsByQuery

SettingList getSettingsByQuery(SettingQuery settingQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a list of Settings matching the given setting query.

Parameters:

settingQuery - the setting query

Returns:

the returned SettingList

Throws:

NullArgumentException - settingQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - settingQuery is not of this service

Compliance:

mandatory - This method must be implemented.