com.francetelecom.admindm.model
Interface IParameterData

All Known Implementing Classes:
ParameterData

public interface IParameterData

The Interface IParameterData.

Author:
Olivier Beyler - OrangeLabs -

Method Summary
 void addEvent(EventStruct eventStruct)
          Adds the event.
 void addObserver(java.util.Observer observer)
          Adds the observer.
 void addOrUpdateParameter(Parameter param, java.lang.String updater)
          Adds the or update parameter.
 void addOutgoingRequest(RPCMethod rpcMethod)
          Adds the outgoing request and ask for creating a new session.
 Parameter createOrRetrieveParameter(java.lang.String key)
          Creates the or retrieve parameter.
 void deleteEvent(EventStruct eventStruct)
          Delete event.
 void deleteParam(Parameter param)
          Delete parameter.
 java.util.List extractParameterList(java.lang.String filter)
          Extract parameter list.
 java.util.List extractParameterList(java.lang.String[] filters)
          Extract a list of parameter corresponding to the parameterName criteria.
 ICom getCom()
          Gets the com.
 DeviceIdStruct getDeviceId()
          Gets the device id.
 java.lang.Object[] getEventsArray()
          Gets the events array.
 java.util.List getLsOutgoingRequest()
          Gets the list of outgoing request.
 Parameter getParameter(java.lang.String value)
          Gets the parameter.
 java.util.Iterator getParameterIterator()
          Gets the parameter iterator.
 java.lang.String getParameterKey()
          Gets the parameter key.
 java.lang.Object[] getParametersArray()
          Gets the parameters array.
 java.lang.String getRoot()
          Gets the root of data model.
 java.util.Set getSetParamChanged()
          Gets the sets the param changed.
 boolean isModelLoaded()
          Checks if is model loaded.
 void removeOutgoingRequest(RPCMethod rpcMethod)
          Remove the outgoing request and ask for creating a new session.
 void setCom(ICom pCom)
          Sets the com.
 void setModelLoaded(boolean isModelLoaded)
          Sets the model loaded.
 void setParameterKey(java.lang.String pParameterKey)
          Sets the parameter key.
 void setRoot(java.lang.String root)
          Sets the root of the data model.
 

Method Detail

getRoot

java.lang.String getRoot()
Gets the root of data model.

Returns:
root

setRoot

void setRoot(java.lang.String root)
Sets the root of the data model.

Parameters:
root - root

getLsOutgoingRequest

java.util.List getLsOutgoingRequest()
Gets the list of outgoing request.

Returns:
the list of outgoing request

getParameterIterator

java.util.Iterator getParameterIterator()
Gets the parameter iterator.

Returns:
the parameter iterator

isModelLoaded

boolean isModelLoaded()
Checks if is model loaded.

Returns:
true, if is model loaded

setModelLoaded

void setModelLoaded(boolean isModelLoaded)
Sets the model loaded.

Parameters:
isModelLoaded - the new model loaded

getParameter

Parameter getParameter(java.lang.String value)
Gets the parameter.

Parameters:
value - the value
Returns:
a Parameter

createOrRetrieveParameter

Parameter createOrRetrieveParameter(java.lang.String key)
                                    throws Fault
Creates the or retrieve parameter.

Parameters:
key - the key
Returns:
the parameter
Throws:
Fault - the fault

addOrUpdateParameter

void addOrUpdateParameter(Parameter param,
                          java.lang.String updater)
                          throws Fault
Adds the or update parameter.

Parameters:
param - the parameter
updater - the updater
Throws:
Fault - the fault

addObserver

void addObserver(java.util.Observer observer)
Adds the observer.

Parameters:
observer - the observer

extractParameterList

java.util.List extractParameterList(java.lang.String filter)
                                    throws Fault
Extract parameter list.

Parameters:
filter - the filter
Returns:
the list
Throws:
Fault - the fault

extractParameterList

java.util.List extractParameterList(java.lang.String[] filters)
                                    throws Fault
Extract a list of parameter corresponding to the parameterName criteria.

Parameters:
filters - string array of full or partial path of a parameter
Returns:
List of parameter
Throws:
Fault - in case of parameterName'array contains unknown parameter or unknown partial path.

deleteParam

void deleteParam(Parameter param)
Delete parameter.

Parameters:
param - the parameter

addEvent

void addEvent(EventStruct eventStruct)
Adds the event.

Parameters:
eventStruct - the event structure

deleteEvent

void deleteEvent(EventStruct eventStruct)
Delete event.

Parameters:
eventStruct - the event structure

getParametersArray

java.lang.Object[] getParametersArray()
Gets the parameters array.

Returns:
the parameters array

setCom

void setCom(ICom pCom)
Sets the com.

Parameters:
pCom - the com

getCom

ICom getCom()
Gets the com.

Returns:
the com

getEventsArray

java.lang.Object[] getEventsArray()
Gets the events array.

Returns:
the events array

getDeviceId

DeviceIdStruct getDeviceId()
Gets the device id.

Returns:
the device id

setParameterKey

void setParameterKey(java.lang.String pParameterKey)
Sets the parameter key.

Parameters:
pParameterKey - the parameter key

getParameterKey

java.lang.String getParameterKey()
Gets the parameter key.

Returns:
the parameter key

addOutgoingRequest

void addOutgoingRequest(RPCMethod rpcMethod)
Adds the outgoing request and ask for creating a new session.

Parameters:
rpcMethod - the method

removeOutgoingRequest

void removeOutgoingRequest(RPCMethod rpcMethod)
Remove the outgoing request and ask for creating a new session.

Parameters:
rpcMethod - the method

getSetParamChanged

java.util.Set getSetParamChanged()
Gets the sets the param changed.

Returns:
the sets the param changed


Copyright © 2011 FranceTelecom. All Rights Reserved.