org.osid.offering

Interface OfferingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

OfferingManager, OfferingProxyManager

public interface OfferingProfile
extends OsidProfile

The offering profile describes the interoperability among offering services.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitLookup

boolean supportsCanonicalUnitLookup()

Tests for the availability of a canonical unit lookup service.

Returns:

true if canonical unit lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitQuery

boolean supportsCanonicalUnitQuery()

Tests for the availability of a canonical unit query service.

Returns:

true if canonical unit query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitSearch

boolean supportsCanonicalUnitSearch()

Tests if searching for canonical units is available.

Returns:

true if canonical unit search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitAdmin

boolean supportsCanonicalUnitAdmin()

Tests if managing for canonical units is available.

Returns:

true if a canonical unit adminstrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitNotification

boolean supportsCanonicalUnitNotification()

Tests if canonical unit notification is available.

Returns:

true if canonical unit notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitCatalogue

boolean supportsCanonicalUnitCatalogue()

Tests if a canonical unit to catalogue lookup session is available.

Returns:

true if canonical unit catalogue lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitCatalogueAssignment

boolean supportsCanonicalUnitCatalogueAssignment()

Tests if a canonical unit to catalogue assignment session is available.

Returns:

true if canonical unit catalogue assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitSmartCatalogue

boolean supportsCanonicalUnitSmartCatalogue()

Tests if a canonical unit smart catalogue session is available.

Returns:

true if canonical unit smart catalogue is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOfferingLookup

boolean supportsOfferingLookup()

Tests for the availability of an offering lookup service.

Returns:

true if offering lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOfferingQuery

boolean supportsOfferingQuery()

Tests for the availability of an offering query service.

Returns:

true if offering query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOfferingSearch

boolean supportsOfferingSearch()

Tests if searching for offerings is available.

Returns:

true if offering search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOfferingAdmin

boolean supportsOfferingAdmin()

Tests if managing for offerings is available.

Returns:

true if an offering adminstrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOfferingNotification

boolean supportsOfferingNotification()

Tests if offering notification is available.

Returns:

true if offering notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOfferingCatalogue

boolean supportsOfferingCatalogue()

Tests if an offering to catalogue lookup session is available.

Returns:

true if offering catalogue lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOfferingCatalogueAssignment

boolean supportsOfferingCatalogueAssignment()

Tests if an offering to catalogue assignment session is available.

Returns:

true if offering catalogue assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOfferingSmartCatalogue

boolean supportsOfferingSmartCatalogue()

Tests if an offering smart catalogue session is available.

Returns:

true if offering smart catalogue is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParticipantLookup

boolean supportsParticipantLookup()

Tests for the availability of a participant lookup service.

Returns:

true if participant lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParticipantQuery

boolean supportsParticipantQuery()

Tests for the availability of a participant query service.

Returns:

true if participant query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParticipantSearch

boolean supportsParticipantSearch()

Tests if searching for participants is available.

Returns:

true if participant search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParticipantAdmin

boolean supportsParticipantAdmin()

Tests if managing for participants is available.

Returns:

true if a participant adminstrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParticipantNotification

boolean supportsParticipantNotification()

Tests if participant notification is available.

Returns:

true if participant notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParticipantCatalogue

boolean supportsParticipantCatalogue()

Tests if a participant to catalogue lookup session is available.

Returns:

true if participant catalogue lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParticipantCatalogueAssignment

boolean supportsParticipantCatalogueAssignment()

Tests if a participant to catalogue assignment session is available.

Returns:

true if participant catalogue assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParticipantSmartCatalogue

boolean supportsParticipantSmartCatalogue()

Tests if a participant smart catalogue session is available.

Returns:

true if participant smart catalogue is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResultLookup

boolean supportsResultLookup()

Tests for the availability of an result lookup service.

Returns:

true if result lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResultQuery

boolean supportsResultQuery()

Tests for the availability of an result query service.

Returns:

true if result query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResultSearch

boolean supportsResultSearch()

Tests if searching for results is available.

Returns:

true if result search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResultAdmin

boolean supportsResultAdmin()

Tests if managing for results is available.

Returns:

true if an result adminstrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResultNotification

boolean supportsResultNotification()

Tests if result notification is available.

Returns:

true if result notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResultCatalogue

boolean supportsResultCatalogue()

Tests if an result to catalogue lookup session is available.

Returns:

true if result catalogue lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResultCatalogueAssignment

boolean supportsResultCatalogueAssignment()

Tests if an result to catalogue assignment session is available.

Returns:

true if result catalogue assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResultSmartCatalogue

boolean supportsResultSmartCatalogue()

Tests if an result smart catalogue session is available.

Returns:

true if result smart catalogue is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogueLookup

boolean supportsCatalogueLookup()

Tests for the availability of an catalogue lookup service.

Returns:

true if catalogue lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogueQuery

boolean supportsCatalogueQuery()

Tests if querying catalogues is available.

Returns:

true if catalogue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogueSearch

boolean supportsCatalogueSearch()

Tests if searching for catalogues is available.

Returns:

true if catalogue search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogueAdmin

boolean supportsCatalogueAdmin()

Tests for the availability of a catalogue administrative service for creating and deleting catalogues.

Returns:

true if catalogue administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogueNotification

boolean supportsCatalogueNotification()

Tests for the availability of a catalogue notification service.

