org.osid.recognition

Interface RecognitionProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

RecognitionManager, RecognitionProxyManager

public interface RecognitionProfile
extends OsidProfile

The recognition profile describes the interoperability among recognition services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getAcademyRecordTypes() Gets the supported academy record types.
TypeList	getAcademySearchRecordTypes() Gets the supported academy search record types.
TypeList	getAwardRecordTypes() Gets the supported Award record types.
TypeList	getAwardSearchRecordTypes() Gets the supported award search record types.
TypeList	getConferralRecordTypes() Gets the supported Conferral record types.
TypeList	getConferralSearchRecordTypes() Gets the supported conferral search record types.
TypeList	getConvocationRecordTypes() Gets the supported Convocation record types.
TypeList	getConvocationSearchRecordTypes() Gets the supported convocation search record types.
boolean	supportsAcademyAdmin() Tests for the availability of an academy administrative service for creating and deleting academies.
boolean	supportsAcademyHierarchy() Tests for the availability of an academy hierarchy traversal service.
boolean	supportsAcademyHierarchyDesign() Tests for the availability of an academy hierarchy design service.
boolean	supportsAcademyLookup() Tests for the availability of an academy lookup service.
boolean	supportsAcademyNotification() Tests for the availability of an academy notification service.
boolean	supportsAcademyQuery() Tests if querying academies is available.
boolean	supportsAcademyRecordType(Type academyRecordType) Tests if the given academy record type is supported.
boolean	supportsAcademySearch() Tests if searching for academies is available.
boolean	supportsAcademySearchRecordType(Type academySearchRecordType) Tests if the given academy search record type is supported.
boolean	supportsAwardAcademy() Tests if an award to academy lookup session is available.
boolean	supportsAwardAcademyAssignment() Tests if an award to academy assignment session is available.
boolean	supportsAwardAdmin() Tests for the availability of an award administrative service for creating and deleting awards.
boolean	supportsAwardLookup() Tests for the availability of an award lookup service.
boolean	supportsAwardNotification() Tests for the availability of an award notification service.
boolean	supportsAwardQuery() Tests if querying awards is available.
boolean	supportsAwardRecordType(Type awardRecordType) Tests if the given Award record type is supported.
boolean	supportsAwardSearch() Tests if searching for awards is available.
boolean	supportsAwardSearchRecordType(Type awardSearchRecordType) Tests if the given award search record type is supported.
boolean	supportsAwardSmartAcademy() Tests if an award smart academy session is available.
boolean	supportsConferralAcademy() Tests if a conferral to academy lookup session is available.
boolean	supportsConferralAcademyAssignment() Tests if a conferral to academy assignment session is available.
boolean	supportsConferralAdmin() Tests if searching for conferrals is available.
boolean	supportsConferralLookup() Tests for the availability of a conferral lookup service.
boolean	supportsConferralNotification() Tests if conferral notification is available.
boolean	supportsConferralQuery() Tests if querying conferrals is available.
boolean	supportsConferralRecordType(Type conferralRecordType) Tests if the given Conferral record type is supported.
boolean	supportsConferralSearch() Tests if searching for conferrals is available.
boolean	supportsConferralSearchRecordType(Type conferralSearchRecordType) Tests if the given conferral search record type is supported.
boolean	supportsConferralSmartAcademy() Tests if a conferral smart academy session is available.
boolean	supportsConvocation() Tests for the availability of a convocation service for getting available convocations for a resource.
boolean	supportsConvocationAcademy() Tests if a convocation to academy lookup session is available.
boolean	supportsConvocationAcademyAssignment() Tests if a convocation to academy assignment session is available.
boolean	supportsConvocationAdmin() Tests if searching for convocations is available.
boolean	supportsConvocationLookup() Tests for the availability of a convocation lookup service.
boolean	supportsConvocationNotification() Tests if convocation notification is available.
boolean	supportsConvocationQuery() Tests if querying convocations is available.
boolean	supportsConvocationRecordType(Type convocationRecordType) Tests if the given Convocation record type is supported.
boolean	supportsConvocationSearch() Tests if searching for convocations is available.
boolean	supportsConvocationSearchRecordType(Type convocationSearchRecordType) Tests if the given convocation search record type is supported.
boolean	supportsConvocationSmartAcademy() Tests if a convocation smart academy session is available.
boolean	supportsRecognitionBatch() Tests for the availability of a recognition batch service.
boolean	supportsVisibleFederation() Tests if any award federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConferralLookup

