CDRSearchFilterModel (SAP CC 5.0 Java APIs (BART Library))

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

All Implemented Interfaces:

XMLMarshallable
```
public class CDRSearchFilterModel
extends com.highdeal.filter.hci.SearchFilterModel
```
This filter allows to retrieve any cdr by using attributeDescriptionModel to build search criterias.
If no attributeDescriptionModel is given, all the cdrs are returned.
Available search fields are:
Please consult SearchFilterModel for more info on type. Available specific formula code for this filter are:
- "mustBeNew" (without parameters and without nested filter)
- "mustBeRated" (without parameters and without nested filter)
- "mustBeError" (without parameters and without nested filter)
- "mustBeIgnored" (without parameters and without nested filter)
- "mustBeDuplicate" (without parameters and without nested filter)
- "mustBeRatingInProgress" (without parameters and without nested filter)
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="cdrSearchFilter" type="SearchFilter" substitutionGroup="SearchFilter"/>
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACQUISITION_DATE` Name of the attributeDescription that searches for `acquisitionDate`.
`static java.lang.String`	`ACQUISITION_ID` Name of the attributeDescription that searches for `acquisitionID`.
`static java.lang.String`	`BATCH_RATING_GROUP_ID` Name of the attributeDescription that searches for `groupID`.
`static java.lang.String`	`CDR_ID` Name of the attributeDescription that searches for `cdrID`.
`static java.lang.String`	`CONSUMPTION_DATE` Name of the attributeDescription that searches for `consumptionDate`.
`static java.lang.String`	`ERROR_CODE` Name of the attributeDescription that searches for `errorCode`.
`static java.lang.String`	`ERROR_DESCRIPTION` Name of the attributeDescription that searches for `errorDescription`.
`static java.lang.String`	`FILTER_NAME` Name of this filter model.
`static java.lang.String`	`MAGIC_NUMBER` Name of the attributeDescription that searches for `magicNumber`.
`static java.lang.String`	`MUST_BE_DUPLICATE_CODE` Specific formula code for "must be duplicate CDR" search criteria.
`static java.lang.String`	`MUST_BE_ERROR_CODE` Specific formula code for "must be error cdr" search criteria.
`static java.lang.String`	`MUST_BE_IGNORED_CODE` Specific formula code for "must be ignored cdr" search criteria.
`static java.lang.String`	`MUST_BE_IN_RATING_PROGRESS_CODE` Specific formula code for "must be in rating progress cdr" search criteria.
`static java.lang.String`	`MUST_BE_NEW_CODE` Specific formula code for "must be new cdr" search criteria.
`static java.lang.String`	`MUST_BE_RATED_CODE` Specific formula code for "must be rated cdr" search criteria.
`static java.lang.String`	`NAME` Name of the attributeDescription that searches for `name`.
`static java.lang.String`	`RATING_DATE` Name of the attributeDescription that searches for `ratingDate`.
`static java.lang.String`	`RATING_ID` Name of the attributeDescription that searches for `ratingID`.
`static java.lang.String`	`SERVICE_ID` Name of the attributeDescription that searches for `serviceID`.
`static java.lang.String`	`SOURCE` Name of the attributeDescription that searches for `source`.
`static java.lang.String`	`STATUS` Name of the attributeDescription that searches for `status`.
`static java.lang.String`	`SUBSCRIPTION_ID` Name of the attributeDescription that searches for `subscriptionID`.
`static java.lang.String`	`USER_ID` Name of the attributeDescription that searches for `userID`.

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

CDRSearchFilterModel()
Builds an empty CDRSearchFilterModel.

Constructors
Constructor and Description
`CDRSearchFilterModel()` Builds an empty CDRSearchFilterModel.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Vector<com.highdeal.udr.hci.AttributeDescriptionModel>`	`getMainAttributeDescriptionCatalog()` Returns the list of main attribute description on which the user can build some search criteria.
`com.highdeal.udr.hci.AttributeDescriptionModel`	`getMainAttributeDescriptionFromCatalog(java.lang.String name)` Returns an attribute description from the catalog according to its name.
`java.util.Vector<com.highdeal.filter.hci.SpecificFormulaModel>`	`getSpecificFormulaCatalog()` Returns the catalog of available specific formula for the current search filter.
`com.highdeal.filter.hci.SpecificFormulaModel`	`getSpecificFormulaFromCatalog(java.lang.String code)` Returns a specific formula from the catalog according to its name.
`boolean`	`mustBeDuplicate()` Gets the "mustBeDuplicate" flag.
`boolean`	`mustBeError()` Gets the "mustBeError" flag.
`boolean`	`mustBeIgnored()` Gets the "mustBeIgnored" flag.
`boolean`	`mustBeInRatingProgress()` Gets the "mustBeInRatingProgress" flag.
`boolean`	`mustBeNew()` Gets the "mustBeNew" flag.
`boolean`	`mustBeRated()` Gets the "mustBeRated" flag.
`void`	`setMustBeDuplicate(boolean flag)` Sets the "mustBeDuplicate" flag.
`void`	`setMustBeError(boolean flag)` Sets the "setMustBeError" flag.
`void`	`setMustBeIgnored(boolean flag)` Sets the "setMustBeIgnored" flag.
`void`	`setMustBeInRatingProgress(boolean flag)` Sets the "mustBeInRatingProgress" flag.
`void`	`setMustBeNew(boolean flag)` Sets the "setMustBeNew" flag.
`void`	`setMustBeRated(boolean flag)` Sets the "setMustBeRated" flag.

