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 Details

    • 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 administrative 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 administrative 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 administrative 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 a 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 a 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 a result administrative 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 a 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 a 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 a 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 a 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 an offering batch service.
      Returns:
      true if an 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 an offering rules service.
      Returns:
      true if an 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 a 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 a 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.