org.osid.resourcing

Interface EffortSmartFoundrySession

All Superinterfaces:

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

public interface EffortSmartFoundrySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An EffortQuery can be retrieved from this session and foundryped to this Foundry to create a virtual collection of Efforts. The efforts may be sequenced using the EffortSearchOrder from this session.

This Foundry has a default query that matches any effort and a default search order that specifies no sequencing. The queries may be examined using an EffortQueryInspector. The query may be modified by converting the inspector back to an EffortQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyEffortQuery(EffortQuery effortQuery) Applies an effort query to this foundry.
void	applyEffortSequencing(EffortSearchOrder effortSearchOrder) Applies an effort search order to this foundry.
boolean	canManageSmartFoundries() Tests if this user can manage smart foundries.
EffortQuery	getEffortQuery() Gets an effort query.
EffortQuery	getEffortQueryFromInspector(EffortQueryInspector effortQueryInspector) Gets an effort query from an inspector.
EffortSearchOrder	getEffortSearchOrder() Gets an effort search order.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
EffortQueryInspector	inspectEffortQuery() Gets an effort query inspector for this foundry.

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.

canManageSmartFoundries

boolean canManageSmartFoundries()

Tests if this user can manage smart foundries. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart foundry management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getEffortQuery

EffortQuery getEffortQuery()

Gets an effort query.

Returns:

the effort query

Compliance:

mandatory - This method must be implemented.

getEffortSearchOrder

EffortSearchOrder getEffortSearchOrder()

Gets an effort search order.

Returns:

the effort search order

Compliance:

mandatory - This method must be implemented.

applyEffortQuery

void applyEffortQuery(EffortQuery effortQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies an effort query to this foundry.

Parameters:

effortQuery - the effort query

Throws:

NullArgumentException - effortQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - effortQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectEffortQuery

EffortQueryInspector inspectEffortQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets an effort query inspector for this foundry.

Returns:

the effort query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyEffortSequencing

void applyEffortSequencing(EffortSearchOrder effortSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies an effort search order to this foundry.

Parameters:

effortSearchOrder - the effort search order

Throws:

NullArgumentException - effortSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - effortSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getEffortQueryFromInspector

EffortQuery getEffortQueryFromInspector(EffortQueryInspector effortQueryInspector)

Gets an effort query from an inspector.

Parameters:

effortQueryInspector - an effort query inspector

Returns:

the effort query

Throws:

NullArgumentException - effortQueryInspector is null

UnsupportedException - effortQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.