boolean supportsConferralLookup()

Tests for the availability of a conferral lookup service.

Returns:

true if conferral lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConferralQuery

boolean supportsConferralQuery()

Tests if querying conferrals is available.

Returns:

true if conferral query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConferralSearch

boolean supportsConferralSearch()

Tests if searching for conferrals is available.

Returns:

true if conferral search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConferralAdmin

boolean supportsConferralAdmin()

Tests if searching for conferrals is available.

Returns:

true if conferral search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConferralNotification

boolean supportsConferralNotification()

Tests if conferral notification is available.

Returns:

true if conferral notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConferralAcademy

boolean supportsConferralAcademy()

Tests if a conferral to academy lookup session is available.

Returns:

true if conferral academy lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConferralAcademyAssignment

boolean supportsConferralAcademyAssignment()

Tests if a conferral to academy assignment session is available.

Returns:

true if conferral academy assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConferralSmartAcademy

boolean supportsConferralSmartAcademy()

Tests if a conferral smart academy session is available.

Returns:

true if conferral smart academy is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAwardLookup

boolean supportsAwardLookup()

Tests for the availability of an award lookup service.

Returns:

true if award lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAwardQuery

boolean supportsAwardQuery()

Tests if querying awards is available.

Returns:

true if award query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAwardSearch

boolean supportsAwardSearch()

Tests if searching for awards is available.

Returns:

true if award search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAwardAdmin

boolean supportsAwardAdmin()

Tests for the availability of an award administrative service for creating and deleting awards.

Returns:

true if award administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAwardNotification

boolean supportsAwardNotification()

Tests for the availability of an award notification service.

Returns:

true if award notification is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsAwardAcademy

boolean supportsAwardAcademy()

Tests if an award to academy lookup session is available.

Returns:

true if award academy lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAwardAcademyAssignment

boolean supportsAwardAcademyAssignment()

Tests if an award to academy assignment session is available.

Returns:

true if award academy assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAwardSmartAcademy

boolean supportsAwardSmartAcademy()

Tests if an award smart academy session is available.

Returns:

true if award smart academy is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocation

boolean supportsConvocation()

Tests for the availability of a convocation service for getting available convocations for a resource.

Returns:

true if convocation is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocationLookup

boolean supportsConvocationLookup()

Tests for the availability of a convocation lookup service.

Returns:

true if convocation lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocationQuery

boolean supportsConvocationQuery()

Tests if querying convocations is available.

Returns:

true if convocation query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocationSearch

boolean supportsConvocationSearch()

Tests if searching for convocations is available.

Returns:

true if convocation search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocationAdmin

boolean supportsConvocationAdmin()

Tests if searching for convocations is available.

Returns:

true if convocation search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocationNotification

boolean supportsConvocationNotification()

Tests if convocation notification is available.

Returns:

true if convocation notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocationAcademy

boolean supportsConvocationAcademy()

Tests if a convocation to academy lookup session is available.

Returns:

true if convocation academy lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocationAcademyAssignment

boolean supportsConvocationAcademyAssignment()

Tests if a convocation to academy assignment session is available.

Returns:

true if convocation academy assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsConvocationSmartAcademy

boolean supportsConvocationSmartAcademy()

Tests if a convocation smart academy session is available.

Returns:

true if convocation smart academy is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAcademyLookup

boolean supportsAcademyLookup()

Tests for the availability of an academy lookup service.

Returns:

true if academy lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAcademyQuery

boolean supportsAcademyQuery()

Tests if querying academies is available.

Returns:

true if academy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAcademySearch

boolean supportsAcademySearch()

Tests if searching for academies is available.

Returns:

true if academy search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAcademyAdmin

boolean supportsAcademyAdmin()

Tests for the availability of an academy administrative service for creating and deleting academies.

Returns:

true if academy administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAcademyNotification

boolean supportsAcademyNotification()

Tests for the availability of an academy notification service.

Returns:

