org.osid.control.rules

Interface ActionEnablerQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

ActionEnablerSearchSession

public interface ActionEnablerQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

Action constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the ActionEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchActionEnablers() Tests if this user can perform ActionEnabler lookups.
ActionEnablerQuery	getActionEnablerQuery() Gets an action enabler query.
ActionEnablerList	getActionEnablersByQuery(ActionEnablerQuery actionEnablerQuery) Gets a list of ActionEnablers matching the given search.
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.

canSearchActionEnablers

boolean canSearchActionEnablers()

Tests if this user can perform ActionEnabler 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 action enablers in systems which are children of this broker 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.

getActionEnablerQuery

ActionEnablerQuery getActionEnablerQuery()

Gets an action enabler query.

Returns:

the action enabler query

Compliance:

mandatory - This method must be implemented.

getActionEnablersByQuery

ActionEnablerList getActionEnablersByQuery(ActionEnablerQuery actionEnablerQuery)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a list of ActionEnablers matching the given search.

Parameters:

actionEnablerQuery - the action constraienr enabler query

Returns:

the returned ActionEnablerList

Throws:

NullArgumentException - actionEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - actionEnablerQuery is not of this service

Compliance:

mandatory - This method must be implemented.