Package org.osgi.service.tr069todmt

Interface ParameterInfo

public interface ParameterInfo
Maps to the TR-069 ParameterInfoStruct that is returned from the TR069Connector.getParameterNames(String, boolean) method.

  • Method Summary

    Modifier and Type
    Method
    Description
    ParameterValue
    getParameterValue()
    Provide the value of the node.
    String
    getPath()
    The path of the parameter, either a parameter path, an instance path, a table path, or an object path.
    boolean
    isParameter()
    Returns true of this is a parameter, if it returns false it is an object or table.
    boolean
    isWriteable()
    Return true if this parameter is writeable, otherwise false.

  • Method Details

    • getPath

      String getPath()
      The path of the parameter, either a parameter path, an instance path, a table path, or an object path.
      Returns:
      The name of the parameter

    • isWriteable

      boolean isWriteable()
      Return true if this parameter is writeable, otherwise false. A parameter is writeable if the SetParamaterValue with the given name would be successful if an appropriate value was given. If this is a table path, the method specifies whether or not AddObject would be successful. If the parameter path points to a table instance, the method specifies whether or not DeleteObject would be successful.
      Returns:
      If this parameter is writeable

    • isParameter

      boolean isParameter()
      Returns true of this is a parameter, if it returns false it is an object or table.
      Returns:
      true for a parameter, false otherwise

    • getParameterValue

      ParameterValue getParameterValue() throws TR069Exception
      Provide the value of the node. This method throws an exception if it is called for anything but a parameter
      Returns:
      The Parameter Value of the corresponding object
      Throws:
      TR069Exception - If there is a problem