org.osid.resourcing

Interface JobSmartFoundrySession

All Superinterfaces:

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

public interface JobSmartFoundrySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A JobQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of Jobs. The jobs may be sequenced using the JobSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyJobQuery(JobQuery jobQuery) Applies a job query to this foundry.
void	applyJobSequencing(JobSearchOrder jobSearchOrder) Applies a job 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.
JobQuery	getJobQuery() Gets a job query.
JobQuery	getJobQueryFromInspector(JobQueryInspector jobQueryInspector) Gets a job query from an inspector.
JobSearchOrder	getJobSearchOrder() Gets a job search order.
JobQueryInspector	inspectJobQuery() Gets a job 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.

getJobQuery

JobQuery getJobQuery()

Gets a job query.

Returns:

the job query

Compliance:

mandatory - This method must be implemented.

getJobSearchOrder

JobSearchOrder getJobSearchOrder()

Gets a job search order.

Returns:

the job search order

Compliance:

mandatory - This method must be implemented.

applyJobQuery

void applyJobQuery(JobQuery jobQuery)
                   throws OperationFailedException,
                          PermissionDeniedException

Applies a job query to this foundry.

Parameters:

jobQuery - the job query

Throws:

NullArgumentException - jobQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - jobQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectJobQuery

JobQueryInspector inspectJobQuery()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets a job query inspector for this foundry.

Returns:

the job query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyJobSequencing

void applyJobSequencing(JobSearchOrder jobSearchOrder)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies a job search order to this foundry.

Parameters:

jobSearchOrder - the job search order

Throws:

NullArgumentException - jobSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - jobSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getJobQueryFromInspector

JobQuery getJobQueryFromInspector(JobQueryInspector jobQueryInspector)

Gets a job query from an inspector.

Parameters:

jobQueryInspector - a job query inspector

Returns:

the job query

Throws:

NullArgumentException - jobQueryInspector is null

UnsupportedException - jobQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.