Interface | osid.calendaring.CalendarAdminSession | ||
---|---|---|---|
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 | ||
Method | canCreateCalendars | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Calendar creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCalendarWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | calendarRecordTypes | array of calendar record types |
Return | boolean | true if Calendar creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | calendarRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarFormForCreate | ||
Description |
Gets the calendar form for creating new calendars. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | calendarRecordTypes | array of calendar record types |
Return | osid.calendaring.CalendarForm | the calendar form | |
Errors | NULL_ARGUMENT | calendarRecordTypes 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 | createCalendar | ||
Description |
Creates a new | ||
Parameters | osid.calendaring.CalendarForm | calendarForm | the form for this Calendar |
Return | osid.calendaring.Calendar | the new Calendar | |
Errors | ILLEGAL_STATE | calendarForm already used for a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | calendarForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | calendarForm did not originate from
getCalendarFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCalendars | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Calendar modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarFormForUpdate | ||
Description |
Gets the calendar form for updating an existing calendar. A new calendar form should be requested for each update transaction. | ||
Parameters | osid.id.Id | calendarId | the Id of the Calendar |
Return | osid.calendaring.CalendarForm | the calendar form | |
Errors | NOT_FOUND | calendarId is not found | |
NULL_ARGUMENT | calendarId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCalendar | ||
Description |
Updates an existing calendar. | ||
Parameters | osid.calendaring.CalendarForm | calendarForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | calendarForm already used for an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | calendarForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | calendarForm did not originate from
getCalendarFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCalendars | ||
Description |
Tests if this user can delete calendars. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known deleting a | ||
Return | boolean | false if Calendar deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteCalendar | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | calendarId | the Id of the Calendar to remove |
Errors | NOT_FOUND | calendarId not found | |
NULL_ARGUMENT | calendarId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCalendarAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Calendar aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCalendar | ||
Description |
Adds an | ||
Parameters | osid.id.Id | calendarId | the Id of a Calendar |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | calendarId not found | ||
NULL_ARGUMENT | calendarId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |