Interface | osid.resourcing.rules.JobConstrainerEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getFoundryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Foundry Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundry | ||
Description |
Gets the | ||
Return | osid.resourcing.Foundry | the foundry | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignJobConstrainerEnablers | ||
Description |
Tests if this user can alter job constrainer
enabler/job constrainer mappings. A return of true does
not guarantee successful authorization. A return of false
indicates that it is known mapping methods in this session
will result in a | ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignJobConstrainerEnablerToJobConstrainer | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | jobConstrainerEnablerId | the Id of the JobConstrainerEnabler |
osid.id.Id | jobConstrainerId | the Id of the JobConstrainer | |
Errors | ALREADY_EXISTS | jobConstrainerEnablerId is already applied to
jobConstrainerId | |
NOT_FOUND | jobConstrainerEnablerId or jobConstrainerId
not found | ||
NULL_ARGUMENT | jobConstrainerEnablerId or jobConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignJobConstrainerEnablerFromJobConstrainer | ||
Description |
Removes a | ||
Parameters | osid.id.Id | jobConstrainerEnablerId | the Id of the JobConstrainerEnabler |
osid.id.Id | jobConstrainerId | the Id of the JobConstrainer | |
Errors | NOT_FOUND | jobConstrainerEnablerId or jobConstrainerId
not found or jobConstrainerEnablerId not applied to
jobConstrainerId | |
NULL_ARGUMENT | jobConstrainerEnablerId or jobConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceJobConstrainerEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if JobConstrainerEnabler ordering is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveJobConstrainerEnablerAhead | ||
Description |
Reorders job constrainer enablers for a job constrainer by moving the specified job constrainer enabler in front of a reference job constrainer enabler. | ||
Parameters | osid.id.Id | jobConstrainerEnablerId | the Id of a JobConstrainerEnabler |
osid.id.Id | jobConstrainerId | the Id of a JobConstrainer | |
osid.id.Id | referenceId | the reference job constrainer enabler Id | |
Errors | NOT_FOUND | jobConstrainerEnablerId, jobConstrainenId, or
referenceId not found or, jobConstrainerEnablerId or
referenceId not related to jobConstrainerId | |
NULL_ARGUMENT | jobConstrainerEnablerId, jobConstrainerId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveJobConstrainerEnablerBehind | ||
Description |
Reorders job constrainer enablers for a job constrainer by moving the specified job constrainer enabler behind a reference job constrainer enabler. | ||
Parameters | osid.id.Id | jobConstrainerEnablerId | the Id of a JobConstrainerEnabler |
osid.id.Id | jobConstrainerId | the Id of a JobConstrainer | |
osid.id.Id | referenceId | the reference job constrainer enabler Id | |
Errors | NOT_FOUND | jobConstrainerEnablerId, jobConstrainerId, or
referenceId not found or, jobConstrainerEnablerId or
referenceId not related to jobConstrainerId | |
NULL_ARGUMENT | jobConstrainerEnablerId, jobConstrainerId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderJobConstrainerEnablers | ||
Description |
Reorders a set of job constrainer enablers for a job constrainer. | ||
Parameters | osid.id.Id[] | jobConstrainerEnablerIds | the Ids for a set of JobConstrainerEnablers |
osid.id.Id | jobConstrainerId | the Id of a JobConstrainer | |
Errors | NOT_FOUND | jobConstrainerId not found or, a
jobConstrainerEnablerId not related to jobConstrainerId | |
NULL_ARGUMENT | jobConstrainerEnablerIds or jobConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |