Interface SequencingProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
SequencingManager, SequencingProxyManager
public interface SequencingProfile extends OsidProfile

The sequencing profile describes the interoperability among sequencing services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any action group federation is exposed. Federation is exposed when a specific action group may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of action groups appears as a single action group.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsElementLookup

      boolean supportsElementLookup()
      Tests if looking up elements is supported.
      Returns:
      true if element lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsElementAdmin

      boolean supportsElementAdmin()
      Tests if managing elements is supported.
      Returns:
      true if element management is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSequencing

      boolean supportsSequencing()
      Tests if sequencing elements is supported.
      Returns:
      true if element sequencing is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainLookup

      boolean supportsChainLookup()
      Tests if looking up chains is supported.
      Returns:
      true if chain lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainQuery

      boolean supportsChainQuery()
      Tests if querying chains is supported.
      Returns:
      true if chain query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainSearch

      boolean supportsChainSearch()
      Tests if searching chains is supported.
      Returns:
      true if chain search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainAdmin

      boolean supportsChainAdmin()
      Tests if chain administrative service is supported.
      Returns:
      true if chain administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainNotification

      boolean supportsChainNotification()
      Tests if a chain notification service is supported.
      Returns:
      true if chain notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainAntimatroid

      boolean supportsChainAntimatroid()
      Tests if a chain antimatroid lookup service is supported.
      Returns:
      true if a chain antimatroid lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainAntimatroidAssignment

      boolean supportsChainAntimatroidAssignment()
      Tests if a chain antimatroid assignment service is supported.
      Returns:
      true if a chain to antimatroid assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainSmartAntimatroid

      boolean supportsChainSmartAntimatroid()
      Tests if a chain smart antimatroid service is supported.
      Returns:
      true if a chain smart antimatroid service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAntimatroidLookup

      boolean supportsAntimatroidLookup()
      Tests if looking up antimatroids is supported.
      Returns:
      true if antimatroid lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAntimatroidQuery

      boolean supportsAntimatroidQuery()
      Tests if querying antimatroids is supported.
      Returns:
      true if an antimatroid query service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAntimatroidSearch

      boolean supportsAntimatroidSearch()
      Tests if searching antimatroids is supported.
      Returns:
      true if antimatroid search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAntimatroidAdmin

      boolean supportsAntimatroidAdmin()
      Tests if antimatroid administrative service is supported.
      Returns:
      true if antimatroid administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAntimatroidNotification

      boolean supportsAntimatroidNotification()
      Tests if an antimatroid notification service is supported.
      Returns:
      true if antimatroid notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAntimatroidHierarchy

      boolean supportsAntimatroidHierarchy()
      Tests for the availability of an antimatroid hierarchy traversal service.
      Returns:
      true if antimatroid hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsAntimatroidHierarchyDesign

      boolean supportsAntimatroidHierarchyDesign()
      Tests for the availability of an antimatroid hierarchy design service.
      Returns:
      true if antimatroid hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getChainRecordTypes

      TypeList getChainRecordTypes()
      Gets the supported Chain record types.
      Returns:
      a list containing the supported Chain record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainRecordType

      boolean supportsChainRecordType(Type chainRecordType)
      Tests if the given Chain record type is supported.
      Parameters:
      chainRecordType - a Type indicating a Chain record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - chainRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getChainSearchRecordTypes

      TypeList getChainSearchRecordTypes()
      Gets the supported Chain search types.
      Returns:
      a list containing the supported Chain search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsChainSearchRecordType

      boolean supportsChainSearchRecordType(Type chainSearchRecordType)
      Tests if the given Chain search type is supported.
      Parameters:
      chainSearchRecordType - a Type indicating a Chain search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - chainSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getAntimatroidRecordTypes

      TypeList getAntimatroidRecordTypes()
      Gets the supported Antimatroid record types.
      Returns:
      a list containing the supported Antimatroid types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAntimatroidRecordType

      boolean supportsAntimatroidRecordType(Type antimatroidRecordType)
      Tests if the given Antimatroid record type is supported.
      Parameters:
      antimatroidRecordType - a Type indicating an Antimatroid record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - antimatroidRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getAntimatroidSearchRecordTypes

      TypeList getAntimatroidSearchRecordTypes()
      Gets the supported Antimatroid search record types.
      Returns:
      a list containing the supported Antimatroid search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAntimatroidSearchRecordType

      boolean supportsAntimatroidSearchRecordType(Type antimatroidSearchRecordType)
      Tests if the given Antimatroid search record type is supported.
      Parameters:
      antimatroidSearchRecordType - a Type indicating an Antimatroid search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - antimatroidSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.