org.osid.course.registration

Interface CourseRegistrationProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

CourseRegistrationManager, CourseRegistrationProxyManager

public interface CourseRegistrationProfile
extends OsidProfile

The course registration profile describes the interoperability among course registration services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getActivityBundleRecordTypes() Gets the supported ActivityBundle record types.
TypeList	getActivityBundleSearchRecordTypes() Gets the supported ActivityBundle search record types.
TypeList	getActivityRegistrationRecordTypes() Gets the supported ActivityRegistration record types.
TypeList	getActivityRegistrationSearchRecordTypes() Gets the supported ActivityRegistration search record types.
TypeList	getRegistrationRecordTypes() Gets the supported Registration record types.
TypeList	getRegistrationSearchRecordTypes() Gets the supported Registration search record types.
boolean	supportsActivityBundleAdmin() Tests if an activity bundle administrative service is supported.
boolean	supportsActivityBundleCourseCatalog() Tests if an activity bundle cataloging service is supported.
boolean	supportsActivityBundleCourseCatalogAssignment() Tests if an activity bundle cataloging service is supported.
boolean	supportsActivityBundleLookup() Tests if looking up activity bundles is supported.
boolean	supportsActivityBundleNotification() Tests if an activity bundle notification service is supported.
boolean	supportsActivityBundleQuery() Tests if querying activity bundles is supported.
boolean	supportsActivityBundleRecordType(Type activityBundleRecordType) Tests if the given ActivityBundle record type is supported.
boolean	supportsActivityBundleSearch() Tests if searching activity bundles is supported.
boolean	supportsActivityBundleSearchRecordType(Type activityBundleSearchRecordType) Tests if the given ActivityBundle search record type is supported.
boolean	supportsActivityBundleSmartCourseCatalog() Tests if an activity bundle smart course catalog session is available.
boolean	supportsActivityRegistrationAdmin() Tests if an activity registration administrative service is supported.
boolean	supportsActivityRegistrationCourseCatalog() Tests if an activity registration cataloging service is supported.
boolean	supportsActivityRegistrationCourseCatalogAssignment() Tests if an activity registration cataloging service is supported.
boolean	supportsActivityRegistrationLookup() Tests if looking up activity registrations is supported.
boolean	supportsActivityRegistrationNotification() Tests if an activity registration notification service is supported.
boolean	supportsActivityRegistrationQuery() Tests if querying activity registrations is supported.
boolean	supportsActivityRegistrationRecordType(Type activityRegistrationRecordType) Tests if the given ActivityRegistration record type is supported.
boolean	supportsActivityRegistrationSearch() Tests if searching activity registrations is supported.
boolean	supportsActivityRegistrationSearchRecordType(Type activityRegistrationSearchRecordType) Tests if the given ActivityRegistration search record type is supported.
boolean	supportsActivityRegistrationSmartCourseCatalog() Tests if an activity registration smart course catalog session is available.
boolean	supportsCourseRegistrationBatch() Tests if a course registration batch service is available.
boolean	supportsRegistrationAdmin() Tests if course offering administrative service is supported.
boolean	supportsRegistrationCourseCatalog() Tests if a registration cataloging service is supported.
boolean	supportsRegistrationCourseCatalogAssignment() Tests if a registration cataloging service is supported.
boolean	supportsRegistrationLookup() Tests if looking up registrations is supported.
boolean	supportsRegistrationNotification() Tests if a registration notification service is supported.
boolean	supportsRegistrationQuery() Tests if querying registrations is supported.
boolean	supportsRegistrationRecordType(Type registrationRecordType) Tests if the given Registration record type is supported.
boolean	supportsRegistrationSearch() Tests if searching registrations is supported.
boolean	supportsRegistrationSearchRecordType(Type registrationSearchRecordType) Tests if the given Registration search record type is supported.
boolean	supportsRegistrationSmartCourseCatalog() Tests if a registration smart course catalog session is available.
boolean	supportsVisibleFederation() Tests if any course catalog 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 course catalog federation is exposed. Federation is exposed when a specific course catalog may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleLookup

boolean supportsActivityBundleLookup()

Tests if looking up activity bundles is supported.

Returns:

true if activity bundle lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleQuery

boolean supportsActivityBundleQuery()

Tests if querying activity bundles is supported.

Returns:

true if activity bundle query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleSearch

boolean supportsActivityBundleSearch()

Tests if searching activity bundles is supported.

Returns:

true if activity bundle search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleAdmin

boolean supportsActivityBundleAdmin()

Tests if an activity bundle administrative service is supported.

Returns:

true if activity bundle administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleNotification

boolean supportsActivityBundleNotification()

Tests if an activity bundle notification service is supported.

Returns:

true if activity bundle notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleCourseCatalog

boolean supportsActivityBundleCourseCatalog()

Tests if an activity bundle cataloging service is supported.

Returns:

true if activity bundle catalog is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleCourseCatalogAssignment

boolean supportsActivityBundleCourseCatalogAssignment()

Tests if an activity bundle cataloging service is supported. A cataloging service maps activity bundles to catalogs.

Returns:

true if activity bundle cataloging is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleSmartCourseCatalog

boolean supportsActivityBundleSmartCourseCatalog()

Tests if an activity bundle smart course catalog session is available.

Returns:

true if an activity bundle smart course catalog session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRegistrationLookup

boolean supportsRegistrationLookup()

Tests if looking up registrations is supported.

Returns:

true if registration lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRegistrationQuery

boolean supportsRegistrationQuery()

