org.osid.resourcing.rules

Interface JobProcessorEnablerSmartFoundrySession

All Superinterfaces:

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

public interface JobProcessorEnablerSmartFoundrySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic foundries. A JobProcessorEnablerQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of job processor enablers. The job processor enablers may be sequenced using the JobProcessorEnablerSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyJobProcessorEnablerQuery(JobProcessorEnablerQuery jobProcessorEnablerQuery) Applies a job processor enabler query to this foundry.
void	applyJobProcessorEnablerSequencing(JobProcessorEnablerSearchOrder jobProcessorEnablerSearchOrder) Applies a job processor enabler search order to this foundry.
boolean	canManageSmartFoundries() Tests if this user can manage smart foundries.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
JobProcessorEnablerQuery	getJobProcessorEnablerQuery() Gets a job processor enabler query.
JobProcessorEnablerQuery	getJobProcessorEnablerQueryFromInspector(JobProcessorEnablerQueryInspector jobProcessorEnablerQueryInspector) Gets a job processor enabler query from an inspector.
JobProcessorEnablerSearchOrder	getJobProcessorEnablerSearchOrder() Gets a job processor enabler search order.
JobProcessorEnablerQueryInspector	inspectJobProcessorEnablerQuery() Gets a job processor 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.

getJobProcessorEnablerQuery

JobProcessorEnablerQuery getJobProcessorEnablerQuery()

Gets a job processor enabler query.

Returns:

the job processor enabler query

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablerSearchOrder

JobProcessorEnablerSearchOrder getJobProcessorEnablerSearchOrder()

Gets a job processor enabler search order.

Returns:

the job processor enabler search order

Compliance:

mandatory - This method must be implemented.

applyJobProcessorEnablerQuery

void applyJobProcessorEnablerQuery(JobProcessorEnablerQuery jobProcessorEnablerQuery)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies a job processor enabler query to this foundry.

Parameters:

jobProcessorEnablerQuery - the job processor enabler query

Throws:

NullArgumentException - jobProcessorEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - jobProcessorEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectJobProcessorEnablerQuery

JobProcessorEnablerQueryInspector inspectJobProcessorEnablerQuery()
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

Gets a job processor enabler query inspector for this foundry.

Returns:

the job processor enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyJobProcessorEnablerSequencing

void applyJobProcessorEnablerSequencing(JobProcessorEnablerSearchOrder jobProcessorEnablerSearchOrder)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Applies a job processor enabler search order to this foundry.

Parameters:

jobProcessorEnablerSearchOrder - the job processor enabler search order

Throws:

NullArgumentException - jobProcessorEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - jobProcessorEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablerQueryFromInspector

JobProcessorEnablerQuery getJobProcessorEnablerQueryFromInspector(JobProcessorEnablerQueryInspector jobProcessorEnablerQueryInspector)

Gets a job processor enabler query from an inspector.

Parameters:

jobProcessorEnablerQueryInspector - a job processor enabler query inspector

Returns:

the job processor enabler query

Throws:

NullArgumentException - jobProcessorEnablerQueryInspector is null

UnsupportedException - jobProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.