OSID - osid.offering.OfferingProfile Service Interface Definition

Interface	osid.offering.OfferingProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.offering.OfferingManager`
Implemented By	`osid.offering.OfferingProxyManager`
Description	The offering profile describes the interoperability among offering services.
Method	supportsVisibleFederation
Description	Tests if any catalogue federation is exposed. Federation is exposed when a specific catalogue may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogues appears as a single catalogue.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitLookup
Description	Tests for the availability of a canonical unit lookup service.
Return	`boolean`		`true` if canonical unit lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitQuery
Description	Tests for the availability of a canonical unit query service.
Return	`boolean`		`true` if canonical unit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitSearch
Description	Tests if searching for canonical units is available.
Return	`boolean`		`true` if canonical unit search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitAdmin
Description	Tests if managing for canonical units is available.
Return	`boolean`		`true` if a canonical unit administrative service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitNotification
Description	Tests if canonical unit notification is available.
Return	`boolean`		`true` if canonical unit notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitCatalogue
Description	Tests if a canonical unit to catalogue lookup session is available.
Return	`boolean`		`true` if canonical unit catalogue lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitCatalogueAssignment
Description	Tests if a canonical unit to catalogue assignment session is available.
Return	`boolean`		`true` if canonical unit catalogue assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitSmartCatalogue
Description	Tests if a canonical unit smart catalogue session is available.
Return	`boolean`		`true` if canonical unit smart catalogue is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingLookup
Description	Tests for the availability of an offering lookup service.
Return	`boolean`		`true` if offering lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingQuery
Description	Tests for the availability of an offering query service.
Return	`boolean`		`true` if offering query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingSearch
Description	Tests if searching for offerings is available.
Return	`boolean`		`true` if offering search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingAdmin
Description	Tests if managing for offerings is available.
Return	`boolean`		`true` if an offering administrative service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingNotification
Description	Tests if offering notification is available.
Return	`boolean`		`true` if offering notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingCatalogue
Description	Tests if an offering to catalogue lookup session is available.
Return	`boolean`		`true` if offering catalogue lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingCatalogueAssignment
Description	Tests if an offering to catalogue assignment session is available.
Return	`boolean`		`true` if offering catalogue assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingSmartCatalogue
Description	Tests if an offering smart catalogue session is available.
Return	`boolean`		`true` if offering smart catalogue is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantLookup
Description	Tests for the availability of a participant lookup service.
Return	`boolean`		`true` if participant lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantQuery
Description	Tests for the availability of a participant query service.
Return	`boolean`		`true` if participant query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantSearch
Description	Tests if searching for participants is available.
Return	`boolean`		`true` if participant search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantAdmin
Description	Tests if managing for participants is available.
Return	`boolean`		`true` if a participant administrative service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantNotification
Description	Tests if participant notification is available.
Return	`boolean`		`true` if participant notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantCatalogue
Description	Tests if a participant to catalogue lookup session is available.
Return	`boolean`		`true` if participant catalogue lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantCatalogueAssignment
Description	Tests if a participant to catalogue assignment session is available.
Return	`boolean`		`true` if participant catalogue assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantSmartCatalogue
Description	Tests if a participant smart catalogue session is available.
Return	`boolean`		`true` if participant smart catalogue is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultLookup
Description	Tests for the availability of a result lookup service.
Return	`boolean`		`true` if result lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultQuery
Description	Tests for the availability of a result query service.
Return	`boolean`		`true` if result query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultSearch
Description	Tests if searching for results is available.
Return	`boolean`		`true` if result search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultAdmin
Description	Tests if managing for results is available.
Return	`boolean`		`true` if a result administrative service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultNotification
Description	Tests if result notification is available.
Return	`boolean`		`true` if result notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultCatalogue
Description	Tests if a result to catalogue lookup session is available.
Return	`boolean`		`true` if result catalogue lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultCatalogueAssignment
Description	Tests if a result to catalogue assignment session is available.
Return	`boolean`		`true` if result catalogue assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultSmartCatalogue
Description	Tests if a result smart catalogue session is available.
Return	`boolean`		`true` if result smart catalogue is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueLookup
Description	Tests for the availability of a catalogue lookup service.
Return	`boolean`		`true` if catalogue lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueQuery
Description	Tests if querying catalogues is available.
Return	`boolean`		`true` if catalogue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueSearch
Description	Tests if searching for catalogues is available.
Return	`boolean`		`true` if catalogue search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueAdmin
Description	Tests for the availability of a catalogue administrative service for creating and deleting catalogues.
Return	`boolean`		`true` if catalogue administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueNotification
Description	Tests for the availability of a catalogue notification service.
Return	`boolean`		`true` if catalogue notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsCatalogueHierarchy
Description	Tests for the availability of a catalogue hierarchy traversal service.
Return	`boolean`		`true` if catalogue hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueHierarchyDesign
Description	Tests for the availability of a catalogue hierarchy design service.
Return	`boolean`		`true` if catalogue hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsOfferingBatch
Description	Tests for the availability of an offering batch service.
Return	`boolean`		`true` if an offering batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsOfferingRules
Description	Tests for the availability of an offering rules service.
Return	`boolean`		`true` if an offering rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getCanonicalUnitRecordTypes
Description	Gets the supported `CanonicalUnit` record types.
Return	`osid.type.TypeList`		a list containing the supported canonical unit record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitRecordType
Description	Tests if the given `CanonicalUnit` record type is supported.
Parameters	`osid.type.Type`	`canonicalUnitRecordType`	a `Type` indicating a `CanonicalUnit` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`canonicalUnitRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitSearchRecordTypes
Description	Gets the supported canonical unit search record types.
Return	`osid.type.TypeList`		a list containing the supported canonical unit search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitSearchRecordType
Description	Tests if the given canonical unit search record type is supported.
Parameters	`osid.type.Type`	`canonicalUnitSearchRecordType`	a `Type` indicating a canonical unit record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`canonicalUnitSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingRecordTypes
Description	Gets the supported `Offering` record types.
Return	`osid.type.TypeList`		a list containing the supported offering record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingRecordType
Description	Tests if the given `Offering` record type is supported.
Parameters	`osid.type.Type`	`offeringRecordType`	a `Type` indicating an `Offering` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`offeringRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingSearchRecordTypes
Description	Gets the supported offering search record types.
Return	`osid.type.TypeList`		a list containing the supported offering search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingSearchRecordType
Description	Tests if the given offering search record type is supported.
Parameters	`osid.type.Type`	`offeringSearchRecordType`	a `Type` indicating an offering record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`offeringSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantRecordTypes
Description	Gets the supported `Participant` record types.
Return	`osid.type.TypeList`		a list containing the supported participant record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantRecordType
Description	Tests if the given `Participant` record type is supported.
Parameters	`osid.type.Type`	`participantRecordType`	a `Type` indicating a `Participant` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`participantRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantSearchRecordTypes
Description	Gets the supported participant search record types.
Return	`osid.type.TypeList`		a list containing the supported participant search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantSearchRecordType
Description	Tests if the given participant search record type is supported.
Parameters	`osid.type.Type`	`participantSearchRecordType`	a `Type` indicating a participant record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`participantSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResultRecordTypes
Description	Gets the supported `Result` record types.
Return	`osid.type.TypeList`		a list containing the supported result record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultRecordType
Description	Tests if the given `Result` record type is supported.
Parameters	`osid.type.Type`	`resultRecordType`	a `Type` indicating a `Result` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resultRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResultSearchRecordTypes
Description	Gets the supported result search record types.
Return	`osid.type.TypeList`		a list containing the supported result search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultSearchRecordType
Description	Tests if the given result search record type is supported.
Parameters	`osid.type.Type`	`resultSearchRecordType`	a `Type` indicating a result record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resultSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueRecordTypes
Description	Gets the supported `Catalogue` record types.
Return	`osid.type.TypeList`		a list containing the supported catalogue record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueRecordType
Description	Tests if the given `Catalogue` record type is supported.
Parameters	`osid.type.Type`	`catalogueRecordType`	a `Type` indicating a `Catalogue` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`catalogueRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueSearchRecordTypes
Description	Gets the supported catalogue search record types.
Return	`osid.type.TypeList`		a list containing the supported catalogue search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueSearchRecordType
Description	Tests if the given catalogue search record type is supported.
Parameters	`osid.type.Type`	`catalogueSearchRecordType`	a `Type` indicating a catalogue record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`catalogueSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.