org.osid.rules

Interface EngineLookupSession

All Superinterfaces:

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

public interface EngineLookupSession
extends OsidSession

This session provides methods for retrieving Engine objects. The Engine represents a collection of rules.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Engines it can access, without breaking execution. However, an assessment may only be useful if all Engines referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupEngines() Tests if this user can perform Engine lookups.
Engine	getEngine(Id engineId) Gets the Engine specified by its Id.
EngineList	getEngines() Gets all Engines.
EngineList	getEnginesByGenusType(Type engineGenusType) Gets an EngineList corresponding to the given engine genus Type which does not include engines of genus types derived from the specified Type.
EngineList	getEnginesByIds(IdList engineIds) Gets an EngineList corresponding to the given IdList.
EngineList	getEnginesByParentGenusType(Type engineGenusType) Gets an EngineList corresponding to the given engine genus Type and include any additional engines with genus types derived from the specified Type.
EngineList	getEnginesByProvider(Id resourceId) Gets an EngineList from the given provider.
EngineList	getEnginesByRecordType(Type engineRecordType) Gets an EngineList containing the given repository record Type.
void	useComparativeEngineView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryEngineView() A complete view of the Engine returns is desired.

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

canLookupEngines

boolean canLookupEngines()

Tests if this user can perform Engine 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeEngineView

void useComparativeEngineView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryEngineView

void usePlenaryEngineView()

A complete view of the Engine returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getEngine

Engine getEngine(Id engineId)
                 throws NotFoundException,
                        OperationFailedException,
                        PermissionDeniedException

Gets the Engine specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Engine may have a different Id than requested, such as the case where a duplicate Id was assigned to an Engine and retained for compatibility.

Parameters:

engineId - Id of the Engine

Returns:

the engine

Throws:

NotFoundException - engineId not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getEnginesByIds

EngineList getEnginesByIds(IdList engineIds)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets an EngineList corresponding to the given IdList. In plenary mode, the returned list contains all of the engines specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Engines may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

engineIds - the list of Ids to retrieve

Returns:

the returned Engine list

Throws:

NotFoundException - an Id was not found

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnginesByGenusType

EngineList getEnginesByGenusType(Type engineGenusType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets an EngineList corresponding to the given engine genus Type which does not include engines of genus types derived from the specified Type. In plenary mode, the returned list contains all known engines or an error results. Otherwise, the returned list may contain only those engines that are accessible through this session.

Parameters:

engineGenusType - an engine genus type

Returns:

the returned Engine list

Throws:

NullArgumentException - engineGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnginesByParentGenusType

EngineList getEnginesByParentGenusType(Type engineGenusType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets an EngineList corresponding to the given engine genus Type and include any additional engines with genus types derived from the specified Type. In plenary mode, the returned list contains all known engines or an error results. Otherwise, the returned list may contain only those engines that are accessible through this session.

Parameters:

engineGenusType - an engine genus type

Returns:

the returned Engine list

Throws:

NullArgumentException - engineGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnginesByRecordType

EngineList getEnginesByRecordType(Type engineRecordType)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets an EngineList containing the given repository record Type. In plenary mode, the returned list contains all known engines or an error results. Otherwise, the returned list may contain only those engines that are accessible through this session.

Parameters:

engineRecordType - a engine record type

Returns:

the returned Engine list

Throws:

NullArgumentException - engineRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnginesByProvider

EngineList getEnginesByProvider(Id resourceId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets an EngineList from the given provider. In plenary mode, the returned list contains all known engines or an error results. Otherwise, the returned list may contain only those engines that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Engine list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEngines

EngineList getEngines()
                      throws OperationFailedException,
                             PermissionDeniedException

Gets all Engines. In plenary mode, the returned list contains all known engines or an error results. Otherwise, the returned list may contain only those engines that are accessible through this session.

Returns:

a list of Engines

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.