Interface | osid.calendaring.CommitmentAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCommitments | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Commitment creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCommitmentWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | commitmentRecordTypes | array of comitment record types |
Return | boolean | true if Commitment creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | commitmentRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentFormForCreate | ||
Description |
Gets the commitment form for creating new commitments. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | eventId | the Id of the Event |
osid.id.Id | resourceId | the Id of the Resource | |
osid.type.Type[] | commitmentRecordTypes | array of comitment record types | |
Return | osid.calendaring.CommitmentForm | the commitment form | |
Errors | NOT_FOUND | eventId or resourceId is not found | |
NULL_ARGUMENT | eventId or resourceId or
commitmentRecordTypes is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested recod types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCommitment | ||
Description |
Creates a new | ||
Parameters | osid.calendaring.CommitmentForm | commitmentForm | the forms for this Commitment |
Return | osid.calendaring.Commitment | the new Commitment | |
Errors | ILLEGAL_STATE | commitmentForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | commitmentForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | commitmentForm did not originate from
getCommitmentFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCommitments | ||
Description |
Tests if this user can update | ||
Return | boolean | false if commitment modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentFormForUpdate | ||
Description |
Gets the commitment form for updating an existing commitment. A new commitment form should be requested for each update transaction. | ||
Parameters | osid.id.Id | commitmentId | the Id of the Commitment |
Return | osid.calendaring.CommitmentForm | the commitment form | |
Errors | NOT_FOUND | commitmentId is not found | |
NULL_ARGUMENT | commitmentid is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCommitment | ||
Description |
Updates an existing commitment. | ||
Parameters | osid.calendaring.CommitmentForm | commitmentForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | commitmentForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | commitmentForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | commitmentForm did not originate from
getCommitmentFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCommitments | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Commitment deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCommitment | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | commitmentId | the Id of the Commitment to delete |
Errors | NOT_FOUND | a Commitment was not found identified by the given Id
| |
NULL_ARGUMENT | commitmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCommitmentAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Commitment aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCommitment | ||
Description |
Adds an | ||
Parameters | osid.id.Id | commitmentId | the Id of a Commitment |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | commitmentId not found | ||
NULL_ARGUMENT | commitmentId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |