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

This session provides methods for retrieving JobProcessors.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated foundry view: All job processor methods in this session operate, retrieve and pertain to job processor defined explicitly in the current foundry. Using an isolated view is useful for managing JobProcessors with the JobProcessorAdminSession.
  • federated foundry view: All job processor methods in this session operate, retrieve and pertain to all job processor defined in this foundry and any other job processor implicitly available in this foundry through foundry inheritence.
  • active job processor view: All job processor lookup methods return active job processors.
  • any status job processor view: Job processors of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedFoundryView() and useIsolatedFoundryView() behave as a radio group and one should be selected before invoking the methods in this session.

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.
MethodcanLookupJobProcessors
Description

Tests if this user can perform JobProcessors 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 opt not to offer lookup operations to unauthorized users.

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

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryJobProcessorView
Description

A complete view of the JobProcessor returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedFoundryView
Description

Federates the view for methods in this session. A federated view will include job processor in foundries which are children of this foundry 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.
MethoduseActiveJobProcessorView
Description

Only active job processors are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusJobProcessorView
Description

All active and inactive job processors are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetJobProcessor
Description

Gets the JobProcessor specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned JobProcessor may have a different Id than requested, such as the case where a duplicate Id was assigned to a JobProcessor and retained for compatibility.

In active mode, job processors are returned that are currently active. In any status mode, active and inactive job processors are returned.

Parametersosid.id.IdjobProcessorId Id of the JobProcessor
Returnosid.resourcing.rules.JobProcessorthe job processor
ErrorsNOT_FOUND jobProcessorId not found
NULL_ARGUMENT jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetJobProcessorsByIds
Description

Gets a JobProcessorList corresponding to the given IdList.

In plenary mode, the returned list contains all of the job processor specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible JobProcessors may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, job processors are returned that are currently active. In any status mode, active and inactive job processors are returned.

Parametersosid.id.IdListjobProcessorIdsthe list of Ids to retrieve
Returnosid.resourcing.rules.JobProcessorListthe returned JobProcessor list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT jobProcessorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorsByGenusType
Description

Gets a JobProcessorList corresponding to the given job processor genus Type which does not include job processor of genus types derived from the specified Type.

In plenary mode, the returned list contains all known job processor or an error results. Otherwise, the returned list may contain only those job processor that are accessible through this session.

In active mode, job processors are returned that are currently active. In any status mode, active and inactive job processors are returned.

Parametersosid.type.TypejobProcessorGenusTypea job processor genus type
Returnosid.resourcing.rules.JobProcessorListthe returned JobProcessor list
ErrorsNULL_ARGUMENT jobProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorsByParentGenusType
Description

Gets a JobProcessorList corresponding to the given job processor genus Type and include any additional job processor with genus types derived from the specified Type.

In plenary mode, the returned list contains all known job processor or an error results. Otherwise, the returned list may contain only those job processor that are accessible through this session.

In active mode, job processors are returned that are currently active. In any status mode, active and inactive job processors are returned.

Parametersosid.type.TypejobProcessorGenusTypea job processor genus type
Returnosid.resourcing.rules.JobProcessorListthe returned JobProcessor list
ErrorsNULL_ARGUMENT jobProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorsByRecordType
Description

Gets a JobProcessorList containing the given job processor record Type.

In plenary mode, the returned list contains all known job processor or an error results. Otherwise, the returned list may contain only those job processor that are accessible through this session.

In active mode, job processors are returned that are currently active. In any status mode, active and inactive job processors are returned.

Parametersosid.type.TypejobProcessorRecordTypea job processor record type
Returnosid.resourcing.rules.JobProcessorListthe returned JobProcessor list
ErrorsNULL_ARGUMENT jobProcessorRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessors
Description

Gets all JobProcessors.

In plenary mode, the returned list contains all known job processor or an error results. Otherwise, the returned list may contain only those job processor that are accessible through this session.

In active mode, job processors are returned that are currently active. In any status mode, active and inactive job processors are returned.

Returnosid.resourcing.rules.JobProcessorListthe returned JobProcessor list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.