SearchFilterModel (SAP CC 5.0 Java APIs (Core Library))

java.lang.Object
- com.highdeal.filter.hci.SearchFilterModel

All Implemented Interfaces:: XMLMarshallable

Direct Known Subclasses:: AccessSearchFilterModel, ChargeActivationSearchFilterModel, ChargingContractSearchFilterModel, MappingTableClassSearchFilterModel, RangeTableClassSearchFilterModel, SubscriberAccountSearchFilterModel, SubscriberMappingTableSearchFilterModel, SubscriberRangeTableSearchFilterModel, SubscriptionSearchFilterModel, TableSearchFilterModel, TierTableSearchFilterModel, TranslationTableSearchFilterModel, UserOperationSearchFilterModel

public abstract class SearchFilterModel
extends java.lang.Object
implements XMLMarshallable

This abstract Java class represents a search filter to aggregate all search criteria that you can use to search for data stored in the connected SAP CC system; You can specify basic criteria and specialized search criteria.

Note

Refer to the known Java subclasses to work with the search filters that are dedicated to the searched objects:

Master Data (pricing catalog of the service provider)	Customer Master Data (end customers of the service provider)	Technical Data
Tier table Translation table Mapping table: see the `MappingTableSearchFilterModel` filter Range table: see the `RangeTableSearchFilterModel` filter	Subscriber accounts Subscriber mapping tables: see the `SubscriberMappingTableSearchFilterModel` filter Subscriber range tables: see the `SubscriberRangeTableSearchFilterModel` filter Accesses Charge activation objects in subscriptions Charging contracts (charging view of provider contracts) Subscriptions	Authorization Role User operation Object change log

Implementation in Your Client Application

Basic Search Criteria

You specify some attribute descriptions to define your basic search criteria. Refer to the lists of predefined names in the Java classes of the data search filters.

Options

This class defines the following search options:

Maximum size: Limits the returned items count (-1 if no limitation); The result is pagined.
Total count required: If true, the total count of searched items must be returned
From: Represents a current item unique ID from which the search must begin
Sort: Indicates the sort order which will be applied on the unique identifier for searching items
Result type: Specifies if the result must be a list of complete objects, a list of attribute sets, or only a list of IDs

Advanced Search Criteria (Formulas)

You can specify some specific search criteria by using some predefined specific formulas available in the specialized search filters.

See Also:: AttributeDescriptionModel, SpecificFormulaModel

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ASC_ORDER` Constant for ascending search order (value is set to `""asc""`)
`static int`	`ATTRIBUTES_RESULT_TYPE` Constant for "attributes" result type (value is set to `2`)
`static java.lang.String`	`DESC_ORDER` Constant for descending search order (value is set to `"desc"`)
`static int`	`FILTER_GROUP_PNR` Constant
`static int`	`ID_RESULT_TYPE` Constant for "ids" result type (value is set to `1`)
`static int`	`ITERATOR_MODE` INTERNAL USE ONLY - Constant for "iterator" search mode (value is set to `1`).
`static int`	`LIST_MODE` Constant for "list" search mode (value is set to `0`)
`static java.lang.String`	`NO_ORDER` Constant for no order search order (value is set to `"noOrder"`)
`static int`	`OBJECT_RESULT_TYPE` Constant for "objects" result type (value is set to `0`)

Constructor Summary

Constructors
Constructor and Description

SearchFilterModel(java.lang.String searchFilterName)
Builds an empty SearchFilterModel; This builder is mainly used through the super() pointer.

Constructors
Constructor and Description
`SearchFilterModel(java.lang.String searchFilterName)` Builds an empty SearchFilterModel; This builder is mainly used through the `super()` pointer.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttributeSelection(AttributeDescriptionModel sel)` Adds a selection filter that ports on an attribute field.
`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`	`addSpecificFormula(SpecificFormulaModel formula)` Adds a specific constraint for the search operation, regarding to the working scope; See `getSpecificFormulaList()` for more information.
`java.util.List<java.lang.String>`	`getAttributeResultList()` Returns the list of attribute values that must be returned in the result; An attribute is the name of an `AttributeDescriptionModel`.
`java.util.List<AttributeDescriptionModel>`	`getAttributeSelectionList()` Gets the list of constraints which must be checked for searching item; This list contains all criteria which port on object main attribute.
`java.util.List<AttributeDescriptionModel>`	`getAttributeSelectionListFromGroup(java.lang.String group)` Gets the list of constraints which must be checked for searching items and which belong to the same group.
`int`	`getFilterGroup()` Returns the filter group of the search filter; default is `BnR`.
`java.lang.String`	`getFrom()` Gets the from cursor.
`abstract 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.
`abstract 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).
`int`	`getMaxSize()` Gets the max; The max value represents the max number of results answering to the search request.
`int`	`getResultType()` Gets the search result type.
`java.lang.String`	`getSearchFilterName()` Returns the XML element name of the current search filter.
`int`	`getSearchMode()` Gets the search mode that must be used with this filter.
`java.lang.String`	`getSort()` Gets the cursor search order.
`abstract java.util.Vector<SpecificFormulaModel>`	`getSpecificFormulaCatalog()` Returns the catalog of available specific formula for the current search filter; See `getSpecificFormulaList()` for more information;
`abstract SpecificFormulaModel`	`getSpecificFormulaFromCatalog(java.lang.String formCode)` Returns a specific formula from the catalog according to its name; See `getSpecificFormulaList()` for more information;
`java.util.List<SpecificFormulaModel>`	`getSpecificFormulaList()` Gets the list of specific constraints.
`boolean`	`isCountRequired()` Tells if the total number of selected items must be returned; See `setCountRequiredFlag()` for more information.
`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`	`setAttributeSelectionList(java.util.List<AttributeDescriptionModel> sels)` Sets the list of constraints which port on attribute fields.
`void`	`setCountRequiredFlag(boolean flag)` Sets the flag for returning the total number of selected items.
`void`	`setFrom(java.lang.String f)` Gets the from cursor.
`void`	`setMaxSize(int d)` Sets the max; The max value represents the max number of results answering to the search request.
`void`	`setResultType(int type)` Sets the search result type.
`void`	`setSearchFilterName(java.lang.String name)` Sets the XML element name of the current search filter.
`void`	`setSearchMode(int mode)` INTERNAL USE ONLY - Sets the search mode which must be used with this filter.
`void`	`setSort(java.lang.String sortOrder)` Sets the from cursor search order; The default value is NO_ORDER.
`void`	`setSpecificFormulaList(java.util.List<SpecificFormulaModel> specifics)` Sets the list of specific constraints; See `getSpecificFormulaList()` for more information.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OBJECT_RESULT_TYPE
```
public static final int OBJECT_RESULT_TYPE
```
    Constant for "objects" result type (value is set to 0)
    
    See Also:
    
    Constant Field Values
  - ID_RESULT_TYPE