Tests if querying registrations is supported.

Returns:

true if registration query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRegistrationSearch

boolean supportsRegistrationSearch()

Tests if searching registrations is supported.

Returns:

true if registration search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRegistrationAdmin

boolean supportsRegistrationAdmin()

Tests if course offering administrative service is supported.

Returns:

true if registration administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRegistrationNotification

boolean supportsRegistrationNotification()

Tests if a registration notification service is supported.

Returns:

true if registration notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRegistrationCourseCatalog

boolean supportsRegistrationCourseCatalog()

Tests if a registration cataloging service is supported.

Returns:

true if registration catalog is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRegistrationCourseCatalogAssignment

boolean supportsRegistrationCourseCatalogAssignment()

Tests if a registration cataloging service is supported. A cataloging service maps registrations to catalogs.

Returns:

true if registration cataloging is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRegistrationSmartCourseCatalog

boolean supportsRegistrationSmartCourseCatalog()

Tests if a registration smart course catalog session is available.

Returns:

true if a registration smart course catalog session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationLookup

boolean supportsActivityRegistrationLookup()

Tests if looking up activity registrations is supported.

Returns:

true if activity registration lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationQuery

boolean supportsActivityRegistrationQuery()

Tests if querying activity registrations is supported.

Returns:

true if activity registration query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationSearch

boolean supportsActivityRegistrationSearch()

Tests if searching activity registrations is supported.

Returns:

true if activity registration search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationAdmin

boolean supportsActivityRegistrationAdmin()

Tests if an activity registration administrative service is supported.

Returns:

true if activity registration administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationNotification

boolean supportsActivityRegistrationNotification()

Tests if an activity registration notification service is supported.

Returns:

true if activity registration notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationCourseCatalog

boolean supportsActivityRegistrationCourseCatalog()

Tests if an activity registration cataloging service is supported.

Returns:

true if activity registration catalog is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationCourseCatalogAssignment

boolean supportsActivityRegistrationCourseCatalogAssignment()

Tests if an activity registration cataloging service is supported. A cataloging service maps activity registrations to catalogs.

Returns:

true if activity registration cataloging is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationSmartCourseCatalog

boolean supportsActivityRegistrationSmartCourseCatalog()

Tests if an activity registration smart course catalog session is available.

Returns:

true if an activity registration smart course catalog session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCourseRegistrationBatch

boolean supportsCourseRegistrationBatch()

Tests if a course registration batch service is available.

Returns:

true if a course registration service session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityBundleRecordTypes

TypeList getActivityBundleRecordTypes()

Gets the supported ActivityBundle record types.

Returns:

a list containing the supported ActivityBundle record types

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleRecordType

boolean supportsActivityBundleRecordType(Type activityBundleRecordType)

Tests if the given ActivityBundle record type is supported.

Parameters:

activityBundleRecordType - a Type indicating an ActivityBundle record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - activityBundleRecordType is null

Compliance:

mandatory - This method must be implemented.

getActivityBundleSearchRecordTypes

TypeList getActivityBundleSearchRecordTypes()

Gets the supported ActivityBundle search record types.

Returns:

a list containing the supported ActivityBundle search record types

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleSearchRecordType

boolean supportsActivityBundleSearchRecordType(Type activityBundleSearchRecordType)

Tests if the given ActivityBundle search record type is supported.

Parameters:

activityBundleSearchRecordType - a Type indicating an ActivityBundle search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - activityBundleSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getRegistrationRecordTypes

TypeList getRegistrationRecordTypes()

Gets the supported Registration record types.

Returns:

a list containing the supported Registration record types

Compliance:

mandatory - This method must be implemented.

supportsRegistrationRecordType

boolean supportsRegistrationRecordType(Type registrationRecordType)

Tests if the given Registration record type is supported.

Parameters:

registrationRecordType - a Type indicating an Registration record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - registrationRecordType is null

Compliance:

mandatory - This method must be implemented.

getRegistrationSearchRecordTypes

TypeList getRegistrationSearchRecordTypes()

Gets the supported Registration search record types.

Returns:

a list containing the supported Registration search record types

Compliance:

mandatory - This method must be implemented.

supportsRegistrationSearchRecordType

boolean supportsRegistrationSearchRecordType(Type registrationSearchRecordType)

Tests if the given Registration search record type is supported.

Parameters:

registrationSearchRecordType - a Type indicating an Registration search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - registrationSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationRecordTypes

TypeList getActivityRegistrationRecordTypes()

Gets the supported ActivityRegistration record types.

Returns:

a list containing the supported ActivityRegistration record types

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationRecordType

boolean supportsActivityRegistrationRecordType(Type activityRegistrationRecordType)

Tests if the given ActivityRegistration record type is supported.

Parameters:

activityRegistrationRecordType - a Type indicating an ActivityRegistration record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - activityRegistrationRecordType is null

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationSearchRecordTypes

TypeList getActivityRegistrationSearchRecordTypes()

Gets the supported ActivityRegistration search record types.

Returns:

a list containing the supported ActivityRegistration search record types

Compliance:

mandatory - This method must be implemented.

supportsActivityRegistrationSearchRecordType

boolean supportsActivityRegistrationSearchRecordType(Type activityRegistrationSearchRecordType)

Tests if the given ActivityRegistration search record type is supported.

Parameters:

activityRegistrationSearchRecordType - a Type indicating an ActivityRegistration search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - activityRegistrationSearchRecordType is null

Compliance:

mandatory - This method must be implemented.