Interface WebSubscriptionLocationAttributes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAddressPrefix()
      Returns the address prefix that is defined as a part of the device
      java.lang.String getAddressSuffix()
      Returns the address suffix that is defined as a part of the device
      java.lang.String getPath()
      Returns the device's base path.
      boolean hasPath()
      Indicates if the device has a predefined path prefix
      boolean isAddressPrefixBrowsable()
      Indicates if the address prefix that is defined in the device definition contains any macros
      boolean requiresAddress()  
    • Method Detail

      • requiresAddress

        boolean requiresAddress()
        Returns:
        whether this device requires the user to type in an absolute/relative address. For instance, in the case of a file location, depending on the type of device used, the user may or may not need to enter a path for where his file will be saved
      • getAddressPrefix

        java.lang.String getAddressPrefix()
        Returns the address prefix that is defined as a part of the device
        Returns:
        the address prefix
      • getAddressSuffix

        java.lang.String getAddressSuffix()
        Returns the address suffix that is defined as a part of the device
        Returns:
        the address suffix
      • isAddressPrefixBrowsable

        boolean isAddressPrefixBrowsable()
        Indicates if the address prefix that is defined in the device definition contains any macros
        Returns:
        value to indicate if the address prefix that is defined in the device definition contains any macros
      • hasPath

        boolean hasPath()
        Indicates if the device has a predefined path prefix
        Returns:
        value to if the device has an predefined path prefix
      • getPath

        java.lang.String getPath()
        Returns the device's base path.
        Returns:
        the device's base path