org.osid.resourcing.rules

Interface JobProcessorQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

JobProcessorSearchSession

public interface JobProcessorQuerySession
extends OsidSession

This session provides methods for searching among JobProcessor objects. The search query is constructed using the JobProcessorQuery.

This session defines views that offer differing behaviors for searching.

• federated foundry view: searches include job processor in foundries of which this foundry is an ancestor in the foundry hierarchy
• isolated foundry view: searches are restricted to job processor in this foundry

Job processors may have a job processor query record indicated by their respective record types. The job processor query record is accessed via the JobProcessorQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchJobProcessors() Tests if this user can perform JobProcessor lookups.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
JobProcessorQuery	getJobProcessorQuery() Gets a job processor query.
JobProcessorList	getJobProcessorsByQuery(JobProcessorQuery jobProcessorQuery) Gets a list of JobProcessors matching the given job processor query.
void	useFederatedFoundryView() Federates the view for methods in this session.
void	useIsolatedFoundryView() Isolates the view for methods in this session.

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.

canSearchJobProcessors

boolean canSearchJobProcessors()

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

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedFoundryView

void useFederatedFoundryView()

Federates the view for methods in this session. A federated view will include job processor in foundries which are children of this job in the foundry hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFoundryView

void useIsolatedFoundryView()

Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.

Compliance:

mandatory - This method is must be implemented.

getJobProcessorQuery

JobProcessorQuery getJobProcessorQuery()

Gets a job processor query.

Returns:

the job processor query

Compliance:

mandatory - This method must be implemented.

getJobProcessorsByQuery

JobProcessorList getJobProcessorsByQuery(JobProcessorQuery jobProcessorQuery)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets a list of JobProcessors matching the given job processor query.

Parameters:

jobProcessorQuery - the job processor query

Returns:

the returned JobProcessorList

Throws:

NullArgumentException - jobProcessorQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - jobProcessorQuery is not of this service

Compliance:

mandatory - This method must be implemented.