Interface | osid.recognition.ConvocationLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving convocations. This lookup session defines several views:
The methods | ||
Method | getAcademyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Academy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAcademy | ||
Description |
Gets the | ||
Return | osid.recognition.Academy | the academy | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupConvocations | ||
Description |
Tests if this user can lookup convocations. 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 convocation lookup methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeConvocationView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryConvocationView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedAcademyView | ||
Description |
Federates the view for methods in this session. A federated view will include convocations in academies which are children of this academy in the academy hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedAcademyView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveConvocationView | ||
Description |
Only active convocations are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusConvocationView | ||
Description |
All convocations of any status are returned by all methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getConvocation | ||
Description |
Gets the | ||
Parameters | osid.id.Id | convocationId | the Id of the Convocation to retrieve |
Return | osid.recognition.Convocation | the returned Convocation | |
Errors | NOT_FOUND | no Convocation found with the given Id | |
NULL_ARGUMENT | convocationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | convocationIds | the list of Ids to retrieve |
Return | osid.recognition.ConvocationList | the returned Convocation list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | convocationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | convocationGenusType | a convocation genus type |
Return | osid.recognition.ConvocationList | the returned Convocation list | |
Errors | NULL_ARGUMENT | convocationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | convocationGenusType | a convocation genus type |
Return | osid.recognition.ConvocationList | the returned Convocation list | |
Errors | NULL_ARGUMENT | convocationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | convocationRecordType | a convocation record type |
Return | osid.recognition.ConvocationList | the returned Convocation list | |
Errors | NULL_ARGUMENT | convocationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByDate | ||
Description |
Gets a list of convocations with a date within the given date range inclusive. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session. | ||
Parameters | osid.calendaring.DateTime | from | the starting date |
osid.calendaring.DateTime | to | the ending date | |
Return | osid.recognition.ConvocationList | the returned ConvocationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByAward | ||
Description |
Gets a list of all convocations corresponding to an
award | ||
Parameters | osid.id.Id | awardId | the Id of the award |
Return | osid.recognition.ConvocationList | the returned ConvocationList | |
Errors | NULL_ARGUMENT | awardId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByTimePeriod | ||
Description |
Gets a list of all convocations corresponding to a time
period | ||
Parameters | osid.id.Id | timePeriodId | the Id of the time period |
Return | osid.recognition.ConvocationList | the returned ConvocationList | |
Errors | NULL_ARGUMENT | timePeriod is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationsByProvider | ||
Description |
Gets a list of all convocations for a given provider. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
Return | osid.recognition.ConvocationList | the returned ConvocationList | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConvocations | ||
Description |
Gets all convocations. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session. | ||
Return | osid.recognition.ConvocationList | a list of convocations | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |