org.osid.resourcing.rules

Interface CommissionEnablerSmartFoundrySession

All Superinterfaces:

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

public interface CommissionEnablerSmartFoundrySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic foundries. A CommissionEnablerQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of commission enablers. The commission enabler may be sequenced using the CommissionEnablerSearchOrder terface from this session.

This Foundry has a default query that matches any commission enabler and a default search order that specifies no sequencing. The queries may be examined using a CommissionEnablerQueryInspector. The query may be modified by converting the inspector back to a CommissionEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCommissionEnablerQuery(CommissionEnablerQuery commissionEnablerQuery) Applies a commission enabler query to this foundry.
void	applyCommissionEnablerSequencing(CommissionEnablerSearchOrder commissionEnablerSearchOrder) Applies a commission enabler search order to this foundry.
boolean	canManageSmartFoundries() Tests if this user can manage smart foundries.
CommissionEnablerQuery	getCommissionEnablerQuery() Gets a commission enabler query.
CommissionEnablerQuery	getCommissionEnablerQueryFromInspector(CommissionEnablerQueryInspector commissionEnablerQueryInspector) Gets a commission enabler query from an inspector.
CommissionEnablerSearchOrder	getCommissionEnablerSearchOrder() Gets a commission enabler search order.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
CommissionEnablerQueryInspector	inspectCommissionEnablerQuery() Gets a commission enabler 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.

getCommissionEnablerQuery

CommissionEnablerQuery getCommissionEnablerQuery()

Gets a commission enabler query.

Returns:

the commission enabler query

Compliance:

mandatory - This method must be implemented.

getCommissionEnablerSearchOrder

CommissionEnablerSearchOrder getCommissionEnablerSearchOrder()

Gets a commission enabler search order.

Returns:

the commission enabler search order

Compliance:

mandatory - This method must be implemented.

applyCommissionEnablerQuery

void applyCommissionEnablerQuery(CommissionEnablerQuery commissionEnablerQuery)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a commission enabler query to this foundry.

Parameters:

commissionEnablerQuery - the commission enabler query

Throws:

NullArgumentException - ccommissionEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - commissionEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCommissionEnablerQuery

CommissionEnablerQueryInspector inspectCommissionEnablerQuery()
                                                              throws OperationFailedException,
                                                                     PermissionDeniedException

Gets a commission enabler query inspector for this foundry.

Returns:

the commission enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCommissionEnablerSequencing

void applyCommissionEnablerSequencing(CommissionEnablerSearchOrder commissionEnablerSearchOrder)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Applies a commission enabler search order to this foundry.

Parameters:

commissionEnablerSearchOrder - the commission enabler search order

Throws:

NullArgumentException - commissionEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - commissionEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCommissionEnablerQueryFromInspector

CommissionEnablerQuery getCommissionEnablerQueryFromInspector(CommissionEnablerQueryInspector commissionEnablerQueryInspector)

Gets a commission enabler query from an inspector.

Parameters:

commissionEnablerQueryInspector - a commission enabler query inspector

Returns:

the commission enabler query

Throws:

NullArgumentException - commissionEnablerQueryInspector is null

UnsupportedException - commissionEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.