org.osid.resourcing.rules

Interface JobConstrainerQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

JobConstrainerSearchSession

public interface JobConstrainerQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

Job constrainers may have a job constrainers query record indicated by their respective record types. The job constrainers query record is accessed via the JobConstrainerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchJobConstrainers() Tests if this user can perform JobConstrainer lookups.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
JobConstrainerQuery	getJobConstrainerQuery() Gets a job constrainer query.
JobConstrainerList	getJobConstrainersByQuery(JobConstrainerQuery jobConstrainerQuery) Gets a list of JobConstrainers matching the given job constrainer 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.

canSearchJobConstrainers

boolean canSearchJobConstrainers()

Tests if this user can perform JobConstrainer 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 constrainer 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.

getJobConstrainerQuery

JobConstrainerQuery getJobConstrainerQuery()

Gets a job constrainer query.

Returns:

the job constrainer query

Compliance:

mandatory - This method must be implemented.

getJobConstrainersByQuery

JobConstrainerList getJobConstrainersByQuery(JobConstrainerQuery jobConstrainerQuery)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets a list of JobConstrainers matching the given job constrainer query.

Parameters:

jobConstrainerQuery - the job constrainer query

Returns:

the returned JobConstrainerList

Throws:

NullArgumentException - jobConstrainerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - jobConstrainerQuery is not of this service

Compliance:

mandatory - This method must be implemented.