OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.JobConstrainerQuerySession
Implementsosid.OsidSession
Description

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.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchJobConstrainers
Description

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.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedFoundryView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFoundryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetJobConstrainerQuery
Description

Gets a job constrainer query.

Returnosid.resourcing.rules.JobConstrainerQuerythe job constrainer query
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainersByQuery
Description

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

Parametersosid.resourcing.rules.JobConstrainerQueryjobConstrainerQuerythe job constrainer query
Returnosid.resourcing.rules.JobConstrainerListthe returned JobConstrainerList
ErrorsNULL_ARGUMENT jobConstrainerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobConstrainerQuery is not of this service
CompliancemandatoryThis method must be implemented.