Interface | osid.resourcing.rules.JobConstrainerEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes job constrainer enablers.
The data for create and update is provided via the | ||
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 | canCreateJobConstrainerEnabler | ||
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 | ||
Return | boolean | false if JobConstrainerEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateJobConstrainerEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | jobConstrainerEnablerRecordTypes | array of job constrainer enabler record types |
Return | boolean | true if JobConstrainerEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | jobConstrainerEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getJobConstrainerEnablerFormForCreate | ||
Description |
Gets the job constrainer enabler form for creating new job constrainer enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | jobConstrainerEnablerRecordTypes | array of job constrainer enabler record types |
Return | osid.resourcing.rules.JobConstrainerEnablerForm | the job constrainer enabler form | |
Errors | NULL_ARGUMENT | jobConstrainerEnablerRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form with requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createJobConstrainerEnabler | ||
Description |
Creates a new | ||
Parameters | osid.resourcing.rules.JobConstrainerEnablerForm | jobConstrainerEnablerForm | the form for this JobConstrainerEnabler |
Return | osid.resourcing.rules.JobConstrainerEnabler | the new JobConstrainerEnabler | |
Errors | ILLEGAL_STATE | jobConstrainerEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | jobConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | jobConstrainerEnablerForm did not originate from
getJobConstrainerEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateJobConstrainerEnablers | ||
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 | ||
Return | boolean | false if JobConstrainerEnabler modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getJobConstrainerEnablerFormForUpdate | ||
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. | ||
Parameters | osid.id.Id | jobConstrainerEnablerId | the Id of the JobConstrainerEnabler |
Return | osid.resourcing.rules.JobConstrainerEnablerForm | the job constrainer enabler form | |
Errors | NOT_FOUND | jobConstrainerEnablerId is not found | |
NULL_ARGUMENT | jobConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateJobConstrainerEnabler | ||
Description |
Updates an existing job constrainer enabler. | ||
Parameters | osid.resourcing.rules.JobConstrainerEnablerForm | jobConstrainerEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | jobConstrainerEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | jobConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | jobConstrainerEnablerForm did not originate from
getJobConstrainerEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteJobConstrainerEnablers | ||
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 | ||
Return | boolean | false if JobConstrainerEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteJobConstrainerEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | jobConstrainerEnablerId | the Id of the JobConstrainerEnabler to remove |
Errors | NOT_FOUND | jobConstrainerEnablerId not found | |
NULL_ARGUMENT | jobConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageJobConstrainerEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if JobConstrainerEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasJobConstrainerEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | jobConstrainerEnablerId | the Id of a JobConstrainerEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | jobConstrainerEnablerId not found | ||
NULL_ARGUMENT | jobConstrainerEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |