com.highdeal.pnr.hci

Class ChargeActivationSearchFilterModel

java.lang.Object

com.highdeal.filter.hci.SearchFilterModel

com.highdeal.pnr.hci.ChargeActivationSearchFilterModel

All Implemented Interfaces:

XMLMarshallable

public class ChargeActivationSearchFilterModel
extends SearchFilterModel

This class represents the charge activation filter. It allows to retrieve any charge activation by using attributeDescriptionModel to build search criteria.
If no attributeDescriptionModel is given, all the charge activations are returned.
Available main AttributeDescriptionModel names are :

• CODE
• EFFECTIVE_DATE
• EXPIRATION_DATE

Please consult SearchFilterModel for more information. The element name for this charge activation filter is set to "chargeActivationSearchFilter". Available specific formula code for this filter are :

• IS_CONTAINED_CODE

Please consult SpecificFormulaModel for more info on specific formula XML Schema.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="chargeActivationSearchFilter"
               type="SearchFilter" substitutionGroup="SearchFilter"/>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CODE Name of the attributeDescription that searches for code.
static java.lang.String	EFFECTIVE_DATE Name of the attributeDescription that searches for effective date.
static java.lang.String	EXPIRATION_DATE Name of the attributeDescription that searches for expiration date.
static java.lang.String	IS_CONTAINED_CODE

Fields inherited from class com.highdeal.filter.hci.SearchFilterModel

ASC_ORDER, ATTRIBUTES_RESULT_TYPE, DESC_ORDER, FILTER_GROUP_PNR, ID_RESULT_TYPE, ITERATOR_MODE, LIST_MODE, NO_ORDER, OBJECT_RESULT_TYPE

Constructor Summary

Constructors

Constructor and Description
ChargeActivationSearchFilterModel() Builds an empty ChargeActivationSearchFilterModel.

Method Summary

Modifier and Type	Method and Description
int	getFilterGroup() Returns the filter group of the search filter; default is BnR.
java.util.Vector<AttributeDescriptionModel>	getMainAttributeDescriptionCatalog() Returns the list of main attribute descriptions on which the user can build some search criteria; See getMainAttributeDescriptionFromCatalog() for more information.
AttributeDescriptionModel	getMainAttributeDescriptionFromCatalog(java.lang.String name) Returns an empty constraint from a catalog that can be used for specifying a criterion on a main attribute (identified by its name).
java.util.Vector<SpecificFormulaModel>	getSpecificFormulaCatalog() Returns the catalog of available specific formula for the current search filter; See getSpecificFormulaList() for more information;
SpecificFormulaModel	getSpecificFormulaFromCatalog(java.lang.String code) Returns a specific formula from the catalog according to its name; See getSpecificFormulaList() for more information;

Methods inherited from class com.highdeal.filter.hci.SearchFilterModel

addAttributeSelection, addCharacterData, addChild, addSpecificFormula, getAttributeResultList, getAttributeSelectionList, getAttributeSelectionListFromGroup, getFrom, getMaxSize, getResultType, getSearchFilterName, getSearchMode, getSort, getSpecificFormulaList, isCountRequired, marshal, setAttributes, setAttributeSelectionList, setCountRequiredFlag, setFrom, setMaxSize, setResultType, setSearchFilterName, setSearchMode, setSort, setSpecificFormulaList

Methods inherited from class java.lang.Object

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

Field Detail

CODE

public static final java.lang.String CODE

Name of the attributeDescription that searches for code. The type of the corresponding attributeDescription is string

See Also:

Constant Field Values

EFFECTIVE_DATE

public static final java.lang.String EFFECTIVE_DATE

Name of the attributeDescription that searches for effective date. The type of the corresponding attributeDescription is date

See Also:

Constant Field Values

EXPIRATION_DATE

public static final java.lang.String EXPIRATION_DATE

Name of the attributeDescription that searches for expiration date. The type of the corresponding attributeDescription is date

See Also:

Constant Field Values

IS_CONTAINED_CODE

public static final java.lang.String IS_CONTAINED_CODE

See Also:

Constant Field Values

Constructor Detail

ChargeActivationSearchFilterModel

public ChargeActivationSearchFilterModel()

Builds an empty ChargeActivationSearchFilterModel.

Method Detail

getSpecificFormulaFromCatalog

public SpecificFormulaModel getSpecificFormulaFromCatalog(java.lang.String code)

Description copied from class: SearchFilterModel

Returns a specific formula from the catalog according to its name; See getSpecificFormulaList() for more information;

Specified by:

getSpecificFormulaFromCatalog in class SearchFilterModel

Parameters:

code - The code that identifies the specific formula

Returns:

The targeted specific formula. null if the formula does not exist.

getSpecificFormulaCatalog

public java.util.Vector<SpecificFormulaModel> getSpecificFormulaCatalog()

Description copied from class: SearchFilterModel

Returns the catalog of available specific formula for the current search filter; See getSpecificFormulaList() for more information;

Specified by:

getSpecificFormulaCatalog in class SearchFilterModel

Returns:

A list of SpecificFormulaModel

getMainAttributeDescriptionFromCatalog

public AttributeDescriptionModel getMainAttributeDescriptionFromCatalog(java.lang.String name)

Description copied from class: SearchFilterModel

Returns an empty constraint from a catalog that can be used for specifying a criterion on a main attribute (identified by its name).

In main concrete filter, it exists some main attributes on which constraint can port on. The main difference between main attribute group and other attribute groups (additional, parameter, counter) is that those attributes are predefined. So we can establish the catalog of the main attribute for a concrete search filter, for which it will be possible to build some search criteria.

This method gives the possibility to retrieve a predefined constraint on a main attribute that belongs to the main attribute catalog.

Specified by:

getMainAttributeDescriptionFromCatalog in class SearchFilterModel

Parameters:

name - The name of the attribute; see the related concrete class for more information.

Returns:

The related attribute description model or null if the specified attribute name does not match any catalog attribute

getMainAttributeDescriptionCatalog

public java.util.Vector<AttributeDescriptionModel> getMainAttributeDescriptionCatalog()

Description copied from class: SearchFilterModel

Returns the list of main attribute descriptions on which the user can build some search criteria; See getMainAttributeDescriptionFromCatalog() for more information.

Specified by:

getMainAttributeDescriptionCatalog in class SearchFilterModel

Returns:

A list of attribute descriptions that are related to main attributes of the concrete search filter.

getFilterGroup

public int getFilterGroup()

Description copied from class: SearchFilterModel

Returns the filter group of the search filter; default is BnR. This method is surrounded in PnR search filter models.

Overrides:

getFilterGroup in class SearchFilterModel

Returns:

The filter group of the search filter