Interface LexiconProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
LexiconManager, LexiconProxyManager
public interface LexiconProfile extends OsidProfile

The lexicon profile describes the interoperability among lexicon services.

  • Method Details

    • supportsVisibleFederation

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

    • supportsText

      boolean supportsText()
      Tests if a text service is supported for the current agent.
      Returns:
      true if text is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTextLookup

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

    • supportsTextQuery

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

    • supportsTextSearch

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

    • supportsTextAdmin

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

    • supportsTextNotification

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

    • supportsTextPress

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

    • supportsTextPressAssignment

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

    • supportsTextSmartPress

      boolean supportsTextSmartPress()
      Tests if a text smart press service is supported.
      Returns:
      true if an v smart press service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTextReturn

      boolean supportsTextReturn()
      Tests if returning texts is supported.
      Returns:
      true if returning texts is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIdiomLookup

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

    • supportsIdiomQuery

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

    • supportsIdiomSearch

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

    • supportsIdiomAdmin

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

    • supportsIdiomNotification

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

    • supportsIdiomPress

      boolean supportsIdiomPress()
      Tests if an idiom press lookup service is supported.
      Returns:
      true if an idiom press lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIdiomPressAssignment

      boolean supportsIdiomPressAssignment()
      Tests if an idiom press assignment service is supported.
      Returns:
      true if an idiom to press assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIdiomSmartPress

      boolean supportsIdiomSmartPress()
      Tests if an idiom smart press service is supported.
      Returns:
      true if a smart press service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterLookup

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

    • supportsParameterQuery

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

    • supportsParameterSearch

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

    • supportsParameterAdmin

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

    • supportsParameterNotification

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

    • supportsParameterPress

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

    • supportsParameterPressAssignment

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

    • supportsParameterSmartPress

      boolean supportsParameterSmartPress()
      Tests if a parameter smart press lookup service is supported.
      Returns:
      true if a parameter smart press service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPressLookup

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

    • supportsPressQuery

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

    • supportsPressSearch

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

    • supportsPressAdmin

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

    • supportsPressNotification

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

    • supportsPressHierarchy

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

    • supportsPressHierarchyDesign

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

    • supportsLexiconBatch

      boolean supportsLexiconBatch()
      Tests for the availability of a lexicon batch service.
      Returns:
      true if lexicon batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getTextRecordTypes

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

    • supportsTextRecordType

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

    • getTextSearchRecordTypes

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

    • supportsTextSearchRecordType

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

    • getIdiomRecordTypes

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

    • supportsIdiomRecordType

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

    • getIdiomSearchRecordTypes

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

    • supportsIdiomSearchRecordType

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

    • getParameterRecordTypes

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

    • supportsParameterRecordType

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

    • getParameterSearchRecordTypes

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

    • supportsParameterSearchRecordType

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

    • getPressRecordTypes

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

    • supportsPressRecordType

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

    • getPressSearchRecordTypes

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

    • supportsPressSearchRecordType

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