Interface CourseRequisiteProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
CourseRequisiteManager, CourseRequisiteProxyManager
public interface CourseRequisiteProfile extends OsidProfile

The course requisite profile describes the interoperability among course requisite 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.

    • supportsRequisiteLookup

      boolean supportsRequisiteLookup()
      Tests if looking up requisites is supported.
      Returns:
      true if requisite lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequisiteQuery

      boolean supportsRequisiteQuery()
      Tests if querying requisites is supported.
      Returns:
      true if requisite query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequisiteSearch

      boolean supportsRequisiteSearch()
      Tests if searching requisites is supported.
      Returns:
      true if requisite search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequisiteAdmin

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

    • supportsRequisiteNotification

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

    • supportsRequisiteCourseCatalog

      boolean supportsRequisiteCourseCatalog()
      Tests if a requisite cataloging service is supported.
      Returns:
      true if requisite cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequisiteCourseCatalogAssignment

      boolean supportsRequisiteCourseCatalogAssignment()
      Tests if a course cataloging service is supported. A course cataloging service maps requisites to catalogs.
      Returns:
      true if course cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRequisiteSmartCourseCatalog

      boolean supportsRequisiteSmartCourseCatalog()
      Tests if a requisite smart course catalog session is available.
      Returns:
      true if a requisite smart course catalog session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRequisiteRecordTypes

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

    • supportsRequisiteRecordType

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

    • getRequisiteSearchRecordTypes

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

    • supportsRequisiteSearchRecordType

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

    • getCourseRequirementRecordTypes

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

    • supportsCourseRequirementRecordType

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

    • getProgramRequirementRecordTypes

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

    • supportsProgramRequirementRecordType

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

    • getCredentialRequirementRecordTypes

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

    • supportsCredentialRequirementRecordType

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

    • getLearningObjectiveRequirementRecordTypes

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

    • supportsLearningObjectiveRequirementRecordType

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

    • getAssessmentRequirementRecordTypes

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

    • supportsAssessmentRequirementRecordType

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

    • getAwardRequirementRecordTypes

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

    • supportsAwardRequirementRecordType

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