Interface | osid.calendaring.cycle.CyclicTimePeriodAdminSession | ||
---|---|---|---|
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 CyclicTimePeriodForms. To
unmap a 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 | canCreateCyclicTimePeriods | ||
Description |
Tests if this user can create | ||
Return | boolean | false if CyclicTimePeriod creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCyclicTimePeriodWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | cyclicTimePeriodRecordTypes | array of cyclic time period record types |
Return | boolean | true if CyclicTimePeriod creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | cyclicTimePeriodRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodFormForCreate | ||
Description |
Gets the cyclic time period form for creating new cyclic time periods. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | cyclicTimePeriodRecordTypes | array of cyclic time period record types |
Return | osid.calendaring.cycle.CyclicTimePeriodForm | the cyclic time period form | |
Errors | NULL_ARGUMENT | cyclicTimePeriodRecordTypes 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 | createCyclicTimePeriod | ||
Description |
Creates a new | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodForm | cyclicTimePeriodForm | the forms for this CyclicTimePeriod |
Return | osid.calendaring.cycle.CyclicTimePeriod | the new CyclicTimePeriod | |
Errors | ILLEGAL_STATE | cyclicTimePeriodForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | cyclicTimePeriodForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cyclicTimePeriodForm did not originate from
getCyclicTimePeriodFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCyclicTimePeriods | ||
Description |
Tests if this user can update | ||
Return | boolean | false if cyclic time period modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodFormForUpdate | ||
Description |
Gets the cyclic time period form for updating an existing cyclic time period. A new cyclic time period form should be requested for each update transaction. | ||
Parameters | osid.id.Id | cyclicTimePeriodId | the Id of the CyclicTimePeriod |
Return | osid.calendaring.cycle.CyclicTimePeriodForm | the cyclic time period form | |
Errors | NOT_FOUND | cyclicTimePeriodId is not found | |
NULL_ARGUMENT | cyclicTimePeriodid is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCyclicTimePeriod | ||
Description |
Updates an existing tiem period. | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodForm | cyclicTimePeriodForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | cyclicTimePeriodForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | cyclicTimePeriodForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cyclicTimePeriodForm did not originate from
getCyclicTimePeriodFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCyclicTimePeriods | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if CyclicTimePeriod deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCyclicTimePeriod | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | cyclicTimePeriodId | the Id of the CyclicTimePeriod to delete |
Errors | NOT_FOUND | a CyclicTimePeriod was not found identified by the given
Id | |
NULL_ARGUMENT | cyclicTimePeriodId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCyclicTimePeriodAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CyclicTimePeriod aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCyclicTimePeriod | ||
Description |
Adds an | ||
Parameters | osid.id.Id | cyclicTimePeriodId | the Id of a CyclicTimePeriod |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | cyclicTimePeriodId not found | ||
NULL_ARGUMENT | cyclicTimePeriodId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |