org.osid.resourcing

Interface CompetencyQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

CompetencySearchSession

public interface CompetencyQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

• federated foundry view: searches include competencies in foundries of which this foundry is an ancestor in the foundry hierarchy
• isolated foundry view: searches are restricted to competencies in this foundry

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchCompetencies() Tests if this user can perform Competency lookups.
CompetencyList	getCompetenciesByQuery(CompetencyQuery competencyQuery) Gets a list of Competencies matching the given competency query.
CompetencyQuery	getCompetencyQuery() Gets a competency query.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
void	useFederatedFoundryView() Federates the view for methods in this session.
void	useIsolatedFoundryView() 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

getFoundryId

Id getFoundryId()

Gets the Foundry Id associated with this session.

Returns:

the Foundry Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFoundry

Foundry getFoundry()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Foundry associated with this session.

Returns:

the foundry

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchCompetencies

boolean canSearchCompetencies()

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

useFederatedFoundryView

void useFederatedFoundryView()

Federates the view for methods in this session. A federated view will include competencies in foundries which are children of this foundry in the foundry hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFoundryView

void useIsolatedFoundryView()

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

Compliance:

mandatory - This method is must be implemented.

getCompetencyQuery

CompetencyQuery getCompetencyQuery()

Gets a competency query.

Returns:

the competency query

Compliance:

mandatory - This method must be implemented.

getCompetenciesByQuery

CompetencyList getCompetenciesByQuery(CompetencyQuery competencyQuery)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a list of Competencies matching the given competency query.

Parameters:

competencyQuery - the competency query

Returns:

the returned CompetencyList

Throws:

NullArgumentException - competencyQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - competencyQuery is not of this service

Compliance:

mandatory - This method must be implemented.