| Interface | osid.locale.CalendarConversionSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session defines methods to convert dates across calendar systems.  | ||
| Method | getSourceCalendarType | ||
| Description | 
                     Gets the source calendar type used in this session.  | ||
| Return | osid.type.Type | the source calendar type | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSourceTimeType | ||
| Description | 
                     Gets the source time type used in this session.  | ||
| Return | osid.type.Type | the source time type | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTargetCalendarType | ||
| Description | 
                     Gets the target calendar type used in this session.  | ||
| Return | osid.type.Type | the target calendar | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTargetTimeType | ||
| Description | 
                     Gets the target time type used in this session.  | ||
| Return | osid.type.Type | the target time type | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canConvertCalendars | ||
| Description | 
                     Tests if this user can perform calendar conversions. A 
                    return of true does not guarantee successful 
                    authorization. A return of false indicates that it is 
                    known all methods in this session will result in a   | ||
| Return | boolean |  false  if conversion methods are not authorized,  true 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | convertCalendar | ||
| Description | 
                     Converts a date.  | ||
| Parameters | osid.calendaring.DateTime | sourceDate | the date to convert | 
| Return | osid.calendaring.DateTime | the resulting date | |
| Errors | INVALID_ARGUMENT |  sourceDate.getCalendarType() != getSourceCalendarType()  or 
 sourceDate.getTimeType() != getSourceTimeType()   |                 |
| NULL_ARGUMENT |  sourceDate  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | convertCalendars | ||
| Description | 
                     Converts dates.  | ||
| Parameters | osid.calendaring.DateTimeList | sourceDateList | the dates to convert | 
| Return | osid.calendaring.DateTimeList | the resulting dates | |
| Errors | INVALID_ARGUMENT |  sourceDate.getCalendarType() != getSourceCalendarType()  or 
 sourceDate.getTimeType() != getSourceTimeType()   |                 |
| NULL_ARGUMENT |  sourceDateList  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |