ISettingsReadWrite Interface Reference

Inheritance diagram for ISettingsReadWrite:

Public Member Functions
Map< String, Setting >	GetAllProperties ()
	Read all settings.
Map< String, String >	GetAllValues ()
	Read all settings key/value pairs.
Map< String, Setting >	GetProperties (List< String > keys)
	Read multiple key/Setting pair associated with the given list of keys.
Setting	GetProperties (String key)
	Read setting associated with given key.
String	GetValue (String key)
	Read setting value associated with the given key.
Map< String, String >	GetValues (List< String > keys)
	Read key/value pairs associated with the given key.
boolean	SetValue (String keyToSet, String valueToSet)
	Write a setting value associated with the given key. More...
boolean	SetValues (Map< String, String > keysToSet)
	Write multiple settings associated with given keys. More...

Member Function Documentation

SetValue()

boolean SetValue	(	String	keyToSet,
		String	valueToSet
	)

Write a setting value associated with the given key.

Returns true if write is successful. Note: A value intended to be processed as strings should be quoted. e.g., value = SomeString and value = "SomeString" will be sent exactly as received but may be handled differently by the printer.

Implemented in SettingsReadWrite.

SetValues()

boolean SetValues

(

Map< String, String >

keysToSet

)

Write multiple settings associated with given keys.

Returns true if write is successful. Note: Values intended to be processed as strings should be quoted. e.g., value = SomeString and value = "SomeString" will be sent exactly as received but may be handled differently by the printer.

Implemented in SettingsReadWrite.