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

This session creates and removes job processors. The data for create and update is provided via the JobProcessorForm.

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

Tests if this user can create job processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a JobProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if JobProcessor creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateJobProcessorWithRecordTypes
Description

Tests if this user can create a single JobProcessor using the desired record types. While ResourcingRulesManager.getJobProcessorRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific JobProcessor. Providing an empty array tests if a JobProcessor can be created with no records.

Parametersosid.type.Type[]jobProcessorRecordTypesarray of job processor record types
Returnboolean true if JobProcessor creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT jobProcessorRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorFormForCreate
Description

Gets the job processor form for creating new job processors. A new form should be requested for each create transaction.

Parametersosid.type.Type[]jobProcessorRecordTypesarray of job processor record types
Returnosid.resourcing.rules.JobProcessorFormthe job processor form
ErrorsNULL_ARGUMENT jobProcessorRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form with requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateJobProcessor
Description

Creates a new JobProcessor.

Parametersosid.resourcing.rules.JobProcessorFormjobProcessorFormthe form for this JobProcessor
Returnosid.resourcing.rules.JobProcessorthe new JobProcessor
ErrorsILLEGAL_STATE jobProcessorForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT jobProcessorForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobProcessorForm did not originate from getJobProcessorFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateJobProcessors
Description

Tests if this user can update job processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a JobProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if JobProcessor modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorFormForUpdate
Description

Gets the job processor form for updating an existing job processor. A new job processor form should be requested for each update transaction.

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

Updates an existing job processor.

Parametersosid.resourcing.rules.JobProcessorFormjobProcessorFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE jobProcessorForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT jobProcessorForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobProcessorForm did not originate from getJobProcessorFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteJobProcessors
Description

Tests if this user can delete job processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a JobProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if JobProcessor deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteJobProcessor
Description

Deletes a JobProcessor.

Parametersosid.id.IdjobProcessorIdthe Id of the JobProcessor to remove
ErrorsNOT_FOUND jobProcessorId not found
NULL_ARGUMENT jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageJobProcessorAliases
Description

Tests if this user can manage Id aliases for job processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if JobProcessor aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasJobProcessor
Description

Adds an Id to a JobProcessor for the purpose of creating compatibility. The primary Id of the JobProcessor is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another job processor. it is reassigned to the given job processor Id.

Parametersosid.id.IdjobProcessorIdthe Id of a JobProcessor
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND jobProcessorId not found
NULL_ARGUMENT jobProcessorId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.