Package de.mid.innovator.m2msdk.model.configuration

Interface ConfigurationItemIF

All Superinterfaces:

Comparable<ConfigurationItemIF>, Serializable

public interface ConfigurationItemIF
extends Comparable<ConfigurationItemIF>, Serializable

ConfigurationItems represent the content of a configuration. The configuration is organized as a tree of ConfigurationItems. For that, every ConfigurationItem can have a parent and children elements. It can also have parameters and options.

Version:

10.1.1

Author:

Fabian Knoll fabian.knoll@koelsch-altmann.de

Method Summary

Modifier and Type	Method	Description
ConfigurationItemIF	addNewChild(String iName, ConfigurationTag iType, ConfigurationItemIF after, ConfigurationItemIF before, boolean bCheckOnly)	Add a new child with a name and type.
ConfigurationItemIF	addParameter(String iName, String iValue, boolean bCheckOnly)	Add a new parameter with name.
ConfigurationItemIF	copy(ConfigurationItemIF newParent, boolean bCheckOnly)	Copy this configuration item including all transitively owned children, options and parameters.
ConfigurationItemIF	expand()	Expand this configuration item and its complete content so that all references are instantiated.
ConfigurationItems	getBySymbolicName(String value)	Get the configuration items which have the given symbolic name.
ConfigurationItems	getByTag(String value)	Get the configuration items which have the given tag proposal.
ConfigurationItems	getChildren()	Get the list of children of this item.
ConfigurationItems	getChildrenTransitive()	Get all transitive children.
String	getClassName()	Get the name of the class.
String	getComment()	Get the name comment of a configuration item.
ConfigurationItems	getConfigurationItems(ConfigurationTag searchTag, ConfigurationItemSearchMode mode)
ConfigurationTag	getConfigurationTag()	Get the type.
String	getDefOwnedParameterValue(ParameterTemplate t)	Get the parameter value of a certain parameter.
Boolean	getDefOwnedParameterValueBoolean(ParameterTemplate pt)
String	getDisplayName()	Get a displayable name of the configuration item.
org.jdom2.Element	getElement(boolean iCustomer)	Get XML element containing the item, its parameters and options and its children.
String	getIcon()	Get the icon of the configuration item.
String	getId()	Get the ID of this item.
String	getName()	Get the name attribute of a configuration item.
ConfigurationItemIF	getOwnedChild(ConfigurationTag tag)	Get the first child with the given type.
ConfigurationItems	getOwnedChildren(ConfigurationTag tag)	Get all owned children with the given type.
ParameterIF	getOwnedParameter(String name)	Get the owned parameter with the given name.
ParameterList	getOwnedParameters()	Get all owned parameters.
ParameterList	getOwnedParameters(String name)	Get the owned parameter with the given name.
ParameterList	getParametersTransitive()	Get all transitive parameters of this item.
ParameterList	getParametersTransitive(String name)	Get all transitive parameters of this item with given name.
ConfigurationItemIF	getParent()	Get the parent of this item.
String	getPath()	Get the qualified path of a configuration item.
Identifier	getQualifiedId()	Get the qualified ID of this item.
String	getValue()	Get value of configuration item.
boolean	hasChildren()	Has this item any children?
boolean	isCustomer()	Is the item defined by customer?
boolean	isEnabled()	Is the item enabled for transformation?
boolean	isRoot()	Is the item a root?
boolean	isValid()	Is the item valid?
void	removeParameter(ParameterIF iParameter, boolean bCheckOnly)	Remove existing parameter.
void	setChildren(ConfigurationItems iList, boolean bCheckOnly)	Set the list of children.
void	setClassName(String iClassName, boolean bCheckOnly)	Set the name of the class.
void	setComment(String iComment, boolean bCheckOnly)	set the comment attribute of a configuration item.
void	setConfigurationTag(ConfigurationTag iType, boolean bCheckOnly)	Set the type.
void	setCustomer(boolean iCustomer, boolean bCheckOnly, boolean bForce)	The item is defined by customer or not.
void	setEnabled(boolean iEnabled, boolean bCheckOnly)	Enable or disable the item.
void	setId(String iId, boolean bCheckOnly)	Set the id of a configuration item.
void	setName(String iName, boolean bCheckOnly)
void	setParent(ConfigurationItemIF iParent, boolean bCheckOnly)	Set the parent of this item.
void	setValid(boolean iValid, boolean bCheckOnly)	Set the item valid or invalid.
void	setValue(String iValue, boolean bCheckOnly)	Set the value of the configuration item.
void	validate()	Validate item and check for validity of itself and its parameters.

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

getName

String getName()
        throws RemoteException,
M2MException

Get the name attribute of a configuration item.

Returns:

The Name of the ConfigurationItem

Throws:

M2MException

RemoteException

getPath

String getPath()
        throws RemoteException,
M2MException

Get the qualified path of a configuration item.

Returns:

The qualified path of the ConfigurationItem

Throws:

M2MException

RemoteException

getDisplayName

String getDisplayName()
               throws M2MException,
RemoteException

Get a displayable name of the configuration item.

Returns:

display name

Throws:

M2MException

RemoteException

RemoteException

setName

void setName(String iName,
 boolean bCheckOnly)
      throws RemoteException,
M2MException

Parameters:

iName - name of the item

bCheckOnly - only check if possible

Throws:

RemoteException

M2MException

getConfigurationTag

ConfigurationTag getConfigurationTag()

Get the type.

Returns:

The Name of the type of the ConfigurationItem. It is the name of the XML tag.

setConfigurationTag

void setConfigurationTag(ConfigurationTag iType,
 boolean bCheckOnly)
                  throws RemoteException

Set the type.

Parameters:

iType - type of the configuration item

bCheckOnly -

Throws:

RemoteException

getIcon

String getIcon()
        throws RemoteException,
M2MException

Get the icon of the configuration item. Normally the icon is defined by the type of the item.

Returns:

name of icon

Throws:

M2MException

RemoteException

getId

String getId()

Get the ID of this item.

Returns:

The ID of the ConfigurationItem

getQualifiedId

Identifier getQualifiedId()
                   throws AbortException,
RemoteException

Get the qualified ID of this item.

Returns:

The qualified ID is separated by dots and contains the IDs of all parents.

Throws:

AbortException

RemoteException

getClassName

String getClassName()
             throws RemoteException,
M2MException

Get the name of the class.

Returns:

The name of the class of the ConfigurationItem.

Throws:

M2MException

RemoteException

setClassName

void setClassName(String iClassName,
 boolean bCheckOnly)
           throws RemoteException,
M2MException

Set the name of the class.

Parameters:

iClassName - Name of the class

bCheckOnly -

Throws:

RemoteException

M2MException

isRoot

boolean isRoot()

Is the item a root?

Returns:

True if this ConfigurationItem is the top-level item of the configuration tree.

getParent

ConfigurationItemIF getParent()

Get the parent of this item.

Returns:

The parent of this ConfigurationItem.

setParent

void setParent(ConfigurationItemIF iParent,
 boolean bCheckOnly)
        throws RemoteException,
M2MException

Set the parent of this item.

Parameters:

iParent - new parent

bCheckOnly -

Throws:

RemoteException

M2MException

hasChildren

boolean hasChildren()

Has this item any children?

Returns:

True, if this ConfigurationItem has child elements.

isEnabled

boolean isEnabled()
           throws RemoteException,
M2MException

Is the item enabled for transformation?

Returns:

true, if the item is enabled.

Throws:

M2MException

RemoteException

setEnabled

void setEnabled(boolean iEnabled,
 boolean bCheckOnly)
         throws RemoteException,
M2MException

Enable or disable the item.

Parameters:

iEnabled - true to enabled the item

bCheckOnly - true means do not modify the model

Throws:

RemoteException

M2MException

isCustomer

boolean isCustomer()
            throws RemoteException,
M2MException

Is the item defined by customer?

Returns:

true, if the item is enabled.

Throws:

M2MException

RemoteException

setCustomer

void setCustomer(boolean iCustomer,
 boolean bCheckOnly,
 boolean bForce)
          throws RemoteException,
M2MException

The item is defined by customer or not.

Parameters:

iCustomer - true to define the item by customer

bCheckOnly - true means do not modify the model

bForce - force means set in any case

Throws:

RemoteException

M2MException

setId

void setId(String iId,
 boolean bCheckOnly)
    throws RemoteException,
AbortException,
M2MException

Set the id of a configuration item.

Parameters:

iId - id to set

bCheckOnly - true means do not modify the model

Throws:

RemoteException

AbortException

M2MException

isValid

boolean isValid()
         throws RemoteException,
M2MException

Is the item valid?

Returns:

true, if the item is valid.

Throws:

M2MException

RemoteException

validate

void validate()
       throws RemoteException,
M2MException

Validate item and check for validity of itself and its parameters.

Throws:

M2MException

RemoteException

setValid

void setValid(boolean iValid,
 boolean bCheckOnly)
       throws RemoteException,
M2MException

Set the item valid or invalid.

Parameters:

iValid - true for valid

bCheckOnly - true means do not modify the model

Throws:

M2MException

RemoteException

getChildren

ConfigurationItems getChildren()
                        throws RemoteException,
M2MException

Get the list of children of this item.

Returns:

A list of direct owned children of these ConfigurationItem

Throws:

M2MException

RemoteException

getOwnedChildren

ConfigurationItems getOwnedChildren(ConfigurationTag tag)

Get all owned children with the given type.

Parameters:

tag - filter the children for the specified type

Returns:

a list of direct owned children with given type

getOwnedChild

ConfigurationItemIF getOwnedChild(ConfigurationTag tag)

Get the first child with the given type.

Parameters:

tag - the specified type

Returns:

the first child

setChildren

void setChildren(ConfigurationItems iList,
 boolean bCheckOnly)
          throws RemoteException,
M2MException

Set the list of children. This method maybe used to remove children or to sort them.

Parameters:

iList - The list of all children.

bCheckOnly -

Throws:

RemoteException

M2MException

addNewChild

ConfigurationItemIF addNewChild(String iName,
 ConfigurationTag iType,
 ConfigurationItemIF after,
 ConfigurationItemIF before,
 boolean bCheckOnly)
                         throws RemoteException,
AbortException,
M2MException

Add a new child with a name and type. Append to list of children.

Parameters:

iName - Name of the new child

iType - Type of the new child (XML tag name)

after - item to insert after (maybe null, then it is appended at the end)

before - item to insert before (maybe null, then it is added according to parameter "after")

bCheckOnly - only check if this is possible

Returns:

the new child

Throws:

RemoteException

AbortException

M2MException

getChildrenTransitive

ConfigurationItems getChildrenTransitive()

Get all transitive children.

Returns:

a list of children with given type

getOwnedParameters

ParameterList getOwnedParameters()
                          throws RemoteException,
M2MException

Get all owned parameters.

Returns:

A list of Parameter types, which are owned by this ConfigurationItem

Throws:

M2MException

RemoteException

getOwnedParameter

ParameterIF getOwnedParameter(String name)
                       throws RemoteException,
M2MException

Get the owned parameter with the given name.

Parameters:

name -

Returns:

if found, parameter with given name, else null

Throws:

M2MException

RemoteException

getOwnedParameters

ParameterList getOwnedParameters(String name)
                          throws RemoteException,
M2MException

Get the owned parameter with the given name.

Parameters:

name -

Returns:

if found, parameter with given name, else null

Throws:

M2MException

RemoteException

getParametersTransitive

ParameterList getParametersTransitive()
                               throws RemoteException,
M2MException

Get all transitive parameters of this item.

Returns:

A list of Parameter, which are directly owned and of all children transitively.

Throws:

M2MException

RemoteException

getParametersTransitive

ParameterList getParametersTransitive(String name)
                               throws RemoteException,
M2MException

Get all transitive parameters of this item with given name.

Returns:

A list of Parameter, which are directly owned and of all children transitively.

Throws:

M2MException

RemoteException

getDefOwnedParameterValue

String getDefOwnedParameterValue(ParameterTemplate t)
                          throws RemoteException,
M2MException

Get the parameter value of a certain parameter.

Parameters:

t - Parameter template

Returns:

if found, the string value of a parameter with given name. If not found, return default value.

Throws:

M2MException

RemoteException

addParameter

ConfigurationItemIF addParameter(String iName,
 String iValue,
 boolean bCheckOnly)
                          throws RemoteException,
M2MException

Add a new parameter with name.

Parameters:

iName - Name of parameter

iValue - Value of parameter

bCheckOnly - only check if possible

Returns:

newly created parameter

Throws:

RemoteException

M2MException

removeParameter

void removeParameter(ParameterIF iParameter,
 boolean bCheckOnly)
              throws RemoteException

Remove existing parameter.

Parameters:

iParameter - parameter to be removed

bCheckOnly -

Throws:

RemoteException

copy

ConfigurationItemIF copy(ConfigurationItemIF newParent,
 boolean bCheckOnly)
                  throws RemoteException,
AbortException,
M2MException

Copy this configuration item including all transitively owned children, options and parameters.

Parameters:

newParent - new parent of copy; maybe null: in this case the parent stays the same

bCheckOnly -

Returns:

Copy of this item

Throws:

RemoteException

AbortException

M2MException

getDefOwnedParameterValueBoolean

Boolean getDefOwnedParameterValueBoolean(ParameterTemplate pt)
                                  throws RemoteException,
M2MException

Throws:

RemoteException

M2MException

getElement

org.jdom2.Element getElement(boolean iCustomer)
                      throws RemoteException,
M2MException

Get XML element containing the item, its parameters and options and its children.

Parameters:

iCustomer - export it for customer

Returns:

XML element

Throws:

M2MException

RemoteException

getComment

String getComment()
           throws RemoteException,
M2MException

Get the name comment of a configuration item.

Returns:

The comment of the ConfigurationItem

Throws:

RemoteException

M2MException

setComment

void setComment(String iComment,
 boolean bCheckOnly)
         throws RemoteException,
M2MException

set the comment attribute of a configuration item.

Parameters:

iComment - The comment of the ConfigurationItem

bCheckOnly -

Throws:

RemoteException

M2MException

getConfigurationItems

ConfigurationItems getConfigurationItems(ConfigurationTag searchTag,
 ConfigurationItemSearchMode mode)
                                  throws RemoteException,
M2MException

Throws:

RemoteException

M2MException

setValue

void setValue(String iValue,
 boolean bCheckOnly)
       throws RemoteException,
M2MException

Set the value of the configuration item.

Parameters:

iValue - value of the item

bCheckOnly - only check if possible

Throws:

RemoteException

M2MException

getValue

String getValue()
         throws RemoteException,
M2MException

Get value of configuration item.

Returns:

value of the item

Throws:

M2MException

RemoteException

expand

ConfigurationItemIF expand()
                    throws RemoteException,
M2MException

Expand this configuration item and its complete content so that all references are instantiated.

Returns:

if this is a reference return a copy of the referenced item, else return this item

Throws:

RemoteException

M2MException

getBySymbolicName

ConfigurationItems getBySymbolicName(String value)
                              throws RemoteException,
M2MException

Get the configuration items which have the given symbolic name.

Parameters:

value - Symbolic name

Returns:

configuration item

Throws:

RemoteException

M2MException

getByTag

ConfigurationItems getByTag(String value)
                     throws RemoteException,
M2MException

Get the configuration items which have the given tag proposal.

Parameters:

value - Tag proposal

Returns:

configuration item

Throws:

RemoteException

M2MException