Methods inherited from class com.highdeal.filter.hci.SearchFilterModel
addAttributeSelection, addCharacterData, addChild, addSpecificFormula, getAttributeResultList, getAttributeSelectionList, getAttributeSelectionListFromGroup, getFilterGroup, 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
  - CDR_ID
```
public static final java.lang.String CDR_ID
```
    Name of the attributeDescription that searches for cdrID. The type of the corresponding attributeDescription is number. The constant value is "cdrID".
    
    See Also:
    
    Constant Field Values
  - BATCH_RATING_GROUP_ID
```
public static final java.lang.String BATCH_RATING_GROUP_ID
```
    Name of the attributeDescription that searches for groupID. The type of the corresponding attributeDescription is number. The constant value is "batchRatingGroupId".
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    Name of the attributeDescription that searches for name. The type of the corresponding attributeDescription is string. The constant value is "name".
    
    See Also:
    
    Constant Field Values
  - USER_ID
```
public static final java.lang.String USER_ID
```
    Name of the attributeDescription that searches for userID. The type of the corresponding attributeDescription is string. The constant value is "userID".
    
    See Also:
    
    Constant Field Values
  - SERVICE_ID
```
public static final java.lang.String SERVICE_ID
```
    Name of the attributeDescription that searches for serviceID. The type of the corresponding attributeDescription is string. The constant value is "serviceID".
    
    See Also:
    
    Constant Field Values
  - SUBSCRIPTION_ID
```
public static final java.lang.String SUBSCRIPTION_ID
```
    Name of the attributeDescription that searches for subscriptionID. The type of the corresponding attributeDescription is number. The constant value is "subscriptionID".
    
    See Also:
    
    Constant Field Values
  - CONSUMPTION_DATE
```
public static final java.lang.String CONSUMPTION_DATE
```
    Name of the attributeDescription that searches for consumptionDate. The type of the corresponding attributeDescription is date. The constant value is "consumptionDate".
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final java.lang.String STATUS
```
    Name of the attributeDescription that searches for status. The type of the corresponding attributeDescription is number. The constant value is "status".
    
    See Also:
    
    Constant Field Values
  - ACQUISITION_DATE
```
public static final java.lang.String ACQUISITION_DATE
```
    Name of the attributeDescription that searches for acquisitionDate. The type of the corresponding attributeDescription is date. The constant value is "acquisitionDate".
    
    See Also:
    
    Constant Field Values
  - ACQUISITION_ID
```
public static final java.lang.String ACQUISITION_ID
```
    Name of the attributeDescription that searches for acquisitionID. The type of the corresponding attributeDescription is number. The constant value is "acquisitionID".
    
    See Also:
    
    Constant Field Values
  - RATING_DATE
```
public static final java.lang.String RATING_DATE
```
    Name of the attributeDescription that searches for ratingDate. The type of the corresponding attributeDescription is date. The constant value is "ratingDate".
    
    See Also:
    
    Constant Field Values
  - RATING_ID
```
public static final java.lang.String RATING_ID
```
    Name of the attributeDescription that searches for ratingID. The type of the corresponding attributeDescription is number. The constant value is "ratingID".
    
    See Also:
    
    Constant Field Values
  - ERROR_CODE
```
public static final java.lang.String ERROR_CODE
```
    Name of the attributeDescription that searches for errorCode. The type of the corresponding attributeDescription is number. The constant value is "errorCode".
    
    See Also:
    
    Constant Field Values
  - ERROR_DESCRIPTION
```
public static final java.lang.String ERROR_DESCRIPTION
```
    Name of the attributeDescription that searches for errorDescription. The type of the corresponding attributeDescription is string. The constant value is "errorDescription".
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final java.lang.String SOURCE
```
    Name of the attributeDescription that searches for source. The type of the corresponding attributeDescription is string. The constant value is "source".
    
    See Also:
    
    Constant Field Values
  - MAGIC_NUMBER
