com.highdeal.pnr.hci

Class AccessSearchFilterModel

java.lang.Object

com.highdeal.filter.hci.SearchFilterModel

com.highdeal.pnr.hci.AccessSearchFilterModel

All Implemented Interfaces:

XMLMarshallable

public class AccessSearchFilterModel
extends SearchFilterModel

This Java class represents a specialized search filter that allows you to retrieve any access in the customer master data of a service provider; You specify some attribute descriptions or predefined specific formula to define the search criteria.

Implementation in Your Client Application

You use this filter in the Search Access operation. If no attribute description is specified, all the accesses in customer master data are returned.

Operation Request

SearchAccessOp

Filtering Features

Search Criteria

The available main AttributeDescriptionModel names are :

• USER_SERVICE_ID
• SERVICE_ID
• OWNER

Note

Consult the SearchFilterModel Java class for more information. The element name for the access filter is set to "accessSearchFilter".

<-- No specific formula code exists for this filter.--> Cconsult SpecificFormulaModel for more information on specific formula XML Schema.

Specific Formula

The available specific formula code for this filter is:

• EXCLUDES_ACCESS_ACTIVATING_SUBSCRIPTION

Note

Consult SpecificFormulaModel Java class for more information on specific formula XML Schema.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXCLUDES_ACCESS_ACTIVATING_SUBSCRIPTION The name of the specific formula that excludes from the result all accesses that activate at least one subscription in customer master data.
static java.lang.String	OWNER Name of the attributeDescription that search for owner.
static java.lang.String	PARTITION_ID Name of the partitioning key.
static java.lang.String	SERVICE_ID Name of the attributeDescription that search for serviceId.
static java.lang.String	USER_SERVICE_ID Name of the attributeDescription that search for userServiceId.

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
AccessSearchFilterModel() Builds an empty access search filter model.

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 attributeName) 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 formCode) 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

USER_SERVICE_ID

public static final java.lang.String USER_SERVICE_ID

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

See Also:

Constant Field Values

SERVICE_ID

public static final java.lang.String SERVICE_ID

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

See Also:

Constant Field Values

OWNER

public static final java.lang.String OWNER

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

See Also:

Constant Field Values

PARTITION_ID

public static final java.lang.String PARTITION_ID

Name of the partitioning key.

See Also:

Constant Field Values

EXCLUDES_ACCESS_ACTIVATING_SUBSCRIPTION

public static final java.lang.String EXCLUDES_ACCESS_ACTIVATING_SUBSCRIPTION

The name of the specific formula that excludes from the result all accesses that activate at least one subscription in customer master data.

See Also:

Constant Field Values

Constructor Detail

AccessSearchFilterModel

public AccessSearchFilterModel()

Builds an empty access search filter model.

Method Detail

getSpecificFormulaFromCatalog

public SpecificFormulaModel getSpecificFormulaFromCatalog(java.lang.String formCode)

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:

formCode - 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 attributeName)

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:

attributeName - 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