Interface | osid.calendaring.rules.CommitmentEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes commitment enablers. The
data for create and update is provided via the | ||
Method | getCalendarId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Calendar Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendar | ||
Description |
Gets the | ||
Return | osid.calendaring.Calendar | the calendar | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCommitmentEnabler | ||
Description |
Tests if this user can create commitment 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 CommitmentEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCommitmentEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | commitmentEnablerRecordTypes | array of commitment enabler record types |
Return | boolean | true if CommitmentEnabler creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | commitmentEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentEnablerFormForCreate | ||
Description |
Gets the commitment enabler form for creating new commitment enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | commitmentEnablerRecordTypes | array of commitment enabler record types |
Return | osid.calendaring.rules.CommitmentEnablerForm | the commitment enabler form | |
Errors | NULL_ARGUMENT | commitmentEnablerRecordTypes 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 | createCommitmentEnabler | ||
Description |
Creates a new | ||
Parameters | osid.calendaring.rules.CommitmentEnablerForm | commitmentEnablerForm | the form for this CommitmentEnabler |
Return | osid.calendaring.rules.CommitmentEnabler | the new CommitmentEnabler | |
Errors | ILLEGAL_STATE | commitmentEnablerForm already used in a create trsnaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | commitmentEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | commitmentEnablerForm did not originate from
getCommitmentEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCommitmentEnablers | ||
Description |
Tests if this user can update commitment 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 CommitmentEnabler modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentEnablerFormForUpdate | ||
Description |
Gets the commitment enabler form for updating an existing commitment enabler. A new commitment enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | commitmentEnablerId | the Id of the CommitmentEnabler |
Return | osid.calendaring.rules.CommitmentEnablerForm | the commitment enabler form | |
Errors | NOT_FOUND | commitmentEnablerId is not found | |
NULL_ARGUMENT | commitmentEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCommitmentEnabler | ||
Description |
Updates an existing commitment enabler. | ||
Parameters | osid.calendaring.rules.CommitmentEnablerForm | commitmentEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | commitmentEnablerForm already used in an update trsnaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | commitmentEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | commitmentEnablerForm did not originate from
getCommitmentEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCommitmentEnablers | ||
Description |
Tests if this user can delete commitment 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 CommitmentEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCommitmentEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | commitmentEnablerId | the Id of the CommitmentEnabler to remove |
Errors | NOT_FOUND | commitmentEnablerId not found | |
NULL_ARGUMENT | commitmentEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCommitmentEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CommitmentEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCommitmentEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | commitmentEnablerId | the Id of a CommitmentEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | commitmentEnablerId not found | ||
NULL_ARGUMENT | commitmentEnablerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |