OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConvocationLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving convocations.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated academy view: All convocation methods in this session operate, retrieve and pertain to convocations defined explicitly in the current academy. Using an isolated view is useful for managing convocations with the ConvocationAdminSession.
  • federated academy view: All convocation lookup methods in this session operate, retrieve and pertain to all convocations defined in this academy and any other academies implicitly available in this academy through academy inheritence.
  • active convocation view: All convocation lookup methods return convocations where the convocation is active.
  • any status convocation view: Convocations of any status are returned.

The methods useFederatedAcademyView() and useIsolatedAcademyView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetAcademyId
Description

Gets the Academy Id associated with this session.

Returnosid.id.Idthe Academy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAcademy
Description

Gets the Academy associated with this session.

Returnosid.recognition.Academythe academy
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupConvocations
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations.

Returnboolean false if convocation lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeConvocationView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryConvocationView
Description

A complete view of the Convocation returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedAcademyView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAcademyView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveConvocationView
Description

Only active convocations are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusConvocationView
Description

All convocations of any status are returned by all methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetConvocation
Description

Gets the Convocation specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Convocation may have a different Id than requested, such as the case where a duplicate Id was assigned to a Convocation and retained for compatibility.

Parametersosid.id.IdconvocationIdthe Id of the Convocation to retrieve
Returnosid.recognition.Convocationthe returned Convocation
ErrorsNOT_FOUNDno Convocation found with the given Id
NULL_ARGUMENT convocationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByIds
Description

Gets a ConvocationList corresponding to the given IdList. In plenary mode, the returned list contains all of the convocations specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible convocations may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListconvocationIdsthe list of Ids to retrieve
Returnosid.recognition.ConvocationListthe returned Convocation list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT convocationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByGenusType
Description

Gets a ConvocationList corresponding to the given convocation genus Type which does not include convocations of genus types derived from the specified Type. 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.

Parametersosid.type.TypeconvocationGenusTypea convocation genus type
Returnosid.recognition.ConvocationListthe returned Convocation list
ErrorsNULL_ARGUMENT convocationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByParentGenusType
Description

Gets a ConvocationList corresponding to the given convocation genus Type and include any additional convocations with genus types derived from the specified Type. 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.

Parametersosid.type.TypeconvocationGenusTypea convocation genus type
Returnosid.recognition.ConvocationListthe returned Convocation list
ErrorsNULL_ARGUMENT convocationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByRecordType
Description

Gets a ConvocationList containing the given convocation record Type. 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.

Parametersosid.type.TypeconvocationRecordTypea convocation record type
Returnosid.recognition.ConvocationListthe returned Convocation list
ErrorsNULL_ARGUMENT convocationRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByDate
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.

Parametersosid.calendaring.DateTimefromthe starting date
osid.calendaring.DateTimetothe ending date
Returnosid.recognition.ConvocationListthe returned ConvocationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByAward
Description

Gets a list of all convocations corresponding to an award Id. 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.

Parametersosid.id.IdawardIdthe Id of the award
Returnosid.recognition.ConvocationListthe returned ConvocationList
ErrorsNULL_ARGUMENT awardId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByTimePeriod
Description

Gets a list of all convocations corresponding to a time period Id. 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.

Parametersosid.id.IdtimePeriodIdthe Id of the time period
Returnosid.recognition.ConvocationListthe returned ConvocationList
ErrorsNULL_ARGUMENT timePeriod is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByProvider
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.

Parametersosid.id.IdresourceIdthe Id of the resource
Returnosid.recognition.ConvocationListthe returned ConvocationList
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocations
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.

Returnosid.recognition.ConvocationLista list of convocations
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.