```
public static final java.lang.String MAGIC_NUMBER
```
    Name of the attributeDescription that searches for magicNumber. The type of the corresponding attributeDescription is string. The constant value is "magicNumber".
    
    See Also:
    
    Constant Field Values
  - MUST_BE_NEW_CODE
```
public static final java.lang.String MUST_BE_NEW_CODE
```
    Specific formula code for "must be new cdr" search criteria. The constant value is "mustBeNew".
    
    See Also:
    
    Constant Field Values
  - MUST_BE_RATED_CODE
```
public static final java.lang.String MUST_BE_RATED_CODE
```
    Specific formula code for "must be rated cdr" search criteria. The constant value is "mustBeRated".
    
    See Also:
    
    Constant Field Values
  - MUST_BE_ERROR_CODE
```
public static final java.lang.String MUST_BE_ERROR_CODE
```
    Specific formula code for "must be error cdr" search criteria. The constant value is "mustBeError".
    
    See Also:
    
    Constant Field Values
  - MUST_BE_IGNORED_CODE
```
public static final java.lang.String MUST_BE_IGNORED_CODE
```
    Specific formula code for "must be ignored cdr" search criteria. The constant value is "mustBeIgnored".
    
    See Also:
    
    Constant Field Values
  - MUST_BE_DUPLICATE_CODE
```
public static final java.lang.String MUST_BE_DUPLICATE_CODE
```
    Specific formula code for "must be duplicate CDR" search criteria. The constant value is "mustBeDuplicate".
    
    See Also:
    
    Constant Field Values
  - MUST_BE_IN_RATING_PROGRESS_CODE
```
public static final java.lang.String MUST_BE_IN_RATING_PROGRESS_CODE
```
    Specific formula code for "must be in rating progress cdr" search criteria. The constant value is "mustBeInRatingProgress".
    
    See Also:
    
    Constant Field Values
  - FILTER_NAME
```
public static final java.lang.String FILTER_NAME
```
    Name of this filter model.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CDRSearchFilterModel
```
public CDRSearchFilterModel()
```
    Builds an empty CDRSearchFilterModel.
- Method Detail
  - getSpecificFormulaFromCatalog
```
public com.highdeal.filter.hci.SpecificFormulaModel getSpecificFormulaFromCatalog(java.lang.String code)
```
    Returns a specific formula from the catalog according to its name.
    
    Specified by:
    
    getSpecificFormulaFromCatalog in class com.highdeal.filter.hci.SearchFilterModel
    
    Parameters:
    
    code - the code which identifies the specific formula.
    
    Returns:
    
    the targeted specific formula. Null the formula doesn't exist.
    
    See Also:
    
    SearchFilterModel.getSpecificFormulaFromCatalog(java.lang.String), SearchFilterModel.getSpecificFormulaList()
  - getSpecificFormulaCatalog
```
public java.util.Vector<com.highdeal.filter.hci.SpecificFormulaModel> getSpecificFormulaCatalog()
```
    Returns the catalog of available specific formula for the current search filter.
    
    Specified by:
    
    getSpecificFormulaCatalog in class com.highdeal.filter.hci.SearchFilterModel
    
    Returns:
    
    a list of SpecificFormulaModel.
    
    See Also:
    
    SearchFilterModel.getSpecificFormulaCatalog(), SearchFilterModel.getSpecificFormulaList()
  - getMainAttributeDescriptionCatalog
