Interface | osid.workflow.rules.StepConstrainerEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes step constrainer enablers.
The data for create and update is provided via the | ||
Method | getOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Office Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffice | ||
Description |
Gets the | ||
Return | osid.workflow.Office | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateStepConstrainerEnabler | ||
Description |
Tests if this user can create step constrainer
enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a | ||
Return | boolean | false if StepConstrainerEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateStepConstrainerEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | stepConstrainerEnablerRecordTypes | array of step constrainer enabler record types |
Return | boolean | true if StepConstrainerEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | stepConstrainerEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerEnablerFormForCreate | ||
Description |
Gets the step constrainer enabler form for creating new step constrainer enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | stepConstrainerEnablerRecordTypes | array of step constrainer enabler record types |
Return | osid.workflow.rules.StepConstrainerEnablerForm | the step constrainer enabler form | |
Errors | NULL_ARGUMENT | stepConstrainerEnablerRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createStepConstrainerEnabler | ||
Description |
Creates a new | ||
Parameters | osid.workflow.rules.StepConstrainerEnablerForm | stepConstrainerEnablerForm | the form for this StepConstrainerEnabler |
Return | osid.workflow.rules.StepConstrainerEnabler | the new StepConstrainerEnabler | |
Errors | ILLEGAL_STATE | stepConstrainerEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | stepConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepConstrainerEnablerForm did not originate from
getStepConstrainerEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateStepConstrainerEnablers | ||
Description |
Tests if this user can update step 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 StepConstrainerEnabler modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerEnablerFormForUpdate | ||
Description |
Gets the step constrainer enabler form for updating an existing step constrainer enabler. A new step constrainer enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | stepConstrainerEnablerId | the Id of the StepConstrainerEnabler |
Return | osid.workflow.rules.StepConstrainerEnablerForm | the step constrainer enabler form | |
Errors | NOT_FOUND | stepConstrainerEnablerId is not found | |
NULL_ARGUMENT | stepConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateStepConstrainerEnabler | ||
Description |
Updates an existing step constrainer enabler. | ||
Parameters | osid.workflow.rules.StepConstrainerEnablerForm | stepConstrainerEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | stepConstrainerEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | stepConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepConstrainerEnablerForm did not originate from
getStepConstrainerEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteStepConstrainerEnablers | ||
Description |
Tests if this user can delete step 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 StepConstrainerEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteStepConstrainerEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | stepConstrainerEnablerId | the Id of the StepConstrainerEnabler to
remove |
Errors | NOT_FOUND | stepConstrainerEnablerId not found | |
NULL_ARGUMENT | stepConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageStepConstrainerEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if StepConstrainerEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasStepConstrainerEnabler | ||
Description |
Adds a | ||
Parameters | osid.id.Id | stepConstrainerEnablerId | the Id of a StepConstrainerEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | stepConstrainerEnablerId not found | ||
NULL_ARGUMENT | stepConstrainerEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |