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 Details

    • 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.

    • supportsRegistrationTargetLookup

      boolean supportsRegistrationTargetLookup()
      Tests if looking up registration targets is supported.
      Returns:
      true if registration target lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetQuery

      boolean supportsRegistrationTargetQuery()
      Tests if querying registration targets is supported.
      Returns:
      true if registration target query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetSearch

      boolean supportsRegistrationTargetSearch()
      Tests if searching registration targets is supported.
      Returns:
      true if registration target search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetAdmin

      boolean supportsRegistrationTargetAdmin()
      Tests if a registration target administrative service is supported.
      Returns:
      true if registration target administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetNotification

      boolean supportsRegistrationTargetNotification()
      Tests if a registration target notification service is supported.
      Returns:
      true if registration target notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetCourseCatalog

      boolean supportsRegistrationTargetCourseCatalog()
      Tests if a registration target course catalog lookup service is supported.
      Returns:
      true if a registration target course catalog lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetCourseCatalogAssignment

      boolean supportsRegistrationTargetCourseCatalogAssignment()
      Tests if a registration target course catalog assignment service is supported.
      Returns:
      true if a registration target to course catalog assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetSmartCourseCatalog

      boolean supportsRegistrationTargetSmartCourseCatalog()
      Tests if a registration target smart course catalog service is supported.
      Returns:
      true if a smart course catalog service 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.

    • supportsCourseRegistrationLookup

      boolean supportsCourseRegistrationLookup()
      Tests if looking up course registrations is supported.
      Returns:
      true if course registration lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationQuery

      boolean supportsCourseRegistrationQuery()
      Tests if querying course registrations is supported.
      Returns:
      true if course registration query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationSearch

      boolean supportsCourseRegistrationSearch()
      Tests if searching course registrations is supported.
      Returns:
      true if course registration search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationAdmin

      boolean supportsCourseRegistrationAdmin()
      Tests if a course registration administrative service is supported.
      Returns:
      true if course registration administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationNotification

      boolean supportsCourseRegistrationNotification()
      Tests if a course registration notification service is supported.
      Returns:
      true if course registration notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationCourseCatalog

      boolean supportsCourseRegistrationCourseCatalog()
      Tests if a course registration course catalog lookup service is supported.
      Returns:
      true if a course registration course catalog lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationCourseCatalogAssignment

      boolean supportsCourseRegistrationCourseCatalogAssignment()
      Tests if a course registration course catalog assignment service is supported.
      Returns:
      true if a course registration to course catalog assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationSmartCourseCatalog

      boolean supportsCourseRegistrationSmartCourseCatalog()
      Tests if a course registration smart course catalog service is supported.
      Returns:
      true if a smart course catalog service 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 batch service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationRequest

      boolean supportsRegistrationRequest()
      Tests if a course registration request service is available.
      Returns:
      true if a course registration request service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetRecordTypes

      TypeList getRegistrationTargetRecordTypes()
      Gets the supported RegistrationTarget record types.
      Returns:
      a list containing the supported RegistrationTarget record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetRecordType

      boolean supportsRegistrationTargetRecordType(Type registrationTargetRecordType)
      Tests if the given RegistrationTarget record type is supported.
      Parameters:
      registrationTargetRecordType - a Type indicating a RegistrationTarget record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - registrationTargetRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetSearchRecordTypes

      TypeList getRegistrationTargetSearchRecordTypes()
      Gets the supported RegistrationTarget search types.
      Returns:
      a list containing the supported RegistrationTarget search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationTargetSearchRecordType

      boolean supportsRegistrationTargetSearchRecordType(Type registrationTargetSearchRecordType)
      Tests if the given RegistrationTarget search type is supported.
      Parameters:
      registrationTargetSearchRecordType - a Type indicating a RegistrationTarget search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - registrationTargetSearchRecordType 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.

    • getCourseRegistrationRecordTypes

      TypeList getCourseRegistrationRecordTypes()
      Gets the supported CourseRegistration record types.
      Returns:
      a list containing the supported CourseRegistration record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationRecordType

      boolean supportsCourseRegistrationRecordType(Type courseRegistrationRecordType)
      Tests if the given CourseRegistration record type is supported.
      Parameters:
      courseRegistrationRecordType - a Type indicating a CourseRegistration record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - courseRegistrationRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationSearchRecordTypes

      TypeList getCourseRegistrationSearchRecordTypes()
      Gets the supported CourseRegistration search types.
      Returns:
      a list containing the supported CourseRegistration search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseRegistrationSearchRecordType

      boolean supportsCourseRegistrationSearchRecordType(Type courseRegistrationSearchRecordType)
      Tests if the given CourseRegistration search type is supported.
      Parameters:
      courseRegistrationSearchRecordType - a Type indicating a CourseRegistration search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - courseRegistrationSearchRecordType is null
      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.