com.highdeal.filter.hci

Class SpecificFormulaModel

java.lang.Object

com.highdeal.filter.hci.SpecificFormulaModel

All Implemented Interfaces:

XMLMarshallable

public class SpecificFormulaModel
extends java.lang.Object
implements XMLMarshallable

This Java class is used to specify specific search criteria in a search filter; these criteria are predefined in SAP Convergent Charging.

Each predefined formula is identified by a code (String).

Note

This Java class provides a support of parameter handling and can aggregate nested filters.

You cannot create new specific formula; you can only use the formula that are proposed by existing search filters. Refer to your specialized search filter for more information about these codes.

See Also:

SearchFilterModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="specificFormula">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="SearchFilter" minOccurs="0" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="code" type="xs:string" use="required"/> <!-- identification code of the specific formula -->
     <xs:attribute name="parameters" type="xs:string"/> <!-- A CSV string that contains all parameters of the specific formula -->
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
SpecificFormulaModel() Empty contructor.
SpecificFormulaModel(java.lang.String code) INTERNAL USE ONLY - Builds a predefined specific formula.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
void	addParameter(java.lang.String param) Adds a parameter to the parameter list.
java.util.Properties	extractParamAsProperties() Extracts parameters for building a Properties structure from a parameter list like "param1 = value1, param2 = value2...".
java.util.Vector<java.lang.String>	extractParameters() Extracts parameters from the CSV parameters string representation.
java.lang.String	getCode() Returns the mandatory formula code.
SearchFilterModel	getNestedFilter() Returns the optional nested search filter.
java.lang.String	getParameters() Returns a CSV string of parameters.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setCode(java.lang.String code) Sets the required code of the formula; Cannot be set to null.
void	setNestedFilter(SearchFilterModel nested) Sets the optional nested search filter.
void	setParameters(java.lang.String params) Sets the CSV String of parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecificFormulaModel

public SpecificFormulaModel()

Empty contructor.

SpecificFormulaModel

public SpecificFormulaModel(java.lang.String code)

INTERNAL USE ONLY - Builds a predefined specific formula.

Parameters:

code - The expected code of the specific formula

Method Detail

getCode

public java.lang.String getCode()

Returns the mandatory formula code.

Returns:

The code of the formula

setCode

public void setCode(java.lang.String code)

Sets the required code of the formula; Cannot be set to null.

Parameters:

code - The expected code of the specific formula

getParameters

public java.lang.String getParameters()

Returns a CSV string of parameters.

Returns:

The CSV list of optional parameters

setParameters

public void setParameters(java.lang.String params)

Sets the CSV String of parameters.

Parameters:

params - The CSV list of optional parameters

getNestedFilter

public SearchFilterModel getNestedFilter()

Returns the optional nested search filter.

Returns:

The nested filter for establishing joins

setNestedFilter

public void setNestedFilter(SearchFilterModel nested)

Sets the optional nested search filter.

extractParameters

public java.util.Vector<java.lang.String> extractParameters()

Extracts parameters from the CSV parameters string representation.

Returns:

A vector of string parameters

addParameter

public void addParameter(java.lang.String param)

Adds a parameter to the parameter list.

Parameters:

param - The string representation of the added parameter

extractParamAsProperties

public java.util.Properties extractParamAsProperties()

Extracts parameters for building a Properties structure from a parameter list like "param1 = value1, param2 = value2...".

Returns:

The detailed structure

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into