true if academy notification is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsAcademyHierarchy

boolean supportsAcademyHierarchy()

Tests for the availability of an academy hierarchy traversal service.

Returns:

true if academy hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAcademyHierarchyDesign

boolean supportsAcademyHierarchyDesign()

Tests for the availability of an academy hierarchy design service.

Returns:

true if academy hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsRecognitionBatch

boolean supportsRecognitionBatch()

Tests for the availability of a recognition batch service.

Returns:

true if a recognition batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getConferralRecordTypes

TypeList getConferralRecordTypes()

Gets the supported Conferral record types.

Returns:

a list containing the supported conferral record types

Compliance:

mandatory - This method must be implemented.

supportsConferralRecordType

boolean supportsConferralRecordType(Type conferralRecordType)

Tests if the given Conferral record type is supported.

Parameters:

conferralRecordType - a Type indicating a Conferral record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - conferralRecordType is null

Compliance:

mandatory - This method must be implemented.

getConferralSearchRecordTypes

TypeList getConferralSearchRecordTypes()

Gets the supported conferral search record types.

Returns:

a list containing the supported conferral search record types

Compliance:

mandatory - This method must be implemented.

supportsConferralSearchRecordType

boolean supportsConferralSearchRecordType(Type conferralSearchRecordType)

Tests if the given conferral search record type is supported.

Parameters:

conferralSearchRecordType - a Type indicating a conferral record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - conferralSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getAwardRecordTypes

TypeList getAwardRecordTypes()

Gets the supported Award record types.

Returns:

a list containing the supported award record types

Compliance:

mandatory - This method must be implemented.

supportsAwardRecordType

boolean supportsAwardRecordType(Type awardRecordType)

Tests if the given Award record type is supported.

Parameters:

awardRecordType - a Type indicating a Award record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - awardRecordType is null

Compliance:

mandatory - This method must be implemented.

getAwardSearchRecordTypes

TypeList getAwardSearchRecordTypes()

Gets the supported award search record types.

Returns:

a list containing the supported award search record types

Compliance:

mandatory - This method must be implemented.

supportsAwardSearchRecordType

boolean supportsAwardSearchRecordType(Type awardSearchRecordType)

Tests if the given award search record type is supported.

Parameters:

awardSearchRecordType - a Type indicating an award record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - awardSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getConvocationRecordTypes

TypeList getConvocationRecordTypes()

Gets the supported Convocation record types.

Returns:

a list containing the supported convocation record types

Compliance:

mandatory - This method must be implemented.

supportsConvocationRecordType

boolean supportsConvocationRecordType(Type convocationRecordType)

Tests if the given Convocation record type is supported.

Parameters:

convocationRecordType - a Type indicating a Convocation record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - convocationRecordType is null

Compliance:

mandatory - This method must be implemented.

getConvocationSearchRecordTypes

TypeList getConvocationSearchRecordTypes()

Gets the supported convocation search record types.

Returns:

a list containing the supported convocation search record types

Compliance:

mandatory - This method must be implemented.

supportsConvocationSearchRecordType

boolean supportsConvocationSearchRecordType(Type convocationSearchRecordType)

Tests if the given convocation search record type is supported.

Parameters:

convocationSearchRecordType - a Type indicating a convocation record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - convocationSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getAcademyRecordTypes

TypeList getAcademyRecordTypes()

Gets the supported academy record types.

Returns:

a list containing the supported academy record types

Compliance:

mandatory - This method must be implemented.

supportsAcademyRecordType

boolean supportsAcademyRecordType(Type academyRecordType)

Tests if the given academy record type is supported.

Parameters:

academyRecordType - a Type indicating an academy record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - academyRecordType is null

Compliance:

mandatory - This method must be implemented.

getAcademySearchRecordTypes

TypeList getAcademySearchRecordTypes()

Gets the supported academy search record types.

Returns:

a list containing the supported academy search record types

Compliance:

mandatory - This method must be implemented.

supportsAcademySearchRecordType

boolean supportsAcademySearchRecordType(Type academySearchRecordType)

Tests if the given academy search record type is supported.

Parameters:

academySearchRecordType - a Type indicating an academy record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - academySearchRecordType is null

Compliance:

mandatory - This method must be implemented.