Returns:

true if catalogue notification is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsCatalogueHierarchy

boolean supportsCatalogueHierarchy()

Tests for the availability of a catalogue hierarchy traversal service.

Returns:

true if catalogue hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogueHierarchyDesign

boolean supportsCatalogueHierarchyDesign()

Tests for the availability of a catalogue hierarchy design service.

Returns:

true if catalogue hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsOfferingBatch

boolean supportsOfferingBatch()

Tests for the availability of a offering batch service.

Returns:

true if a offering batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsOfferingRules

boolean supportsOfferingRules()

Tests for the availability of a offering rules service.

Returns:

true if a offering rules service is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

getCanonicalUnitRecordTypes

TypeList getCanonicalUnitRecordTypes()

Gets the supported CanonicalUnit record types.

Returns:

a list containing the supported canonical unit record types

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitRecordType

boolean supportsCanonicalUnitRecordType(Type canonicalUnitRecordType)

Tests if the given CanonicalUnit record type is supported.

Parameters:

canonicalUnitRecordType - a Type indicating a CanonicalUnit record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - canonicalUnitRecordType is null

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitSearchRecordTypes

TypeList getCanonicalUnitSearchRecordTypes()

Gets the supported canonical unit search record types.

Returns:

a list containing the supported canonical unit search record types

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitSearchRecordType

boolean supportsCanonicalUnitSearchRecordType(Type canonicalUnitSearchRecordType)

Tests if the given canonical unit search record type is supported.

Parameters:

canonicalUnitSearchRecordType - a Type indicating a canonical unit record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - canonicalUnitSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getOfferingRecordTypes

TypeList getOfferingRecordTypes()

Gets the supported Offering record types.

Returns:

a list containing the supported offering record types

Compliance:

mandatory - This method must be implemented.

supportsOfferingRecordType

boolean supportsOfferingRecordType(Type offeringRecordType)

Tests if the given Offering record type is supported.

Parameters:

offeringRecordType - a Type indicating an Offering record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - offeringRecordType is null

Compliance:

mandatory - This method must be implemented.

getOfferingSearchRecordTypes

TypeList getOfferingSearchRecordTypes()

Gets the supported offering search record types.

Returns:

a list containing the supported offering search record types

Compliance:

mandatory - This method must be implemented.

supportsOfferingSearchRecordType

boolean supportsOfferingSearchRecordType(Type offeringSearchRecordType)

Tests if the given offering search record type is supported.

Parameters:

offeringSearchRecordType - a Type indicating an offering record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - offeringSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getParticipantRecordTypes

TypeList getParticipantRecordTypes()

Gets the supported Participant record types.

Returns:

a list containing the supported participant record types

Compliance:

mandatory - This method must be implemented.

supportsParticipantRecordType

boolean supportsParticipantRecordType(Type participantRecordType)

Tests if the given Participant record type is supported.

Parameters:

participantRecordType - a Type indicating a Participant record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - participantRecordType is null

Compliance:

mandatory - This method must be implemented.

getParticipantSearchRecordTypes

TypeList getParticipantSearchRecordTypes()

Gets the supported participant search record types.

Returns:

a list containing the supported participant search record types

Compliance:

mandatory - This method must be implemented.

supportsParticipantSearchRecordType

boolean supportsParticipantSearchRecordType(Type participantSearchRecordType)

Tests if the given participant search record type is supported.

Parameters:

participantSearchRecordType - a Type indicating a participant record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - participantSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getResultRecordTypes

TypeList getResultRecordTypes()

Gets the supported Result record types.

Returns:

a list containing the supported result record types

Compliance:

mandatory - This method must be implemented.

supportsResultRecordType

boolean supportsResultRecordType(Type resultRecordType)

Tests if the given Result record type is supported.

Parameters:

resultRecordType - a Type indicating an Result record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - resultRecordType is null

Compliance:

mandatory - This method must be implemented.

getResultSearchRecordTypes

TypeList getResultSearchRecordTypes()

Gets the supported result search record types.

Returns:

a list containing the supported result search record types

Compliance:

mandatory - This method must be implemented.

supportsResultSearchRecordType

boolean supportsResultSearchRecordType(Type resultSearchRecordType)

Tests if the given result search record type is supported.

Parameters:

resultSearchRecordType - a Type indicating an result record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - resultSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getCatalogueRecordTypes

TypeList getCatalogueRecordTypes()

Gets the supported Catalogue record types.

Returns:

a list containing the supported catalogue record types

Compliance:

mandatory - This method must be implemented.

supportsCatalogueRecordType

boolean supportsCatalogueRecordType(Type catalogueRecordType)

Tests if the given Catalogue record type is supported.

Parameters:

catalogueRecordType - a Type indicating a Catalogue record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - catalogueRecordType is null

Compliance:

mandatory - This method must be implemented.

getCatalogueSearchRecordTypes

TypeList getCatalogueSearchRecordTypes()

Gets the supported catalogue search record types.

Returns:

a list containing the supported catalogue search record types

Compliance:

mandatory - This method must be implemented.

supportsCatalogueSearchRecordType

boolean supportsCatalogueSearchRecordType(Type catalogueSearchRecordType)

Tests if the given catalogue search record type is supported.

Parameters:

catalogueSearchRecordType - a Type indicating a catalogue record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - catalogueSearchRecordType is null

Compliance:

mandatory - This method must be implemented.