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

This session creates and removes job constrainer enablers. The data for create and update is provided via the JobConstrainerEnablerForm.

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

Tests if this user can create job constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known a JobConstrainerEnabler 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 JobConstrainerEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateJobConstrainerEnablerWithRecordTypes
Description

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

Parametersosid.type.Type[]jobConstrainerEnablerRecordTypesarray of job constrainer enabler record types
Returnboolean true if JobConstrainerEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT jobConstrainerEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainerEnablerFormForCreate
Description

Gets the job constrainer enabler form for creating new job constrainer enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]jobConstrainerEnablerRecordTypesarray of job constrainer enabler record types
Returnosid.resourcing.rules.JobConstrainerEnablerFormthe job constrainer enabler form
ErrorsNULL_ARGUMENT jobConstrainerEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form with requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateJobConstrainerEnabler
Description

Creates a new JobConstrainerEnabler.

Parametersosid.resourcing.rules.JobConstrainerEnablerFormjobConstrainerEnablerFormthe form for this JobConstrainerEnabler
Returnosid.resourcing.rules.JobConstrainerEnablerthe new JobConstrainerEnabler
ErrorsILLEGAL_STATE jobConstrainerEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT jobConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobConstrainerEnablerForm did not originate from getJobConstrainerEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateJobConstrainerEnablers
Description

Tests if this user can update job constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a JobConstrainerEnabler 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 JobConstrainerEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainerEnablerFormForUpdate
Description

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

Parametersosid.id.IdjobConstrainerEnablerIdthe Id of the JobConstrainerEnabler
Returnosid.resourcing.rules.JobConstrainerEnablerFormthe job constrainer enabler form
ErrorsNOT_FOUND jobConstrainerEnablerId is not found
NULL_ARGUMENT jobConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateJobConstrainerEnabler
Description

Updates an existing job constrainer enabler.

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

Tests if this user can delete job constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a JobConstrainerEnabler 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 JobConstrainerEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteJobConstrainerEnabler
Description

Deletes a JobConstrainerEnabler.

Parametersosid.id.IdjobConstrainerEnablerIdthe Id of the JobConstrainerEnabler to remove
ErrorsNOT_FOUND jobConstrainerEnablerId not found
NULL_ARGUMENT jobConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageJobConstrainerEnablerAliases
Description

Tests if this user can manage Id aliases for job constrainer enablers. 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 JobConstrainerEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasJobConstrainerEnabler
Description

Adds an Id to a JobConstrainerEnabler for the purpose of creating compatibility. The primary Id of the JobConstrainerEnabler 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 constrainer enabler. it is reassigned to the given job constrainer enabler Id.

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