public interface CourseProgramProfile extends OsidProfile
The course program profile describes the interoperability among course program services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getCredentialRecordTypes()
Gets the supported
credential record types. |
TypeList |
getCredentialSearchRecordTypes()
Gets the supported
credential search record types. |
TypeList |
getEnrollmentRecordTypes()
Gets the supported
Enrollment record types. |
TypeList |
getEnrollmentSearchRecordTypes()
Gets the supported
Enrollment search record types. |
TypeList |
getProgramOfferingRecordTypes()
Gets the supported
ProgramOffering record types. |
TypeList |
getProgramOfferingSearchRecordTypes()
Gets the supported
ProgramOffering search record types. |
TypeList |
getProgramRecordTypes()
Gets the supported
program record types. |
TypeList |
getProgramSearchRecordTypes()
Gets the supported
program search record types. |
boolean |
supportsCourseProgramAssignment()
Tests if a course/program mapping service is supported.
|
boolean |
supportsCourseProgramBatch()
Tests if a course program batch service is available.
|
boolean |
supportsCourseProgramLookup()
Tests if a course/program lookup service is supported.
|
boolean |
supportsCredentialAdmin()
Tests if course
administrative service is supported. |
boolean |
supportsCredentialCourseCatalog()
Tests if a course cataloging service is supported.
|
boolean |
supportsCredentialCourseCatalogAssignment()
Tests if a course cataloging service is supported.
|
boolean |
supportsCredentialLookup()
Tests if looking up courses is supported.
|
boolean |
supportsCredentialNotification()
Tests if a course
notification service is supported. |
boolean |
supportsCredentialQuery()
Tests if querying courses is supported.
|
boolean |
supportsCredentialRecordType(Type credentialRecordType)
Tests if the given
credential record type is supported. |
boolean |
supportsCredentialSearch()
Tests if searching courses is supported.
|
boolean |
supportsCredentialSearchRecordType(Type credentialSearchRecordType)
Tests if the given
credential search record type is
supported. |
boolean |
supportsCredentialSmartCourseCatalog()
Tests if a credential smart course catalog session is available.
|
boolean |
supportsEnrollmentAdmin()
Tests if an enrollment
administrative service is
supported. |
boolean |
supportsEnrollmentCourseCatalog()
Tests if an enrollment cataloging service is supported.
|
boolean |
supportsEnrollmentCourseCatalogAssignment()
Tests if an enrollment cataloging service is supported.
|
boolean |
supportsEnrollmentLookup()
Tests if looking up enrollments is supported.
|
boolean |
supportsEnrollmentNotification()
Tests if an enrollment
notification service is
supported. |
boolean |
supportsEnrollmentQuery()
Tests if querying enrollments is supported.
|
boolean |
supportsEnrollmentRecordType(Type enrollmentRecordType)
Tests if the given
Enrollment record type is supported. |
boolean |
supportsEnrollmentSearch()
Tests if searching enrollments is supported.
|
boolean |
supportsEnrollmentSearchRecordType(Type enrollmentSearchRecordType)
Tests if the given
Enrollment search record type is
supported. |
boolean |
supportsEnrollmentSmartCourseCatalog()
Tests if an enrollment smart course catalog session is available.
|
boolean |
supportsProgramAdmin()
Tests if program administrative service is supported.
|
boolean |
supportsProgramCourseCatalog()
Tests if a program cataloging service is supported.
|
boolean |
supportsProgramCourseCatalogAssignment()
Tests if a course cataloging service is supported.
|
boolean |
supportsProgramLookup()
Tests if looking up programs is supported.
|
boolean |
supportsProgramNotification()
Tests if a program
notification service is supported. |
boolean |
supportsProgramOfferingAdmin()
Tests if course
offering administrative
service is supported. |
boolean |
supportsProgramOfferingCourseCatalog()
Tests if a program offering cataloging service is supported.
|
boolean |
supportsProgramOfferingCourseCatalogAssignment()
Tests if a program offering cataloging service is supported.
|
boolean |
supportsProgramOfferingLookup()
Tests if looking up program offerings is supported.
|
boolean |
supportsProgramOfferingNotification()
Tests if a program offering
notification service is
supported. |
boolean |
supportsProgramOfferingQuery()
Tests if querying program offerings is supported.
|
boolean |
supportsProgramOfferingRecordType(Type programOfferingRecordType)
Tests if the given
ProgramOffering record type is
supported. |
boolean |
supportsProgramOfferingSearch()
Tests if searching program offerings is supported.
|
boolean |
supportsProgramOfferingSearchRecordType(Type programOfferingSearchRecordType)
Tests if the given
ProgramOffering search record type
is supported. |
boolean |
supportsProgramOfferingSmartCourseCatalog()
Tests if a program offering smart course catalog session is available.
|
boolean |
supportsProgramQuery()
Tests if querying programs is supported.
|
boolean |
supportsProgramRecordType(Type programRecordType)
Tests if the given
program record type is supported. |
boolean |
supportsProgramSearch()
Tests if searching programs is supported.
|
boolean |
supportsProgramSearchRecordType(Type programSearchRecordType)
Tests if the given
program search record type is
supported. |
boolean |
supportsProgramSmartCourseCatalog()
Tests if a program smart course catalog session is available.
|
boolean |
supportsVisibleFederation()
Tests if any course catalog federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramLookup()
true
if program lookup is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramQuery()
true
if program query is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramSearch()
true
if program search is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramAdmin()
true
if program administration is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramNotification()
notification service is supported. true
if program notification is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramCourseCatalog()
true
if program cataloging is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramCourseCatalogAssignment()
true
if course cataloging is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramSmartCourseCatalog()
true
if a program smart course catalog session
is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsCourseProgramLookup()
true
if course/program lookup service is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsCourseProgramAssignment()
true
if course/program mapping service is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsProgramOfferingLookup()
true
if program offering lookup is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramOfferingQuery()
true
if program offering query is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramOfferingSearch()
true
if program offering search is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramOfferingAdmin()
offering
administrative
service is supported. true
if program offering administration is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsProgramOfferingNotification()
notification service is
supported. true
if program offering notification is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsProgramOfferingCourseCatalog()
true
if program offering catalog is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProgramOfferingCourseCatalogAssignment()
true
if program offering cataloging is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsProgramOfferingSmartCourseCatalog()
true
if a program offering smart course catalog
session is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsCredentialLookup()
true
if course lookup is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCredentialQuery()
true
if credential query is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCredentialSearch()
true
if credential search is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCredentialAdmin()
administrative service is supported. true
if course administration is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCredentialNotification()
notification service is supported. true
if course notification is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCredentialCourseCatalog()
true
if course cataloging is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCredentialCourseCatalogAssignment()
true
if course cataloging is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCredentialSmartCourseCatalog()
true
if a credential smart course catalog
session is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsEnrollmentLookup()
true
if enrollment lookup is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsEnrollmentQuery()
true
if enrollment query is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsEnrollmentSearch()
true
if enrollment search is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsEnrollmentAdmin()
administrative service is
supported. true
if enrollment administration is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsEnrollmentNotification()
notification service is
supported. true
if enrollment notification is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsEnrollmentCourseCatalog()
true
if enrollment catalog is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsEnrollmentCourseCatalogAssignment()
true
if enrollment cataloging is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsEnrollmentSmartCourseCatalog()
true
if an enrollment smart course catalog
session is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsCourseProgramBatch()
true
if a course program batch service is
supported, false
otherwisemandatory
- This method must be implemented. TypeList getProgramRecordTypes()
program
record types. Program
record
typesmandatory
- This method must be implemented. boolean supportsProgramRecordType(Type programRecordType)
program
record type is supported.programRecordType
- a Type
indicating a
program
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- programRecordType
is null
mandatory
- This method must be implemented. TypeList getProgramSearchRecordTypes()
program
search record types. program
search
record typesmandatory
- This method must be implemented. boolean supportsProgramSearchRecordType(Type programSearchRecordType)
program
search record type is
supported.programSearchRecordType
- a Type
indicating a
Program
search record type true
if the given search record type is
supported, false
otherwiseNullArgumentException
- programSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getProgramOfferingRecordTypes()
ProgramOffering
record types. ProgramOffering
record typesmandatory
- This method must be implemented. boolean supportsProgramOfferingRecordType(Type programOfferingRecordType)
ProgramOffering
record type is
supported.programOfferingRecordType
- a Type
indicating an
ProgramOffering
record type true
if the given record type is supported,
false
otherwiseNullArgumentException
-
programOfferingRecordType
is null
mandatory
- This method must be implemented. TypeList getProgramOfferingSearchRecordTypes()
ProgramOffering
search record types. ProgramOffering
search record typesmandatory
- This method must be implemented. boolean supportsProgramOfferingSearchRecordType(Type programOfferingSearchRecordType)
ProgramOffering
search record type
is supported.programOfferingSearchRecordType
- a Type
indicating an ProgramOffering
search record
type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
programOfferingSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getCredentialRecordTypes()
credential
record types. credential
record typesmandatory
- This method must be implemented. boolean supportsCredentialRecordType(Type credentialRecordType)
credential
record type is supported.credentialRecordType
- a Type
indicating a
credential
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- credentialRecordType
is null
mandatory
- This method must be implemented. TypeList getCredentialSearchRecordTypes()
credential
search record types. credential
search record typesmandatory
- This method must be implemented. boolean supportsCredentialSearchRecordType(Type credentialSearchRecordType)
credential
search record type is
supported.credentialSearchRecordType
- a Type
indicating a
credential
search record type true
if the given search record type is
supported, false
otherwiseNullArgumentException
-
credentialSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getEnrollmentRecordTypes()
Enrollment
record types. Enrollment
record typesmandatory
- This method must be implemented. boolean supportsEnrollmentRecordType(Type enrollmentRecordType)
Enrollment
record type is supported.enrollmentRecordType
- a Type
indicating an
Enrollment
record type true
if the given record type is supported,
false
otherwiseNullArgumentException
- enrollmentRecordType
is null
mandatory
- This method must be implemented. TypeList getEnrollmentSearchRecordTypes()
Enrollment
search record types. Enrollment
search record typesmandatory
- This method must be implemented. boolean supportsEnrollmentSearchRecordType(Type enrollmentSearchRecordType)
Enrollment
search record type is
supported.enrollmentSearchRecordType
- a Type
indicating an
Enrollment
search record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
enrollmentSearchRecordType
is null
mandatory
- This method must be implemented.