```
public static final int ID_RESULT_TYPE
```
    Constant for "ids" result type (value is set to 1)
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTES_RESULT_TYPE
```
public static final int ATTRIBUTES_RESULT_TYPE
```
    Constant for "attributes" result type (value is set to 2)
    
    See Also:
    
    Constant Field Values
  - LIST_MODE
```
public static final int LIST_MODE
```
    Constant for "list" search mode (value is set to 0)
    
    See Also:
    
    Constant Field Values
  - ITERATOR_MODE
```
public static final int ITERATOR_MODE
```
    INTERNAL USE ONLY - Constant for "iterator" search mode (value is set to 1). Reserved for internal use. Cannot be set by your client application.
    
    See Also:
    
    Constant Field Values
  - ASC_ORDER
```
public static final java.lang.String ASC_ORDER
```
    Constant for ascending search order (value is set to ""asc"")
    
    See Also:
    
    Constant Field Values
  - DESC_ORDER
```
public static final java.lang.String DESC_ORDER
```
    Constant for descending search order (value is set to "desc")
    
    See Also:
    
    Constant Field Values
  - NO_ORDER
```
public static final java.lang.String NO_ORDER
```
    Constant for no order search order (value is set to "noOrder")
    
    See Also:
    
    Constant Field Values
  - FILTER_GROUP_PNR
```
public static final int FILTER_GROUP_PNR
```
    Constant
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchFilterModel
```
public SearchFilterModel(java.lang.String searchFilterName)
```
    Builds an empty SearchFilterModel; This builder is mainly used through the super() pointer.
    
    Parameters:
    
    searchFilterName - The name of the XML element that implements this XML complex type
- Method Detail
  - getSearchFilterName
```
public java.lang.String getSearchFilterName()
```
    Returns the XML element name of the current search filter.
    
    Returns:
    
    The name of the element
  - setSearchFilterName
```
public void setSearchFilterName(java.lang.String name)
```
    Sets the XML element name of the current search filter.
    
    Parameters:
    
    name - The name to set
  - getMaxSize
```
public int getMaxSize()
```
    Gets the max; The max value represents the max number of results answering to the search request.
    
    Returns:
    
    The maximum size
  - setMaxSize
```
public void setMaxSize(int d)
```
    Sets the max; The max value represents the max number of results answering to the search request.
    
    Parameters:
    
    d - The maximum size
  - getSearchMode
```
public int getSearchMode()
```
    Gets the search mode that must be used with this filter. Only the listMode is available through the API (default value). The iteratorMode is reserved for internal use.
    Returns:
    The search mode which must be used with the current filter. The available values are:
    
    listMode (default value).
    
    iteratorMode (reserved for internal use).
  - setSearchMode
```
public void setSearchMode(int mode)
```
    INTERNAL USE ONLY - Sets the search mode which must be used with this filter. This method is reserved for internal use. Only the listMode is available through the API (default value). The iteratorMode is reserved for internal use. Set the searchMode which must be used with the current filter. The available values are:
    - LIST_MODE (default value).
    - ITERATOR_MODE (reserved for internal use).
    Parameters:
    
    mode - The search mode to set
  - getResultType
```
public int getResultType()
```
    Gets the search result type.
    The possible types are:
    - ids: the search operation will return only the unique identifiers of the targeted objects
    - objects: the search operation will return the targeted objects
    - attributes: the search operation will return only the required attributes of the targeted objects
    Returns:
    The search result type. The possible values are:
    
    ID_RESULT_TYPE
    
    OBJECT_RESULT_TYPE
    
    ATTRIBUTES_RESULT_TYPE
  - setResultType
```
public void setResultType(int type)
```
    Sets the search result type.
    The possible types are:
    - ids: the search operation will return only the unique identifiers of the targeted objects
    - objects: the search operation will return the targeted objects
    - attributes: the search operation will return only the required attributes of the targeted objects
    Set the search result type.
    Parameters:
    
    type - The result type to set
  - getFrom
```
public java.lang.String getFrom()
```
    Gets the from cursor. The from cursor (if not null) is used as a beginning index for searching items. This cursor is mainly used as following:
    - You build his search filter by specifying a max value and a from cursor set to null. He can also specify a search order which will be applied on unique ids ("asc" by example).
    - The user executes the search operation and a search result will be received (SearchResult).
    - If this result contains a lastID not null (see getLastID()) it means that some other items exist into the database and a new search request can be executed.
    - The user will recall the search operation by setting the from cursor to the value of the previous lastID search result value (with the same sort order "asc" by example)
    - When the lastID value will be returned into a SearchResult with null as value, it means that no more searched item exists into the DB and that the search operation can be stopped.
    Returns:
    
    The from cursor
  - setFrom
```
public void setFrom(java.lang.String f)
```
    Gets the from cursor.
    The from cursor (if not null) is used as a beginning index for searching items. This cursor is mainly used as following during a search window:
    - The user builds his search filter by specifying a max value and a from cursor set to null. He can also specify a search order which will be applied on unique ids ("asc" by example).
    - The user executes the search operation and a search result will be received (SearchResult).
    - If this result contains a lastID not null (see getLastID()) it means that some other items exist into the database and a new search request can be executed.
    - The user will recall the search operation by setting the from cursor to the value of the previous lastID search result value (with the same sort order "asc" by example)
    - When the lastID value will be returned into a SearchResult with null as value, it means that no more searched item exists into the DB and that the search operation can be stopped.
    Note
    
    The from cursor is always transmitted as a String even if the unique ID is a number. In this case, please cast it into a String value.
    Parameters:
    
    f - The from cursor. If it sets to
  getSort public java.lang.String getSort() Gets the cursor search order. The available value are: ASC_ORDER DESC_ORDER NO_ORDER Returns: The required sort order setSort public void setSort(java.lang.String sortOrder) Sets the from cursor search order; The default value is NO_ORDER. The available values are: ASC_ORDER DESC_ORDER NO_ORDER Note If NO_ORDER is set, the SAP CC system will decide itself what is the best order to use and sometime will use some internal ID (Object ID OID) for improving search performances. According to search window mechanism definition (see from cursor), it is not recommended to change the sort order into a same search window. Parameters: sortOrder - The order which is used for managing the cursor getAttributeSelectionList public java.util.List<AttributeDescriptionModel> getAttributeSelectionList() Gets the list of constraints which must be checked for searching item; This list contains all criteria which port on object main attribute. The boolean conjunction operator (AND) is applied between each list element. In addition, the same operator will be applied between the last element of this list and the first element of the specific constraint list (see specificFormula). A search criterion is expressed through an AttributeDescriptionModel . Indeed an attribute description model, describes the attribute (name, type, default value) and aggregates some constraints which must be checked by the attribute. In this case, those constraints are some good candidates to express search criteria. The available constraint types are: EnumeratedListConstraint for defining a list of allowed values. RangeConstraint for defining range type constraints. FormatConstraint for defining constraints on String based on pattern definition. Returns: A list of AttributeDescriptionModel setAttributeSelectionList public void setAttributeSelectionList(java.util.List<AttributeDescriptionModel> sels) Sets the list of constraints which port on attribute fields. See getAttributeSelectionList() for more information. Parameters: sels - A list of attribute descriptions getAttributeSelectionListFromGroup public java.util.List<AttributeDescriptionModel> getAttributeSelectionListFromGroup(java.lang.String group) Gets the list of constraints which must be checked for searching items and which belong to the same group. It exists 4 groups for qualifying an attribute: MAIN_GROUP: the attribute is a main attribute which is located into the main item table. ADDITIONAL_GROUP: the attribute is an additional attribute which is located into the additional item table. PARAMETER_GROUP: the attribute is a parameter attribute which is located into a related parameter table. COUNTER_GROUP: the attribute is viewed as a counter which is located into a related table. Parameters: group - The group name. The available values are: MAIN_GROUP ADDITIONAL_GROUP PARAMETER_GROUP COUNTER_GROUP Returns: The list of attribute descriptions currently defined in this filter addAttributeSelection public void addAttributeSelection(AttributeDescriptionModel sel) Adds a selection filter that ports on an attribute field. Parameters: sel - The selection which must be added into the list getSpecificFormulaList public java.util.List<SpecificFormulaModel> getSpecificFormulaList() Gets the list of specific constraints. As some searchable items can be specific, the specific formula allows the user to complete the list of criteria with predefined specific constraints which cannot be expressed by an AttributeDescriptionModel. Returns: A list of SpecificFormulaModel setSpecificFormulaList public void setSpecificFormulaList(java.util.List<SpecificFormulaModel> specifics) Sets the list of specific constraints; See getSpecificFormulaList() for more information. Parameters: specifics - A list of SpecificFormulaModel addSpecificFormula public void addSpecificFormula(SpecificFormulaModel formula) Adds a specific constraint for the search operation, regarding to the working scope; See getSpecificFormulaList() for more information. Parameters: formula - The specific constraint which must be added into the specific constraint list setCountRequiredFlag public void setCountRequiredFlag(boolean flag) Sets the flag for returning the total number of selected items. Parameters: flag - If set to true, the result will contain the total item count which match the constraints. If it is set to false, the total count will be set to -1. See totalCount into SearchResult. isCountRequired public boolean isCountRequired() Tells if the total number of selected items must be returned; See setCountRequiredFlag() for more information. Returns: true if the total item count must be returned, false otherwise getFilterGroup public int getFilterGroup() Returns the filter group of the search filter; default is BnR. This method is surrounded in PnR search filter models. Returns: The filter group of the search filter getAttributeResultList public java.util.List<java.lang.String> getAttributeResultList() Returns the list of attribute values that must be returned in the result; An attribute is the name of an AttributeDescriptionModel. Returns: The list of attribute values that must be returned in the result getSpecificFormulaFromCatalog public abstract SpecificFormulaModel getSpecificFormulaFromCatalog(java.lang.String formCode) Returns a specific formula from the catalog according to its name; See getSpecificFormulaList() for more information; Parameters: formCode - The code that identifies the specific formula Returns: The targeted specific formula. null if the formula does not exist. getSpecificFormulaCatalog public abstract java.util.Vector<SpecificFormulaModel> getSpecificFormulaCatalog() Returns the catalog of available specific formula for the current search filter; See getSpecificFormulaList() for more information; Returns: A list of SpecificFormulaModel getMainAttributeDescriptionFromCatalog public abstract 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). 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. 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 abstract 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. Returns: A list of attribute descriptions that are related to main attributes of the concrete search filter. 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

Class SearchFilterModel

Implementation in Your Client Application

Basic Search Criteria

Options

Advanced Search Criteria (Formulas)

XML API for HCI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OBJECT_RESULT_TYPE

ID_RESULT_TYPE

ATTRIBUTES_RESULT_TYPE

LIST_MODE

ITERATOR_MODE

ASC_ORDER

DESC_ORDER

NO_ORDER

FILTER_GROUP_PNR

Constructor Detail

SearchFilterModel

Method Detail

getSearchFilterName

setSearchFilterName

getMaxSize

setMaxSize

getSearchMode

setSearchMode

getResultType

setResultType

getFrom

setFrom

getSort

setSort

getAttributeSelectionList

setAttributeSelectionList

getAttributeSelectionListFromGroup

addAttributeSelection

getSpecificFormulaList

setSpecificFormulaList

addSpecificFormula

setCountRequiredFlag

isCountRequired

getFilterGroup

getAttributeResultList

getSpecificFormulaFromCatalog

getSpecificFormulaCatalog

getMainAttributeDescriptionFromCatalog

getMainAttributeDescriptionCatalog

setAttributes

addChild

addCharacterData

marshal