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

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

All Implemented Interfaces:

XMLMarshallable
```
public class RatingSessionSearchFilterModel
extends com.highdeal.filter.hci.SearchFilterModel
```
This filter allows to retrieve any rating session by using attributeDescriptionModel to build search criterias.
If no attributeDescriptionModel is given, all the sessions are returned.
Available search fields are:
Please consult SearchFilterModel for more info on type. Available specific formula code for this filter are:
- "mustBeInProgress" (without parameters and without nested filter)
- "mustBeEnded" (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="ratingSessionSearchFilter" type="SearchFilter" substitutionGroup="SearchFilter"/>
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BATCH_RATING_GROUP_ID` Name of the attributeDescription that searches for `batchRatingGroupId`.
`static java.lang.String`	`DESCRIPTION` Name of the attributeDescription that searches for `description`.
`static java.lang.String`	`DURATION` Name of the attributeDescription that searches for `duration`.
`static java.lang.String`	`FILTER_NAME` Name of this filter.
`static java.lang.String`	`MAX_CDR_CONSUMPTION_DATE` Name of the attributeDescription that searches for `maxCDRConsumptionDate`.
`static java.lang.String`	`MUST_BE_ENDED_CODE` Specific formula code for "must be ended" search criteria.
`static java.lang.String`	`MUST_BE_IN_PROGRESS_CODE` Specific formula code for "must be in progress" search criteria.
`static java.lang.String`	`NB_CDR_ERROR` Name of the attributeDescription that searches for `nbCDRError`.
`static java.lang.String`	`NB_CDR_RATED` Name of the attributeDescription that searches for `nbCDRRated`.
`static java.lang.String`	`RATING_MODE` Name of the attributeDescription that searches for `ratingMode`.
`static java.lang.String`	`SESSION_ID` Name of the attributeDescription that searches for `sessionID`.
`static java.lang.String`	`START_DATE` Name of the attributeDescription that searches for `startDate`.
`static java.lang.String`	`STATUS` Name of the attributeDescription that searches for `status`.

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

RatingSessionSearchFilterModel()
Builds an empty AcquisitionSessionSearchFilterModel.

Constructors
Constructor and Description
`RatingSessionSearchFilterModel()` Builds an empty AcquisitionSessionSearchFilterModel.

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`	`mustBeEnded()` Gets the "mustBeEnded" flag.
`boolean`	`mustBeInProgress()` Gets the "mustBeInProgress" flag.
`void`	`setMustBeEnded(boolean flag)` Sets the "setMustBeEnded" flag.
`void`	`setMustBeInProgress(boolean flag)` Sets the "setMustBeInProgress" 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
  - SESSION_ID
```
public static final java.lang.String SESSION_ID
```
    Name of the attributeDescription that searches for sessionID. 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 batchRatingGroupId. The type of the corresponding attributeDescription is number. The constant value is "batchRatingGroupId".
    
    See Also:
    
    Constant Field Values
  - START_DATE
```
public static final java.lang.String START_DATE
```
    Name of the attributeDescription that searches for startDate. The type of the corresponding attributeDescription is date. The constant value is "startDate".
    
    See Also:
    
    Constant Field Values
  - DURATION
```
public static final java.lang.String DURATION
```
    Name of the attributeDescription that searches for duration. The type of the corresponding attributeDescription is number. The constant value is "duration".
    
    See Also:
    
    Constant Field Values
  - RATING_MODE
```
public static final java.lang.String RATING_MODE
```
    Name of the attributeDescription that searches for ratingMode. The type of the corresponding attributeDescription is number. The constant value is "ratingMode".
    
    See Also:
    
    Constant Field Values
  - MAX_CDR_CONSUMPTION_DATE
```
public static final java.lang.String MAX_CDR_CONSUMPTION_DATE
```
    Name of the attributeDescription that searches for maxCDRConsumptionDate. The type of the corresponding attributeDescription is date. The constant value is "maxCDRConsumptionDate".
    
    See Also:
    
    Constant Field Values
  - NB_CDR_RATED
```
public static final java.lang.String NB_CDR_RATED
```
    Name of the attributeDescription that searches for nbCDRRated. The type of the corresponding attributeDescription is number. The constant value is "nbCDRRated".
    
    See Also:
    
    Constant Field Values
  - NB_CDR_ERROR
```
public static final java.lang.String NB_CDR_ERROR
```
    Name of the attributeDescription that searches for nbCDRError. The type of the corresponding attributeDescription is number. The constant value is "nbCDRError".
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    Name of the attributeDescription that searches for description. The type of the corresponding attributeDescription is string. The constant value is "description".
    
    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
  - MUST_BE_IN_PROGRESS_CODE
```
public static final java.lang.String MUST_BE_IN_PROGRESS_CODE
```
    Specific formula code for "must be in progress" search criteria. The constant value is "mustBeInProgress".
    
    See Also:
    
    Constant Field Values
  - MUST_BE_ENDED_CODE
```
public static final java.lang.String MUST_BE_ENDED_CODE
```
    Specific formula code for "must be ended" search criteria. The constant value is "mustBeEnded".
    
    See Also:
    
    Constant Field Values
  - FILTER_NAME
```
public static final java.lang.String FILTER_NAME
```
    Name of this filter. Reserved for internal use.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RatingSessionSearchFilterModel
```
public RatingSessionSearchFilterModel()
```
    Builds an empty AcquisitionSessionSearchFilterModel.
- 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)
  - mustBeInProgress
```
public boolean mustBeInProgress()
```
    Gets the "mustBeInProgress" flag.
    
    Returns:
    
    the "must be in progress" flag.
  - mustBeEnded
```
public boolean mustBeEnded()
```
    Gets the "mustBeEnded" flag.
    
    Returns:
    
    the "must be ended" flag.
  - setMustBeInProgress
```
public void setMustBeInProgress(boolean flag)
```
    Sets the "setMustBeInProgress" flag.
    
    Parameters:
    
    flag - the "must be in progress" flag.
  - setMustBeEnded
```
public void setMustBeEnded(boolean flag)
```
    Sets the "setMustBeEnded" flag.
    
    Parameters:
    
    flag - the "must be ended" flag.

Class RatingSessionSearchFilterModel

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

SESSION_ID

BATCH_RATING_GROUP_ID

START_DATE

DURATION

RATING_MODE

MAX_CDR_CONSUMPTION_DATE

NB_CDR_RATED

NB_CDR_ERROR

DESCRIPTION

STATUS

MUST_BE_IN_PROGRESS_CODE

MUST_BE_ENDED_CODE

FILTER_NAME

Constructor Detail

RatingSessionSearchFilterModel

Method Detail

getSpecificFormulaFromCatalog

getSpecificFormulaCatalog

getMainAttributeDescriptionCatalog

getMainAttributeDescriptionFromCatalog

mustBeInProgress

mustBeEnded

setMustBeInProgress

setMustBeEnded