org.osid.resourcing.rules

Interface JobConstrainerEnablerSmartFoundrySession

All Superinterfaces:

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

public interface JobConstrainerEnablerSmartFoundrySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyJobConstrainerEnablerQuery(JobConstrainerEnablerQuery jobConstrainerEnablerQuery) Applies a job constrainer enabler query to this foundry.
void	applyJobConstrainerEnablerSequencing(JobConstrainerEnablerSearchOrder jobConstrainerEnablerSearchOrder) Applies a job constrainer 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.
JobConstrainerEnablerQuery	getJobConstrainerEnablerQuery() Gets a job constrainer enabler query.
JobConstrainerEnablerQuery	getJobConstrainerEnablerQueryFromInspector(JobConstrainerEnablerQueryInspector jobConstrainerEnablerQueryInspector) Gets a job constrainer enabler query from an inspector.
JobConstrainerEnablerSearchOrder	getJobConstrainerEnablerSearchOrder() Gets a job constrainer enabler search order.
JobConstrainerEnablerQueryInspector	inspectJobConstrainerEnablerQuery() Gets a job constrainer 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.

getJobConstrainerEnablerQuery

JobConstrainerEnablerQuery getJobConstrainerEnablerQuery()

Gets a job constrainer enabler query.

Returns:

the job constrainer enabler query

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablerSearchOrder

JobConstrainerEnablerSearchOrder getJobConstrainerEnablerSearchOrder()

Gets a job constrainer enabler search order.

Returns:

the job constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

applyJobConstrainerEnablerQuery

void applyJobConstrainerEnablerQuery(JobConstrainerEnablerQuery jobConstrainerEnablerQuery)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Applies a job constrainer enabler query to this foundry.

Parameters:

jobConstrainerEnablerQuery - the job constrainer enabler query

Throws:

NullArgumentException - jobConstrainerEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - jobConstrainerEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectJobConstrainerEnablerQuery

JobConstrainerEnablerQueryInspector inspectJobConstrainerEnablerQuery()
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

Gets a job constrainer enabler query inspector for this foundry.

Returns:

the job constrainer enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyJobConstrainerEnablerSequencing

void applyJobConstrainerEnablerSequencing(JobConstrainerEnablerSearchOrder jobConstrainerEnablerSearchOrder)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Applies a job constrainer enabler search order to this foundry.

Parameters:

jobConstrainerEnablerSearchOrder - the job constrainer enabler search order

Throws:

NullArgumentException - jobConstrainerEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - jobConstrainerEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablerQueryFromInspector

JobConstrainerEnablerQuery getJobConstrainerEnablerQueryFromInspector(JobConstrainerEnablerQueryInspector jobConstrainerEnablerQueryInspector)

Gets a job constrainer enabler query from an inspector.

Parameters:

jobConstrainerEnablerQueryInspector - a job constrainer enabler query inspector

Returns:

the job constrainer enabler query

Throws:

NullArgumentException - jobConstrainerEnablerQueryInspector is null

UnsupportedException - jobConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.