org.osid.sequencing

Interface AntimatroidQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

AntimatroidSearchSession

public interface AntimatroidQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchAntimatroids() Tests if this user can perform Antimatroid searches.
AntimatroidQuery	getAntimatroidQuery() Gets an antimatroid query.
AntimatroidList	getAntimatroidsByQuery(AntimatroidQuery antimatroidQuery) Gets a list of Antimatroids matching the given antimatroid 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

canSearchAntimatroids

boolean canSearchAntimatroids()

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

getAntimatroidQuery

AntimatroidQuery getAntimatroidQuery()

Gets an antimatroid query.

Returns:

the antimatroid query

Compliance:

mandatory - This method must be implemented.

getAntimatroidsByQuery

AntimatroidList getAntimatroidsByQuery(AntimatroidQuery antimatroidQuery)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of Antimatroids matching the given antimatroid query.

Parameters:

antimatroidQuery - the antimatroid query

Returns:

the returned AntimatroidList

Throws:

NullArgumentException - antimatroidQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - antimatroidQuery is not of this service

Compliance:

mandatory - This method must be implemented.