org.osid.grading

Interface GradebookColumnSearchSession

All Superinterfaces:

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

public interface GradebookColumnSearchSession
extends GradebookColumnQuerySession

This session provides methods for searching GradebookColumn objects. The search query is constructed using the GradebookColumnQuery.

getGradebookColumnsByQuery() is the basic search method and returns a list of GradebookColumn objects.A more advanced search may be performed with getGradebookColumnsBySearch(). It accepts a GradebookColumnSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getGradebookColumnsBySearch() returns a GradebookColumnSearchResults that can be used to access the resulting GradebookColumnList or be used to perform a search within the result set through GradebookColumnSearch.

This session defines views that offer differing behaviors for searching.

• federated gradebook view: searches include columns in gradebooks of which this gradebook is a ancestor in the gradebook hierarchy
• isolated gradebook view: searches are restricted to columns in this gradebook

Gradebook columns may have a query record indicated by their respective record types. The query record is accessed via the GradebookColumnQuery.

Method Summary

Methods

Modifier and Type	Method and Description
GradebookColumnQuery	getGradebookColumnQueryFromInspector(GradebookColumnQueryInspector gradebookColumnQueryInspector) Gets a gradebook column query from an inspector.
GradebookColumnSearchResults	getGradebookColumnsBySearch(GradebookColumnQuery gradebookColumnQuery, GradebookColumnSearch gradebookColumnSearch) Gets the search results matching the given search query using the given search.
GradebookColumnSearch	getGradebookColumnSearch() Gets a gradebook column search.
GradebookColumnSearchOrder	getGradebookColumnSearchOrder() Gets a gradebook column search order.

Methods inherited from interface org.osid.grading.GradebookColumnQuerySession

canSearchGradebookColumns, getGradebook, getGradebookColumnQuery, getGradebookColumnsByQuery, getGradebookId, useFederatedGradebookView, useIsolatedGradebookView

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

getGradebookColumnSearch

GradebookColumnSearch getGradebookColumnSearch()

Gets a gradebook column search.

Returns:

the gradebook column search

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSearchOrder

GradebookColumnSearchOrder getGradebookColumnSearchOrder()

Gets a gradebook column search order. The GradebookColumnSearchOrder is supplied to a GradebookColumnSearch to specify the ordering of results.

Returns:

the gradebook column search order

Compliance:

mandatory - This method must be implemented.

getGradebookColumnsBySearch

GradebookColumnSearchResults getGradebookColumnsBySearch(GradebookColumnQuery gradebookColumnQuery,
                                                       GradebookColumnSearch gradebookColumnSearch)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

gradebookColumnQuery - the gradebook column query

gradebookColumnSearch - the gradebook column search

Returns:

the gradebook column search results

Throws:

NullArgumentException - gradebookColumnQuery or gradebookColumnSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - gradebookColumnSearch or gradebookColumnQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getGradebookColumnQueryFromInspector

GradebookColumnQuery getGradebookColumnQueryFromInspector(GradebookColumnQueryInspector gradebookColumnQueryInspector)

Gets a gradebook column query from an inspector. The inspector is available from an GradebookColumnSearchResults.

Parameters:

gradebookColumnQueryInspector - a gradebook column query inspector

Returns:

the gradebook column query

Throws:

NullArgumentException - gradebookColumnQueryInspector is null

UnsupportedException - gradebookColumnQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.