Package com.zebra.sdk.settings

Class Setting

Object
com.zebra.sdk.settings.Setting
All Implemented Interfaces:
Serializable
public class Setting extends Object implements Serializable
A class that represents an internal device setting.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Setting()
    Instantiates the Setting class

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAccess()
    Returns a string that describes the access permissions for the setting.
    boolean
    getArchive()
    Return true if this setting can be applied when loading a backup.
    boolean
    getClone()
    Returns true if this setting can be applied when loading a profile.
    String
    getRange()
    Returns a string that describes the acceptable range of values for this setting.
    String
    getType()
    Returns a string describing the data type of the setting.
    String
    getValue()
    Returns the setting's value.
    boolean
    isReadOnly()
    Returns true if the setting does not have write access.
    boolean
    isValid(String value)
    Returns true if value is valid for the given setting.
    boolean
    isWriteOnly()
    Returns true if the setting does not have read access.
    void
    setAccess(String access)
    Set the access permissions for this setting.
    void
    setArchive(boolean archive)
    Set to true if this setting should be applied when loading a backup.
    void
    setClone(boolean clone)
    Set to true if this setting should be applied when loading a profile.
    void
    setRange(String range)
    Takes a string that describes the acceptable range of values for this setting.
    void
    setType(String type)
    Set the setting's data type.
    void
    setValue(String newValue)
    Set the setting's value.
    String
    toString()
    Returns the Setting data including the value, type, and range for the setting.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Setting

      public Setting()
      Instantiates the Setting class

  • Method Details

    • getRange

      public String getRange()
      Returns a string that describes the acceptable range of values for this setting.
      Returns:
      a string that describes the acceptable range of values for this setting

    • setRange

      public void setRange(String range)
      Takes a string that describes the acceptable range of values for this setting.
      Parameters:
      range - a string that describes the acceptable range of values for this setting

    • isValid

      public boolean isValid(String value)
      Returns true if value is valid for the given setting.
      Parameters:
      value - setting value.
      Returns:
      true if value is within the setting's range

    • getClone

      public boolean getClone()
      Returns true if this setting can be applied when loading a profile.
      Returns:
      true if this setting can be applied when loading a profile

    • setClone

      public void setClone(boolean clone)
      Set to true if this setting should be applied when loading a profile.
      Parameters:
      clone - set to true if this setting should be applied when loading a profile

    • getArchive

      public boolean getArchive()
      Return true if this setting can be applied when loading a backup.
      Returns:
      true if this setting can be applied when loading a backup

    • setArchive

      public void setArchive(boolean archive)
      Set to true if this setting should be applied when loading a backup.
      Parameters:
      archive - set to true if this setting should be applied when loading a backup

    • getAccess

      public String getAccess()
      Returns a string that describes the access permissions for the setting. RW is returned for settings that have read and write permissions. R is returned for settings that are read-only W is returned for settings that are write-only
      Returns:
      a string that describes the access permissions for the setting

    • setAccess

      public void setAccess(String access)
      Set the access permissions for this setting. RW is returned for settings that have read and write permissions. R is returned for settings that are read-only W is returned for settings that are write-only
      Parameters:
      access - the access permissions for this setting

    • getType

      public String getType()
      Returns a string describing the data type of the setting.
      Returns:
      the setting's data type

    • setType

      public void setType(String type)
      Set the setting's data type.
      Parameters:
      type - a string describing the data type of the setting

    • getValue

      public String getValue()
      Returns the setting's value.
      Returns:
      the setting's value

    • setValue

      public void setValue(String newValue)
      Set the setting's value.
      Parameters:
      newValue - the settings value

    • isReadOnly

      public boolean isReadOnly()
      Returns true if the setting does not have write access.
      Returns:
      true if the setting does not have write access

    • isWriteOnly

      public boolean isWriteOnly()
      Returns true if the setting does not have read access.
      Returns:
      true if the setting does not have read access

    • toString

      public String toString()
      Returns the Setting data including the value, type, and range for the setting.
      Overrides:
      toString in class Object
      See Also: