OSID - osid.recognition.RecognitionProfile Service Interface Definition

Interface	osid.recognition.RecognitionProfile
Implements	`osid.OsidProfile`
Description	The recognition profile describes the interoperability among recognition services.
Method	supportsVisibleFederation
Description	Tests if any award federation is exposed. Federation is exposed when a specific award may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of awards appears as a single award.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralLookup
Description	Tests for the availability of a conferral lookup service.
Return	`boolean`		`true` if conferral lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralQuery
Description	Tests if querying conferrals is available.
Return	`boolean`		`true` if conferral query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralSearch
Description	Tests if searching for conferrals is available.
Return	`boolean`		`true` if conferral search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralAdmin
Description	Tests if searching for conferrals is available.
Return	`boolean`		`true` if conferral search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralNotification
Description	Tests if conferral notification is available.
Return	`boolean`		`true` if conferral notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralAcademy
Description	Tests if a conferral to academy lookup session is available.
Return	`boolean`		`true` if conferral academy lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralAcademyAssignment
Description	Tests if a conferral to academy assignment session is available.
Return	`boolean`		`true` if conferral academy assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralSmartAcademy
Description	Tests if a conferral smart academy session is available.
Return	`boolean`		`true` if conferral smart academy is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardLookup
Description	Tests for the availability of an award lookup service.
Return	`boolean`		`true` if award lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardQuery
Description	Tests if querying awards is available.
Return	`boolean`		`true` if award query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardSearch
Description	Tests if searching for awards is available.
Return	`boolean`		`true` if award search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardAdmin
Description	Tests for the availability of an award administrative service for creating and deleting awards.
Return	`boolean`		`true` if award administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardNotification
Description	Tests for the availability of an award notification service.
Return	`boolean`		`true` if award notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsAwardAcademy
Description	Tests if an award to academy lookup session is available.
Return	`boolean`		`true` if award academy lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardAcademyAssignment
Description	Tests if an award to academy assignment session is available.
Return	`boolean`		`true` if award academy assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardSmartAcademy
Description	Tests if an award smart academy session is available.
Return	`boolean`		`true` if award smart academy is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocation
Description	Tests for the availability of a convocation service for getting available convocations for a resource.
Return	`boolean`		`true` if convocation is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationLookup
Description	Tests for the availability of a convocation lookup service.
Return	`boolean`		`true` if convocation lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationQuery
Description	Tests if querying convocations is available.
Return	`boolean`		`true` if convocation query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationSearch
Description	Tests if searching for convocations is available.
Return	`boolean`		`true` if convocation search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationAdmin
Description	Tests if searching for convocations is available.
Return	`boolean`		`true` if convocation search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationNotification
Description	Tests if convocation notification is available.
Return	`boolean`		`true` if convocation notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationAcademy
Description	Tests if a convocation to academy lookup session is available.
Return	`boolean`		`true` if convocation academy lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationAcademyAssignment
Description	Tests if a convocation to academy assignment session is available.
Return	`boolean`		`true` if convocation academy assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationSmartAcademy
Description	Tests if a convocation smart academy session is available.
Return	`boolean`		`true` if convocation smart academy is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademyLookup
Description	Tests for the availability of an academy lookup service.
Return	`boolean`		`true` if academy lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademyQuery
Description	Tests if querying academies is available.
Return	`boolean`		`true` if academy query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademySearch
Description	Tests if searching for academies is available.
Return	`boolean`		`true` if academy search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademyAdmin
Description	Tests for the availability of an academy administrative service for creating and deleting academies.
Return	`boolean`		`true` if academy administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademyNotification
Description	Tests for the availability of an academy notification service.
Return	`boolean`		`true` if academy notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsAcademyHierarchy
Description	Tests for the availability of an academy hierarchy traversal service.
Return	`boolean`		`true` if academy hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademyHierarchyDesign
Description	Tests for the availability of an academy hierarchy design service.
Return	`boolean`		`true` if academy hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsRecognitionBatch
Description	Tests for the availability of a recognition batch service.
Return	`boolean`		`true` if a recognition batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getConferralRecordTypes
Description	Gets the supported `Conferral` record types.
Return	`osid.type.TypeList`		a list containing the supported conferral record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralRecordType
Description	Tests if the given `Conferral` record type is supported.
Parameters	`osid.type.Type`	`conferralRecordType`	a `Type` indicating a `Conferral` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`conferralRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getConferralSearchRecordTypes
Description	Gets the supported conferral search record types.
Return	`osid.type.TypeList`		a list containing the supported conferral search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralSearchRecordType
Description	Tests if the given conferral search record type is supported.
Parameters	`osid.type.Type`	`conferralSearchRecordType`	a `Type` indicating a conferral record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`conferralSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardRecordTypes
Description	Gets the supported `Award` record types.
Return	`osid.type.TypeList`		a list containing the supported award record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardRecordType
Description	Tests if the given `Award` record type is supported.
Parameters	`osid.type.Type`	`awardRecordType`	a `Type` indicating a `Award` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`awardRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardSearchRecordTypes
Description	Gets the supported award search record types.
Return	`osid.type.TypeList`		a list containing the supported award search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardSearchRecordType
Description	Tests if the given award search record type is supported.
Parameters	`osid.type.Type`	`awardSearchRecordType`	a `Type` indicating an award record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`awardSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationRecordTypes
Description	Gets the supported `Convocation` record types.
Return	`osid.type.TypeList`		a list containing the supported convocation record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationRecordType
Description	Tests if the given `Convocation` record type is supported.
Parameters	`osid.type.Type`	`convocationRecordType`	a `Type` indicating a `Convocation` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`convocationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationSearchRecordTypes
Description	Gets the supported convocation search record types.
Return	`osid.type.TypeList`		a list containing the supported convocation search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsConvocationSearchRecordType
Description	Tests if the given convocation search record type is supported.
Parameters	`osid.type.Type`	`convocationSearchRecordType`	a `Type` indicating a convocation record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`convocationSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAcademyRecordTypes
Description	Gets the supported academy record types.
Return	`osid.type.TypeList`		a list containing the supported academy record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademyRecordType
Description	Tests if the given academy record type is supported.
Parameters	`osid.type.Type`	`academyRecordType`	a `Type` indicating an academy record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`academyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAcademySearchRecordTypes
Description	Gets the supported academy search record types.
Return	`osid.type.TypeList`		a list containing the supported academy search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademySearchRecordType
Description	Tests if the given academy search record type is supported.
Parameters	`osid.type.Type`	`academySearchRecordType`	a `Type` indicating an academy record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`academySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.