com.highdeal.pnr.hci
Class SubscriberAccountSearchFilterModel

java.lang.Object
  com.highdeal.filter.hci.SearchFilterModel
      com.highdeal.pnr.hci.SubscriberAccountSearchFilterModel

All Implemented Interfaces:

XMLMarshallable

public class SubscriberAccountSearchFilterModel
extends SearchFilterModel

This filter allows to retrieve any subscriber account by using attributeDescription to build search criterias.
If no attributeDescription is given, all the subscriber accounts are returned.
The name of the attributeDescription could take the values:

• CODE
• SUBSCRIBER
• SERVICE_PROVIDER

Please consult SearchFilterModel for more info on type.

XML Schema Fragment

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

Field Summary

static java.lang.String	CODE Name of the attributeDescription that search for code.
static java.lang.String	PERIMETER Name of the specific formula that search for a subscription which is root.
static java.lang.String	SERVICE_PROVIDER Name of the attributeDescription that search for serviceProvider.
static java.lang.String	SUBSCRIBER Name of the attributeDescription that search for subscriber.

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

ASC_ORDER, DESC_ORDER, FILTER_GROUP_BNR, FILTER_GROUP_PNR, FILTER_GROUP_PREPAID, ID_RESULT_TYPE, ITERATOR_MODE, LIST_MODE, NO_ORDER, OBJECT_RESULT_TYPE

Constructor Summary

SubscriberAccountSearchFilterModel()
Builds an empty SubscriberAccountSearchFilterModel.

Method Summary

int	getFilterGroup() Returns the filter group of the searchFilterModel, default is BnR, this method is surrounded in PnR searchFilterModels.
java.util.Vector<AttributeDescriptionModel>	getMainAttributeDescriptionCatalog() Returns the list of main attribute description on which the user can build some search criteria.
AttributeDescriptionModel	getMainAttributeDescriptionFromCatalog(java.lang.String name) Returns an empty constraint from a catalog which can be used for specifying a criteria on a main attribute (identified by its name).
java.util.Vector<SpecificFormulaModel>	getSpecificFormulaCatalog() This abstract method must be implemented into each concrete filter.
SpecificFormulaModel	getSpecificFormulaFromCatalog(java.lang.String code) This abstract method must be implemented into each concrete filter.

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

addAttributeSelection, addCharacterData, addChild, addSpecificFormula, 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

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

Field Detail

CODE

public static final java.lang.String CODE

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

See Also:

Constant Field Values

SUBSCRIBER

public static final java.lang.String SUBSCRIBER

Name of the attributeDescription that search for subscriber. The type of the corresponding attributeDescription is string

See Also:

Constant Field Values

SERVICE_PROVIDER

public static final java.lang.String SERVICE_PROVIDER

Name of the attributeDescription that search for serviceProvider. The type of the corresponding attributeDescription is string

See Also:

Constant Field Values

PERIMETER

public static final java.lang.String PERIMETER

Name of the specific formula that search for a subscription which is root.

See Also:

Constant Field Values

Constructor Detail

SubscriberAccountSearchFilterModel

public SubscriberAccountSearchFilterModel()

Builds an empty SubscriberAccountSearchFilterModel.

Method Detail

getSpecificFormulaFromCatalog

public SpecificFormulaModel getSpecificFormulaFromCatalog(java.lang.String code)

Description copied from class: SearchFilterModel

This abstract method must be implemented into each concrete filter. It returns a specific formula from the catalog according to its name. See getSpecificFormulaList() for more info;

Specified by:

getSpecificFormulaFromCatalog in class SearchFilterModel

Parameters:

code - the code which identifies the specific formula.

Returns:

the targeted specific formula. Null the formula doesn't exist.

getSpecificFormulaCatalog

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

Description copied from class: SearchFilterModel

This abstract method must be implemented into each concrete filter. It returns the catalog of available specific formula for the current search filter. See getSpecificFormulaList() for more info;

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 which can be used for specifying a criteria 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 attribute are predefined. So we can establish the catalog of the main attribute for a concrete search filter, for whih it will be possible to build some search criteria.

This abstract method allows to retrieve a predefined constraint on a main attribute which belongs to the main attribute catalog.

Specified by:

getMainAttributeDescriptionFromCatalog in class SearchFilterModel

Parameters:

name - the name of the attribute. Please consult related concrete class for more info.

Returns:

the related attribute description model or null if the specified attribute name doesn't match any catalog attribute.

getMainAttributeDescriptionCatalog

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

Description copied from class: SearchFilterModel

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

Specified by:

getMainAttributeDescriptionCatalog in class SearchFilterModel

Returns:

a list of AttributeDescriptionModel which 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 searchFilterModel, default is BnR, this method is surrounded in PnR searchFilterModels.

Overrides:

getFilterGroup in class SearchFilterModel

Returns:

filter group