Interface CompositionEnablerQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

CompositionEnablerSearchSession

public interface CompositionEnablerQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

• federated repository view: searches include composition enablers in repositories of which this repository is an ancestor in the repository hierarchy
• isolated repository view: searches are restricted to composition enablers in this repository

Composition enablers may have a query record indicated by their respective record types. The query record is accessed via the CompositionEnablerQuery.

Method Summary

Modifier and Type	Method	Description
boolean	canSearchCompositionEnablers()	Tests if this user can perform CompositionEnabler lookups.
CompositionEnablerQuery	getCompositionEnablerQuery()	Gets a composition enabler query.
CompositionEnablerList	getCompositionEnablersByQuery(CompositionEnablerQuery compositionEnablerQuery)	Gets a list of CompositionEnablers matching the given composition enabler query.
Repository	getRepository()	Gets the Repository associated with this session.
Id	getRepositoryId()	Gets the Repository Id associated with this session.
void	useFederatedRepositoryView()	Federates the view for methods in this session.
void	useIsolatedRepositoryView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getRepositoryId

Id getRepositoryId()

Gets the Repository Id associated with this session.

Returns:

the Repository Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepository

Repository getRepository()
                  throws OperationFailedException,
PermissionDeniedException

Gets the Repository associated with this session.

Returns:

the repository

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchCompositionEnablers

boolean canSearchCompositionEnablers()

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

useFederatedRepositoryView

void useFederatedRepositoryView()

Federates the view for methods in this session. A federated view will include composition enablers in repositories which are children of this repository in the repository hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedRepositoryView

void useIsolatedRepositoryView()

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

Compliance:

mandatory - This method is must be implemented.

getCompositionEnablerQuery

CompositionEnablerQuery getCompositionEnablerQuery()

Gets a composition enabler query.

Returns:

the composition enabler query

Compliance:

mandatory - This method must be implemented.

getCompositionEnablersByQuery

CompositionEnablerList getCompositionEnablersByQuery(CompositionEnablerQuery compositionEnablerQuery)
                                              throws OperationFailedException,
PermissionDeniedException

Gets a list of CompositionEnablers matching the given composition enabler query.

Parameters:

compositionEnablerQuery - the composition enabler query

Returns:

the returned CompositionEnablerList

Throws:

NullArgumentException - compositionEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - compositionEnablerQuery is not of this service

Compliance:

mandatory - This method must be implemented.