package javax.megaco.pkg.AnalogLineSPkg;
import javax.megaco.message.DescriptorType;
import javax.megaco.pkg.ParamValueType;
import javax.megaco.pkg.PkgConsts;
import javax.megaco.pkg.PkgItemParam;
/**
* The MEGACO parameter class for the Init Parameter is associated with On Hook
* and Off Hook event of Analog Line Supervision Package. This class defines all
* the static information for this parameter.
*/
public class AnalogLineSParamInit extends PkgItemParam {
/**
*Identifies Init parameter of the MEGACO Analog Line Supervision Package.
* Its value shall be set equal to 0x0002.
*/
public static final int ANALOG_LINE_PARAM_INIT = 0x0002;
protected int[] paramsItemIds = null;
/**
* Constructs a parameter class for Analog Line Supervision package that
* specifies the parameter as Initial State.
*/
public AnalogLineSParamInit() {
super();
super.paramId = ANALOG_LINE_PARAM_INIT;
super.itemValueType = ParamValueType.M_STRING;
super.paramsDescriptorIds = new int[] { DescriptorType.M_OBSERVED_EVENT_DESC };
this.paramsItemIds = new int[] { AnalogLineSOnEvt.ANALOG_LINE_ONHOOK_EVENT, AnalogLineSOffEvt.ANALOG_LINE_OFFHOOK_EVENT };
}
/**
* The method can be used to get the parameter identifier as defined in the
* MEGACO packages. The implementation of this method in this class returns
* Id of Cadence parameter.
*
* @return paramId - Returns param id as {@link ANALOG_LINE_PARAM_INIT}.
*/
public int getParamId() {
return super.paramId;
}
/**
* The method can be used to get the type of the parameter as defined in the
* MEGACO packages. These could be one of string or enumerated value or
* integer or double value or boolean.
*
* @return It returns {@link ParamValueType.M_STRING}
* indicating that the parameter is a string.
*/
public int getParamValueType() {
return super.itemValueType;
}
/**
* The method can be used to get the item ids corresponding to the
* parameters to which the parameter can be set. This method specifies the
* valid item (event/signal) ids to which the parameter can belong to.
*
* @return The integer values corresponding to On Hook event and Off Hook
* event. Thus this shall return a vector containing the elements
* {@link ANALOG_LINE_ONHOOK_EVENT} and
* {@link ANALOG_LINE_OFFHOOK_EVENT}.
*/
public int[] getParamsItemIds() {
return this.paramsItemIds;
}
/**
* The method can be used to get the package id corresponding to the to
* which the parameter can be set. This method specifies the package for
* which the parameter is valid. Even though the parameter may be set for an
* item, but the parameter may not be valid for package to which the item
* belongs, but may be valid for a package which has extended this package.
*
* @return This shall return {@link PkgConsts.ANALOG_LINE_PACKAGE} as the
* integer value. The integer values are defined in
* {@link PkgConsts}.
*/
public int getParamsPkgId() {
return PkgConsts.ANALOG_LINE_PACKAGE;
}
/**
* The method can be used to get the descriptor ids corresponding to the
* parameters to which the parameter can be set.
*
* @return This parameter can be present in Event descriptor. It shall thus
* return a value {@link DescriptorType.M_OBSERVED_EVENT_DESC}.
*/
public int[] getParamsDescriptorIds() {
return super.paramsDescriptorIds;
}
}