Interface RegistrationRequestProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
RegistrationRequestManager, RegistrationRequestProxyManager

public interface RegistrationRequestProfile extends OsidProfile

The course registration.request profile describes the interoperability among course.registration.request 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 course catalogs appears as a single course catalog.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestLookup

      boolean supportsRegistrationRequestLookup()
      Tests if looking up registration requests is supported.
      Returns:
      true if registration request lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestQuery

      boolean supportsRegistrationRequestQuery()
      Tests if querying registration requests is supported.
      Returns:
      true if registration request query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestSearch

      boolean supportsRegistrationRequestSearch()
      Tests if searching registration requests is supported.
      Returns:
      true if registration request search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestAdmin

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

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

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

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

      boolean supportsRegistrationRequestSmartCourseCatalog()
      Tests if a registration request 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.
    • supportsRegistrationRequestItemLookup

      boolean supportsRegistrationRequestItemLookup()
      Tests if looking up registration request items is supported.
      Returns:
      true if registration request item lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestItemQuery

      boolean supportsRegistrationRequestItemQuery()
      Tests if querying registration request items is supported.
      Returns:
      true if registration request item query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestItemSearch

      boolean supportsRegistrationRequestItemSearch()
      Tests if searching registration request items is supported.
      Returns:
      true if registration request item search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestItemAdmin

      boolean supportsRegistrationRequestItemAdmin()
      Tests if a registration request item administrative service is supported.
      Returns:
      true if registration request item administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestItemNotification

      boolean supportsRegistrationRequestItemNotification()
      Tests if a registration request item notification service is supported.
      Returns:
      true if registration request item notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestItemCourseCatalog

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

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

      boolean supportsRegistrationRequestItemSmartCourseCatalog()
      Tests if a registration request item 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.
    • getRegistrationRequestRecordTypes

      TypeList getRegistrationRequestRecordTypes()
      Gets the supported RegistrationRequest record types.
      Returns:
      a list containing the supported RegistrationRequest record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestRecordType

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

      TypeList getRegistrationRequestSearchRecordTypes()
      Gets the supported RegistrationRequest search types.
      Returns:
      a list containing the supported RegistrationRequest search types
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestSearchRecordType

      boolean supportsRegistrationRequestSearchRecordType(Type registrationRequestSearchRecordType)
      Tests if the given RegistrationRequest search type is supported.
      Parameters:
      registrationRequestSearchRecordType - a Type indicating a RegistrationRequest search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - registrationRequestSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.
    • getRegistrationRequestItemRecordTypes

      TypeList getRegistrationRequestItemRecordTypes()
      Gets the supported RegistrationRequestItem record types.
      Returns:
      a list containing the supported RegistrationRequestItem record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestItemRecordType

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

      TypeList getRegistrationRequestItemSearchRecordTypes()
      Gets the supported RegistrationRequestItem search types.
      Returns:
      a list containing the supported RegistrationRequestItem search types
      Compliance:
      mandatory - This method must be implemented.
    • supportsRegistrationRequestItemSearchRecordType

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