Interface RegistrationRequestProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
RegistrationRequestManager, RegistrationRequestProxyManager
The course registration.request profile describes the interoperability among course.registration.request services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedRegistrationRequestItemrecord types.Gets the supportedRegistrationRequestItemsearch types.Gets the supportedRegistrationRequestrecord types.Gets the supportedRegistrationRequestsearch types.booleanTests if a registration request administrative service is supported.booleanTests if a registration request course catalog lookup service is supported.booleanTests if a registration request course catalog assignment service is supported.booleanTests if a registration request item administrative service is supported.booleanTests if a registration request item course catalog lookup service is supported.booleanTests if a registration request item course catalog assignment service is supported.booleanTests if looking up registration request items is supported.booleanTests if a registration request item notification service is supported.booleanTests if querying registration request items is supported.booleansupportsRegistrationRequestItemRecordType(Type registrationRequestItemRecordType) Tests if the givenRegistrationRequestItemrecord type is supported.booleanTests if searching registration request items is supported.booleansupportsRegistrationRequestItemSearchRecordType(Type registrationRequestItemSearchRecordType) Tests if the givenRegistrationRequestItemsearch type is supported.booleanTests if a registration request item smart course catalog service is supported.booleanTests if looking up registration requests is supported.booleanTests if a registration request notification service is supported.booleanTests if querying registration requests is supported.booleansupportsRegistrationRequestRecordType(Type registrationRequestRecordType) Tests if the givenRegistrationRequestrecord type is supported.booleanTests if searching registration requests is supported.booleansupportsRegistrationRequestSearchRecordType(Type registrationRequestSearchRecordType) Tests if the givenRegistrationRequestsearch type is supported.booleanTests if a registration request smart course catalog service is supported.booleanTests if any course catalog federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
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:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestLookup
boolean supportsRegistrationRequestLookup()Tests if looking up registration requests is supported.- Returns:
trueif registration request lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestQuery
boolean supportsRegistrationRequestQuery()Tests if querying registration requests is supported.- Returns:
trueif registration request query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestSearch
boolean supportsRegistrationRequestSearch()Tests if searching registration requests is supported.- Returns:
trueif registration request search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestAdmin
boolean supportsRegistrationRequestAdmin()Tests if a registration request administrative service is supported.- Returns:
trueif registration request administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestNotification
boolean supportsRegistrationRequestNotification()Tests if a registration request notification service is supported.- Returns:
trueif registration request notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestCourseCatalog
boolean supportsRegistrationRequestCourseCatalog()Tests if a registration request course catalog lookup service is supported.- Returns:
trueif a registration request course catalog lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestCourseCatalogAssignment
boolean supportsRegistrationRequestCourseCatalogAssignment()Tests if a registration request course catalog assignment service is supported.- Returns:
trueif a registration request to course catalog assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestSmartCourseCatalog
boolean supportsRegistrationRequestSmartCourseCatalog()Tests if a registration request smart course catalog service is supported.- Returns:
trueif a smart course catalog service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemLookup
boolean supportsRegistrationRequestItemLookup()Tests if looking up registration request items is supported.- Returns:
trueif registration request item lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemQuery
boolean supportsRegistrationRequestItemQuery()Tests if querying registration request items is supported.- Returns:
trueif registration request item query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemSearch
boolean supportsRegistrationRequestItemSearch()Tests if searching registration request items is supported.- Returns:
trueif registration request item search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemAdmin
boolean supportsRegistrationRequestItemAdmin()Tests if a registration request item administrative service is supported.- Returns:
trueif registration request item administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemNotification
boolean supportsRegistrationRequestItemNotification()Tests if a registration request item notification service is supported.- Returns:
trueif registration request item notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemCourseCatalog
boolean supportsRegistrationRequestItemCourseCatalog()Tests if a registration request item course catalog lookup service is supported.- Returns:
trueif a registration request item course catalog lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemCourseCatalogAssignment
boolean supportsRegistrationRequestItemCourseCatalogAssignment()Tests if a registration request item course catalog assignment service is supported.- Returns:
trueif a registration request item to course catalog assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemSmartCourseCatalog
boolean supportsRegistrationRequestItemSmartCourseCatalog()Tests if a registration request item smart course catalog service is supported.- Returns:
trueif a smart course catalog service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getRegistrationRequestRecordTypes
TypeList getRegistrationRequestRecordTypes()Gets the supportedRegistrationRequestrecord types.- Returns:
- a list containing the supported
RegistrationRequestrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestRecordType
Tests if the givenRegistrationRequestrecord type is supported.- Parameters:
registrationRequestRecordType- aTypeindicating aRegistrationRequestrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-registrationRequestRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getRegistrationRequestSearchRecordTypes
TypeList getRegistrationRequestSearchRecordTypes()Gets the supportedRegistrationRequestsearch types.- Returns:
- a list containing the supported
RegistrationRequestsearch types - Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestSearchRecordType
Tests if the givenRegistrationRequestsearch type is supported.- Parameters:
registrationRequestSearchRecordType- aTypeindicating aRegistrationRequestsearch type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-registrationRequestSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getRegistrationRequestItemRecordTypes
TypeList getRegistrationRequestItemRecordTypes()Gets the supportedRegistrationRequestItemrecord types.- Returns:
- a list containing the supported
RegistrationRequestItemrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemRecordType
Tests if the givenRegistrationRequestItemrecord type is supported.- Parameters:
registrationRequestItemRecordType- aTypeindicating aRegistrationRequestItemrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-registrationRequestItemRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getRegistrationRequestItemSearchRecordTypes
TypeList getRegistrationRequestItemSearchRecordTypes()Gets the supportedRegistrationRequestItemsearch types.- Returns:
- a list containing the supported
RegistrationRequestItemsearch types - Compliance:
mandatory- This method must be implemented.
-
supportsRegistrationRequestItemSearchRecordType
boolean supportsRegistrationRequestItemSearchRecordType(Type registrationRequestItemSearchRecordType) Tests if the givenRegistrationRequestItemsearch type is supported.- Parameters:
registrationRequestItemSearchRecordType- aTypeindicating aRegistrationRequestItemsearch type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-registrationRequestItemSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-