```
public java.util.Vector<com.highdeal.udr.hci.AttributeDescriptionModel> getMainAttributeDescriptionCatalog()
```
    Returns the list of main attribute description on which the user can build some search criteria.
    
    Specified by:
    
    getMainAttributeDescriptionCatalog in class com.highdeal.filter.hci.SearchFilterModel
    
    Returns:
    
    a list of AttributeDescriptionModel which are related to main attributes of the concrete search filter.
    
    See Also:
    
    SearchFilterModel.getMainAttributeDescriptionCatalog(), SearchFilterModel.getMainAttributeDescriptionFromCatalog(java.lang.String)
  - getMainAttributeDescriptionFromCatalog
```
public com.highdeal.udr.hci.AttributeDescriptionModel getMainAttributeDescriptionFromCatalog(java.lang.String name)
```
    Returns an attribute description from the catalog according to its name.
    
    Specified by:
    
    getMainAttributeDescriptionFromCatalog in class com.highdeal.filter.hci.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.
    
    See Also:
    
    SearchFilterModel.getMainAttributeDescriptionFromCatalog(java.lang.String)
  - mustBeNew
```
public boolean mustBeNew()
```
    Gets the "mustBeNew" flag.
    
    Returns:
    
    the must be new flag.
  - mustBeRated
```
public boolean mustBeRated()
```
    Gets the "mustBeRated" flag.
    
    Returns:
    
    the must be rated flag.
  - mustBeError
```
public boolean mustBeError()
```
    Gets the "mustBeError" flag.
    
    Returns:
    
    the must be error flag.
  - mustBeIgnored
```
public boolean mustBeIgnored()
```
    Gets the "mustBeIgnored" flag.
    
    Returns:
    
    the must be ignored flag.
  - mustBeDuplicate
```
public boolean mustBeDuplicate()
```
    Gets the "mustBeDuplicate" flag.
    
    Returns:
    
    the must be duplicate flag.
  - mustBeInRatingProgress
```
public boolean mustBeInRatingProgress()
```
    Gets the "mustBeInRatingProgress" flag.
    
    Returns:
    
    the must be in rating progress flag.
  - setMustBeNew
```
public void setMustBeNew(boolean flag)
```
    Sets the "setMustBeNew" flag.
    
    Parameters:
    
    flag - the "must be new" flag.
  - setMustBeRated
```
public void setMustBeRated(boolean flag)
```
    Sets the "setMustBeRated" flag.
    
    Parameters:
    
    flag - the "must be rated" flag.
  - setMustBeError
```
public void setMustBeError(boolean flag)
```
    Sets the "setMustBeError" flag.
    
    Parameters:
    
    flag - the "must be error" flag.
  - setMustBeIgnored
```
public void setMustBeIgnored(boolean flag)
```
    Sets the "setMustBeIgnored" flag.
    
    Parameters:
    
    flag - the "must be ignored" flag.
  - setMustBeDuplicate
```
public void setMustBeDuplicate(boolean flag)
```
    Sets the "mustBeDuplicate" flag.
    
    Parameters:
    
    flag - the "must be duplicate" flag.
  - setMustBeInRatingProgress
```
public void setMustBeInRatingProgress(boolean flag)
```
    Sets the "mustBeInRatingProgress" flag.
    
    Parameters:
    
    flag - the "must be in rating progress" flag.

Class CDRSearchFilterModel

XML API for HCI

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

CDR_ID

BATCH_RATING_GROUP_ID

NAME

USER_ID

SERVICE_ID

SUBSCRIPTION_ID

CONSUMPTION_DATE

STATUS

ACQUISITION_DATE

ACQUISITION_ID

RATING_DATE

RATING_ID

ERROR_CODE

ERROR_DESCRIPTION

SOURCE

MAGIC_NUMBER

MUST_BE_NEW_CODE

MUST_BE_RATED_CODE

MUST_BE_ERROR_CODE

MUST_BE_IGNORED_CODE

MUST_BE_DUPLICATE_CODE

MUST_BE_IN_RATING_PROGRESS_CODE

FILTER_NAME

Constructor Detail

CDRSearchFilterModel

Method Detail

getSpecificFormulaFromCatalog

getSpecificFormulaCatalog

getMainAttributeDescriptionCatalog

getMainAttributeDescriptionFromCatalog

mustBeNew

mustBeRated

mustBeError

mustBeIgnored

mustBeDuplicate

mustBeInRatingProgress

setMustBeNew

setMustBeRated

setMustBeError

setMustBeIgnored

setMustBeDuplicate

setMustBeInRatingProgress