public interface OfferingProfile extends OsidProfile
The offering profile describes the interoperability among offering services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getCanonicalUnitRecordTypes()
Gets the supported
CanonicalUnit record types. |
TypeList |
getCanonicalUnitSearchRecordTypes()
Gets the supported canonical unit search record types.
|
TypeList |
getCatalogueRecordTypes()
Gets the supported
Catalogue record types. |
TypeList |
getCatalogueSearchRecordTypes()
Gets the supported catalogue search record types.
|
TypeList |
getOfferingRecordTypes()
Gets the supported
Offering record types. |
TypeList |
getOfferingSearchRecordTypes()
Gets the supported offering search record types.
|
TypeList |
getParticipantRecordTypes()
Gets the supported
Participant record types. |
TypeList |
getParticipantSearchRecordTypes()
Gets the supported participant search record types.
|
TypeList |
getResultRecordTypes()
Gets the supported
Result record types. |
TypeList |
getResultSearchRecordTypes()
Gets the supported result search record types.
|
boolean |
supportsCanonicalUnitAdmin()
Tests if managing for canonical units is available.
|
boolean |
supportsCanonicalUnitCatalogue()
Tests if a canonical unit to catalogue lookup session is available.
|
boolean |
supportsCanonicalUnitCatalogueAssignment()
Tests if a canonical unit to catalogue assignment session is
available.
|
boolean |
supportsCanonicalUnitLookup()
Tests for the availability of a canonical unit lookup service.
|
boolean |
supportsCanonicalUnitNotification()
Tests if canonical unit notification is available.
|
boolean |
supportsCanonicalUnitQuery()
Tests for the availability of a canonical unit query service.
|
boolean |
supportsCanonicalUnitRecordType(Type canonicalUnitRecordType)
Tests if the given
CanonicalUnit record type is
supported. |
boolean |
supportsCanonicalUnitSearch()
Tests if searching for canonical units is available.
|
boolean |
supportsCanonicalUnitSearchRecordType(Type canonicalUnitSearchRecordType)
Tests if the given canonical unit search record type is supported.
|
boolean |
supportsCanonicalUnitSmartCatalogue()
Tests if a canonical unit smart catalogue session is available.
|
boolean |
supportsCatalogueAdmin()
Tests for the availability of a catalogue administrative service for
creating and deleting catalogues.
|
boolean |
supportsCatalogueHierarchy()
Tests for the availability of a catalogue hierarchy traversal service.
|
boolean |
supportsCatalogueHierarchyDesign()
Tests for the availability of a catalogue hierarchy design service.
|
boolean |
supportsCatalogueLookup()
Tests for the availability of an catalogue lookup service.
|
boolean |
supportsCatalogueNotification()
Tests for the availability of a catalogue notification service.
|
boolean |
supportsCatalogueQuery()
Tests if querying catalogues is available.
|
boolean |
supportsCatalogueRecordType(Type catalogueRecordType)
Tests if the given
Catalogue record type is supported. |
boolean |
supportsCatalogueSearch()
Tests if searching for catalogues is available.
|
boolean |
supportsCatalogueSearchRecordType(Type catalogueSearchRecordType)
Tests if the given catalogue search record type is supported.
|
boolean |
supportsOfferingAdmin()
Tests if managing for offerings is available.
|
boolean |
supportsOfferingBatch()
Tests for the availability of a offering batch service.
|
boolean |
supportsOfferingCatalogue()
Tests if an offering to catalogue lookup session is available.
|
boolean |
supportsOfferingCatalogueAssignment()
Tests if an offering to catalogue assignment session is available.
|
boolean |
supportsOfferingLookup()
Tests for the availability of an offering lookup service.
|
boolean |
supportsOfferingNotification()
Tests if offering notification is available.
|
boolean |
supportsOfferingQuery()
Tests for the availability of an offering query service.
|
boolean |
supportsOfferingRecordType(Type offeringRecordType)
Tests if the given
Offering record type is supported. |
boolean |
supportsOfferingRules()
Tests for the availability of a offering rules service.
|
boolean |
supportsOfferingSearch()
Tests if searching for offerings is available.
|
boolean |
supportsOfferingSearchRecordType(Type offeringSearchRecordType)
Tests if the given offering search record type is supported.
|
boolean |
supportsOfferingSmartCatalogue()
Tests if an offering smart catalogue session is available.
|
boolean |
supportsParticipantAdmin()
Tests if managing for participants is available.
|
boolean |
supportsParticipantCatalogue()
Tests if a participant to catalogue lookup session is available.
|
boolean |
supportsParticipantCatalogueAssignment()
Tests if a participant to catalogue assignment session is available.
|
boolean |
supportsParticipantLookup()
Tests for the availability of a participant lookup service.
|
boolean |
supportsParticipantNotification()
Tests if participant notification is available.
|
boolean |
supportsParticipantQuery()
Tests for the availability of a participant query service.
|
boolean |
supportsParticipantRecordType(Type participantRecordType)
Tests if the given
Participant record type is
supported. |
boolean |
supportsParticipantSearch()
Tests if searching for participants is available.
|
boolean |
supportsParticipantSearchRecordType(Type participantSearchRecordType)
Tests if the given participant search record type is supported.
|
boolean |
supportsParticipantSmartCatalogue()
Tests if a participant smart catalogue session is available.
|
boolean |
supportsResultAdmin()
Tests if managing for results is available.
|
boolean |
supportsResultCatalogue()
Tests if an result to catalogue lookup session is available.
|
boolean |
supportsResultCatalogueAssignment()
Tests if an result to catalogue assignment session is available.
|
boolean |
supportsResultLookup()
Tests for the availability of an result lookup service.
|
boolean |
supportsResultNotification()
Tests if result notification is available.
|
boolean |
supportsResultQuery()
Tests for the availability of an result query service.
|
boolean |
supportsResultRecordType(Type resultRecordType)
Tests if the given
Result record type is supported. |
boolean |
supportsResultSearch()
Tests if searching for results is available.
|
boolean |
supportsResultSearchRecordType(Type resultSearchRecordType)
Tests if the given result search record type is supported.
|
boolean |
supportsResultSmartCatalogue()
Tests if an result smart catalogue session is available.
|
boolean |
supportsVisibleFederation()
Tests if any catalogue 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 supportsCanonicalUnitLookup()
true
if canonical unit lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCanonicalUnitQuery()
true
if canonical unit query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCanonicalUnitSearch()
true
if canonical unit search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCanonicalUnitAdmin()
true
if a canonical unit adminstrative service
is available, false
otherwisemandatory
- This method must be implemented. boolean supportsCanonicalUnitNotification()
true
if canonical unit notification is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsCanonicalUnitCatalogue()
true
if canonical unit catalogue lookup session
is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsCanonicalUnitCatalogueAssignment()
true
if canonical unit catalogue assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsCanonicalUnitSmartCatalogue()
true
if canonical unit smart catalogue is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsOfferingLookup()
true
if offering lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsOfferingQuery()
true
if offering query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsOfferingSearch()
true
if offering search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsOfferingAdmin()
true
if an offering adminstrative service is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsOfferingNotification()
true
if offering notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsOfferingCatalogue()
true
if offering catalogue lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsOfferingCatalogueAssignment()
true
if offering catalogue assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsOfferingSmartCatalogue()
true
if offering smart catalogue is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsParticipantLookup()
true
if participant lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsParticipantQuery()
true
if participant query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsParticipantSearch()
true
if participant search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsParticipantAdmin()
true
if a participant adminstrative service is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsParticipantNotification()
true
if participant notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsParticipantCatalogue()
true
if participant catalogue lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsParticipantCatalogueAssignment()
true
if participant catalogue assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsParticipantSmartCatalogue()
true
if participant smart catalogue is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsResultLookup()
true
if result lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsResultQuery()
true
if result query is available, false
otherwisemandatory
- This method must be implemented. boolean supportsResultSearch()
true
if result search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsResultAdmin()
true
if an result adminstrative service is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsResultNotification()
true
if result notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsResultCatalogue()
true
if result catalogue lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsResultCatalogueAssignment()
true
if result catalogue assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsResultSmartCatalogue()
true
if result smart catalogue is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogueLookup()
true
if catalogue lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogueQuery()
true
if catalogue query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogueSearch()
true
if catalogue search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogueAdmin()
true
if catalogue administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogueNotification()
true
if catalogue notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsCatalogueHierarchy()
true
if catalogue hierarchy traversal is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsCatalogueHierarchyDesign()
true
if catalogue hierarchy design is
available, false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsOfferingBatch()
true
if a offering batch service is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsOfferingRules()
true
if a offering rules service is available,
false
otherwisemandatory
- This method must be implemented in all
providers. TypeList getCanonicalUnitRecordTypes()
CanonicalUnit
record types.mandatory
- This method must be implemented. boolean supportsCanonicalUnitRecordType(Type canonicalUnitRecordType)
CanonicalUnit
record type is
supported.canonicalUnitRecordType
- a Type
indicating a
CanonicalUnit
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- canonicalUnitRecordType
is null
mandatory
- This method must be implemented. TypeList getCanonicalUnitSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsCanonicalUnitSearchRecordType(Type canonicalUnitSearchRecordType)
canonicalUnitSearchRecordType
- a Type
indicating
a canonical unit record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
canonicalUnitSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getOfferingRecordTypes()
Offering
record types.mandatory
- This method must be implemented. boolean supportsOfferingRecordType(Type offeringRecordType)
Offering
record type is supported.offeringRecordType
- a Type
indicating an
Offering
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- offeringRecordType
is null
mandatory
- This method must be implemented. TypeList getOfferingSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsOfferingSearchRecordType(Type offeringSearchRecordType)
offeringSearchRecordType
- a Type
indicating an
offering record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- offeringSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getParticipantRecordTypes()
Participant
record types.mandatory
- This method must be implemented. boolean supportsParticipantRecordType(Type participantRecordType)
Participant
record type is
supported.participantRecordType
- a Type
indicating a
Participant
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- participantRecordType
is null
mandatory
- This method must be implemented. TypeList getParticipantSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsParticipantSearchRecordType(Type participantSearchRecordType)
participantSearchRecordType
- a Type
indicating a
participant record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
participantSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getResultRecordTypes()
Result
record types.mandatory
- This method must be implemented. boolean supportsResultRecordType(Type resultRecordType)
Result
record type is supported.resultRecordType
- a Type
indicating an
Result
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- resultRecordType
is null
mandatory
- This method must be implemented. TypeList getResultSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsResultSearchRecordType(Type resultSearchRecordType)
resultSearchRecordType
- a Type
indicating an
result record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- resultSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getCatalogueRecordTypes()
Catalogue
record types.mandatory
- This method must be implemented. boolean supportsCatalogueRecordType(Type catalogueRecordType)
Catalogue
record type is supported.catalogueRecordType
- a Type
indicating a
Catalogue
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- catalogueRecordType
is null
mandatory
- This method must be implemented. TypeList getCatalogueSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsCatalogueSearchRecordType(Type catalogueSearchRecordType)
catalogueSearchRecordType
- a Type
indicating a
catalogue record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
catalogueSearchRecordType
is null
mandatory
- This method must be implemented.