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

Interface OptionModelInterface

All Superinterfaces:

Remote, Serializable

All Known Implementing Classes:

OptionModel, OptionModelSkeleton, OptionModelStub

public interface OptionModelInterface
extends Serializable, Remote

Interface for option model.

Version:

10.1.1

Author:

jmback

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	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.

Method Details

initialize

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

Initialize option model from the XML text.

Parameters:

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

Throws:

M2MException

RemoteException

getDocument

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

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.

Returns:

XML document containing the content of the option model

Throws:

SevereException

M2MException

RemoteException

setOption

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

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

Parameters:

iKey - Key of option

sValue - Value of option

Throws:

M2MException

RemoteException

setInternal

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

Set the option with the given key to be internal

Parameters:

iKey - key of option

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

Throws:

M2MException

RemoteException

setDescription

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

Set the description of the option with the given key.

Parameters:

iKey - key of option

sDescription - new description

Throws:

M2MException

RemoteException

removeOption

void removeOption(String iKey)
           throws M2MException,
RemoteException

Remove the option with this key from the option model.

Parameters:

iKey - key of option

Throws:

M2MException

RemoteException

addValues

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

Add valid values for an existing option.

Parameters:

iKey - key of option

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

Throws:

M2MException

RemoteException

getOption

OptionValue getOption(String iKey)
               throws M2MException,
RemoteException

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

Parameters:

iKey - key of the option

Returns:

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

Throws:

SevereException

SevereException - if the option has not been set

M2MException

RemoteException

getStringOption

String getStringOption(String iKey)
                throws M2MException,
RemoteException

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

Parameters:

iKey - key of the option

Returns:

value

Throws:

SevereException

M2MException

RemoteException

getBooleanOption

boolean getBooleanOption(String iKey)
                  throws M2MException,
RemoteException

Get the value of a boolean option.

Parameters:

iKey - key of the option

Returns:

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

Throws:

SevereException - if the option has not been set

M2MException

RemoteException

existsOption

boolean existsOption(String iKey)
              throws M2MException,
RemoteException

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

Parameters:

iKey -

Returns:

true if the option exists

Throws:

M2MException

RemoteException

getNames

List<OptionName> getNames()
                   throws M2MException,
RemoteException

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

Returns:

List of names.

Throws:

M2MException

RemoteException

getName

OptionName getName(String iKey)
            throws M2MException,
RemoteException

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

Parameters:

iKey - string key of option

Returns:

option name

Throws:

M2MException

RemoteException

getKey

OptionKey getKey(String iKey)
          throws M2MException,
RemoteException

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

Parameters:

iKey - string key of option

Returns:

option key

Throws:

M2MException

RemoteException

hasChanged

boolean hasChanged()
            throws M2MException,
RemoteException

Has option model content changed since last save or load?

Returns:

true, if the content of the model has changed.

Throws:

M2MException

RemoteException

importOption

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

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.

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