Package de.mid.innovator.m2msdk.model.option

Class OptionModel

java.lang.Object

de.mid.innovator.m2msdk.model.option.OptionModel

All Implemented Interfaces:

OptionModelInterface, Serializable, Remote

public class OptionModel
extends Object
implements OptionModelInterface

Option model keeping all options and their values.

Version:

10.1.1

Author:

prhuettn

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OptionModel(SessionInterface iSession)	Create an option model.

Method Summary

Modifier and Type	Method	Description
void	addValues(String iKey, List<String> listValue)	Add valid values for an existing option.
boolean	existsOption(String iKey)	Checks if option with key exists in this option model or in any imported option model.
boolean	getBooleanOption(String iKey)	Get the value of a boolean option.
org.jdom2.Document	getDocument()	Get content of option model as a document.
OptionKey	getKey(String iKey)	Get key for existing option from this option model or top option model.
OptionName	getName(String iKey)	Get name for existing option in this option model or in any imported option model.
List<OptionName>	getNames()	Get names for all existing (non-internal) options of this model and imported models.
OptionValue	getOption(String iKey)	Get the value of an option from this option model or from any imported option model.
String	getStringOption(String iKey)	Get the value of a string option from this option model or from any imported option model.
boolean	hasChanged()	Has option model content changed since last save or load?
OptionModelInterface	importOption(org.jdom2.Document doc)	Import the option model given as document into this option model and return the imported option model.
void	initialize(org.jdom2.Document iXMLText)	Initialize option model from the XML text.
void	removeOption(String iKey)	Remove the option with this key from the option model.
void	setChanged(boolean ibChanged)
void	setDescription(String iKey, String sDescription)	Set the description of the option with the given key.
void	setInternal(String iKey, boolean bInternal)	Set the option with the given key to be internal
void	setOption(String iKey, String sValue)	Create a new option or modify the properties of an option.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

OptionModel

public OptionModel(SessionInterface iSession)

Create an option model.

Parameters:

iSession - current session

Method Details

initialize

public void initialize(org.jdom2.Document iXMLText)
                throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Initialize option model from the XML text.

Specified by:

initialize in interface OptionModelInterface

Parameters:

iXMLText - XML text containing the configuration of a option model.

Throws:

RemoteException

M2MException

getDocument

public org.jdom2.Document getDocument()
                               throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Get content of option model as a document. Only non-internal options are saved. Only the options in this option model are saved, not from the imported. Important side effect: The option model is marked as unchanged because it is assumed that the reading into a document is used to save the model.

Specified by:

getDocument in interface OptionModelInterface

Returns:

XML document containing the content of the option model

Throws:

RemoteException

M2MException

existsOption

public boolean existsOption(String iKey)
                     throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Checks if option with key exists in this option model or in any imported option model.

Specified by:

existsOption in interface OptionModelInterface

Parameters:

iKey -

Returns:

true if the option exists

Throws:

RemoteException

M2MException

setOption

public void setOption(String iKey,
 String sValue)
               throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Create a new option or modify the properties of an option.

Specified by:

setOption in interface OptionModelInterface

Parameters:

iKey - Key of option

sValue - Value of option

Throws:

RemoteException

M2MException

addValues

public void addValues(String iKey,
 List<String> listValue)
               throws M2MException,
RemoteException

Description copied from interface: OptionModelInterface

Add valid values for an existing option.

Specified by:

addValues in interface OptionModelInterface

Parameters:

iKey - key of option

listValue - list of allowed values for the option, empty list means all values are allowed

Throws:

M2MException

RemoteException

getOption

public OptionValue getOption(String iKey)
                      throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Get the value of an option from this option model or from any imported option model.

Specified by:

getOption in interface OptionModelInterface

Parameters:

iKey - key of the option

Returns:

value value of the option, if the option has been set

Throws:

RemoteException

M2MException

getStringOption

public String getStringOption(String iKey)
                       throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Get the value of a string option from this option model or from any imported option model.

Specified by:

getStringOption in interface OptionModelInterface

Parameters:

iKey - key of the option

Returns:

value

Throws:

RemoteException

M2MException

getBooleanOption

public boolean getBooleanOption(String iKey)
                         throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Get the value of a boolean option.

Specified by:

getBooleanOption in interface OptionModelInterface

Parameters:

iKey - key of the option

Returns:

value value of the option, if the option has been set

Throws:

RemoteException

M2MException

getNames

public List<OptionName> getNames()
                          throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Get names for all existing (non-internal) options of this model and imported models.

Specified by:

getNames in interface OptionModelInterface

Returns:

List of names.

Throws:

RemoteException

M2MException

getKey

public OptionKey getKey(String iKey)
                 throws RemoteException,
M2MException

Description copied from interface: OptionModelInterface

Get key for existing option from this option model or top option model.

Specified by:

getKey in interface OptionModelInterface

Parameters:

iKey - string key of option

Returns:

option key

Throws:

RemoteException

M2MException

hasChanged

public boolean hasChanged()
                   throws M2MException,
RemoteException

Description copied from interface: OptionModelInterface

Has option model content changed since last save or load?

Specified by:

hasChanged in interface OptionModelInterface

Returns:

true, if the content of the model has changed.

Throws:

M2MException

RemoteException

setChanged

public void setChanged(boolean ibChanged)

importOption

public OptionModelInterface importOption(org.jdom2.Document doc)
                                  throws M2MException,
RemoteException

Description copied from interface: OptionModelInterface

Import the option model given as document into this option model and return the imported option model. If there is already an imported model, reload it from document. If no document is given, simply return the imported option model. If there is an option model, then any later read access to an option will be forwarded to the imported model,if the option is not in the option model.

Specified by:

importOption in interface OptionModelInterface

Parameters:

doc - document describing the imported option model, maybe null to not import a new model but to only get the imported model

Returns:

imported option model

Throws:

M2MException

RemoteException

removeOption

public void removeOption(String iKey)
                  throws M2MException,
RemoteException

Description copied from interface: OptionModelInterface

Remove the option with this key from the option model.

Specified by:

removeOption in interface OptionModelInterface

Parameters:

iKey - key of option

Throws:

M2MException

RemoteException

getName

public OptionName getName(String iKey)
                   throws M2MException,
RemoteException

Description copied from interface: OptionModelInterface

Get name for existing option in this option model or in any imported option model.

Specified by:

getName in interface OptionModelInterface

Parameters:

iKey - string key of option

Returns:

option name

Throws:

M2MException

RemoteException

setInternal

public void setInternal(String iKey,
 boolean bInternal)
                 throws M2MException,
RemoteException

Description copied from interface: OptionModelInterface

Set the option with the given key to be internal

Specified by:

setInternal in interface OptionModelInterface

Parameters:

iKey - key of option

bInternal - true means internal. An option already set to internal cannot be set external again.

Throws:

M2MException

RemoteException

setDescription

public void setDescription(String iKey,
 String sDescription)
                    throws M2MException,
RemoteException

Description copied from interface: OptionModelInterface

Set the description of the option with the given key.

Specified by:

setDescription in interface OptionModelInterface

Parameters:

iKey - key of option

sDescription - new description

Throws:

M2MException

RemoteException

toString

public String toString()

Overrides:

toString in class Object