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

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

All Implemented Interfaces:

XMLMarshallable
```
public class ChargingContractSearchFilterModel
extends SearchFilterModel
```
This Java class represents a search filter dedicated to contracts in customer master data managed by the connected SAP CC Core Server system; The filter allows you to specify a set of search criteria to retrieve corresponding charging contracts (charging view of provider contracts).
Implementation Note and Concepts

A charging contract is the pricing and charging view of a provider contract stored in SAP Convergent Charging.
- A charging contract is only visible in the technical interfaces. It represents a technical concept in SAP CC.
- A provider contract is a master data. It is owned by the service provider and includes customer data. This master data relates to a long-term business relationships between an end customer of a marketable service and the service provider. The provider is visible in the user interfaces (SAP CC Core Tool, SAP CRM). It represents a business and functional concept.
Implementation in Your Client Application

Advanced

You use this search filter only in the Rerate Bulk operation if you have decided to replace the SAP CC Core Tool user interface that is the default user interface to trigger rerating operations in a production system landscape.

You specify:
Operation Request
RerateBulkOp
Filtering Features

Search Criteria

The main search criterion is:
- "id": Search for charging contract by Id
The additional search criteria are:
- "subscriberAccountId": Search for charging contracts from subscriber account ID (code name)
- "subscriberAccountServiceProvider": Search for charging contracts from subscriber account service provider
- "rootChargingContractId": Search for charging contracts from root charging contract ID (parent provider contract)
- "rerating_lock_code": Search for charging contracts from rerating lock code
- "rerating_last_status": Search for charging contracts from last rerating status
- "rerating_last_code": Search for charging contracts from last rerating lock code
- "rerating_suggested_date": Search for charging contracts from last rerating suggested date
Note

Consult the SearchFilterModel Java class for more information.

Specific Formula

The available specific formula codes for this filter are:
- HAS_RERATING_SUGGESTED_DATE: Returns only contracts that define a last rerating suggested date
- IS_ROOT_CHARGING_CONTRACT: Returns only root contracts (parent provider contracts and isolated contracts). The research excludes the linked contracts from the results.
- IS_ACTIVE: Returns only root contracts (parent provider contracts and isolated contracts) having an operation status set to ACTIVE (0)
- IS_LOCKED: Returns only root contracts (parent provider contracts and isolated contracts) having an operation status set to LOCKED (1)
- IS_CLOSED: Returns only root contracts (parent provider contracts and isolated contracts) having an operation status set to CLOSED (2)
Note

Consult the SpecificFormulaModel Java class for more information about predefined search formula and how to implement them in your client application.

By Additional Information in Contracts

You can implement a research that is based on some additional information in the charging contracts. The structure of contracts is customized and enables data configuration of custom items in the charging contracts.

Use the SearchFilterModel.addAttributeSelection(com.highdeal.udr.hci.AttributeDescriptionModel) method to add an attribute description in this search filter.

You The type additional which name is the one of your additional information.

Note

Consult the SAP CC Application Help for more information about the additional information in provider contracts.
See Also:

RerateBulkOp

XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
```
<xs:element name="chargingContractSearchFilter" type="SearchFilter" substitutionGroup="SearchFilter" />
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`HAS_RERATING_SUGGESTED_DATE` The name of the `specific formula` that searches for a charging contract that was rerated and for which the billing system has suggested a date.
`static java.lang.String`	`ID` The name of the `criterion` that describes the value of the attribute "id" of the charging contract. The type of this criteria is a `string`.
`static java.lang.String`	`IS_ACTIVE` Name of the specific formula returning root contracts (parent provider contracts and isolated contracts) having an operational status set to active.
`static java.lang.String`	`IS_CLOSED` Name of the specific formula returning root contracts (parent provider contracts and isolated contracts) having an operational status set to closed .
`static java.lang.String`	`IS_LOCKED` Name of the specific formula returning root contracts (parent provider contracts and isolated contracts) having an operational status set to locked.
`static java.lang.String`	`IS_ROOT_CHARGING_CONTRACT` The name of the `specific formula` returning root contracts (parent provider contracts and isolated contracts) and excluding the linked contracts from the results.
`static java.lang.String`	`OPERATIONAL_STATUS` The name of the `criterion` that describes the value of the attribute "operationalStatus" of the charging contract. The type of this criteria is a `string`.
`static java.lang.String`	`RERATING_LAST_CODE` Name of the `criterion` that describes the value of the attribute "rerating_last_code" of the charging contract. The type of this criteria is a `string`.
`static java.lang.String`	`RERATING_LAST_STATUS` Name of the `criterion` that describes the value of the attribute "rerating_last_status" of the charging contract. The type of this criteria is a `number`.
`static java.lang.String`	`RERATING_LOCK_CODE` Name of the `criterion` that describes the value of the attribute "rerating_lock_code" of the charging contract. The type of this criteria is a `string`.
`static java.lang.String`	`RERATING_SUGGESTED_DATE` Name of the `criterion` that describes the value of the attribute "rerating_suggested_date" of the charging contract. The type of this criteria is a `date`.
`static java.lang.String`	`ROOT_CHARGING_CONTRACT_ID` Name of the `criterion` that describes the value of the attribute "rootChargingContractId" of the charging contract linked to a root charging contract.
`static java.lang.String`	`SUAC_ADD_INFO_KEY` Name for the `additional group key` for Subscriber Account additional information.
`static java.lang.String`	`SUBSCRIBER_ACCOUNT_CODE` The name of the `criterion` that describes the value of the attribute "subscriberAccountId" of the charging contract linked to a `SubscriberAccountModel.getCode()`. The type of this criteria is a `string`.
`static java.lang.String`	`SUBSCRIBER_ACCOUNT_SERVICE_PROVIDER` Name of the `criterion` that describes the value of the attribute "subscriberAccountServiceProvider" of the charging contract linked to a `SubscriberAccountModel.getServiceProvider()`. The type of this criteria is a `string`.
`static java.lang.String`	`TAG_NAME` The XML tag name of this search filter: "chargingContractSearchFilter"

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
`ChargingContractSearchFilterModel()` Constructs an empty filter.
`ChargingContractSearchFilterModel(java.lang.String tagName)` Constructs an empty filter.

Method Summary

All Methods Instance Methods Concrete Methods
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
  - TAG_NAME
```
public static final java.lang.String TAG_NAME
```
    The XML tag name of this search filter: "chargingContractSearchFilter"
    
    See Also:
    
    Constant Field Values
  - ID
```
public static final java.lang.String ID
```
    The name of the criterion that describes the value of the attribute "id" of the charging contract.
    The type of this criteria is a string.
    
    See Also:
    
    Constant Field Values
  - OPERATIONAL_STATUS
```
public static final java.lang.String OPERATIONAL_STATUS
```
    The name of the criterion that describes the value of the attribute "operationalStatus" of the charging contract.
    The type of this criteria is a string.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBER_ACCOUNT_CODE
```
public static final java.lang.String SUBSCRIBER_ACCOUNT_CODE
```
    The name of the criterion that describes the value of the attribute "subscriberAccountId" of the charging contract linked to a SubscriberAccountModel.getCode().
    The type of this criteria is a string.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBER_ACCOUNT_SERVICE_PROVIDER
```
public static final java.lang.String SUBSCRIBER_ACCOUNT_SERVICE_PROVIDER
```
    Name of the criterion that describes the value of the attribute "subscriberAccountServiceProvider" of the charging contract linked to a SubscriberAccountModel.getServiceProvider().
    The type of this criteria is a string.
    
    See Also:
    
    Constant Field Values
  - ROOT_CHARGING_CONTRACT_ID
```
public static final java.lang.String ROOT_CHARGING_CONTRACT_ID
```
    Name of the criterion that describes the value of the attribute "rootChargingContractId" of the charging contract linked to a root charging contract. In case the contract is root, the value of this attribute is the same as the ID of the contract.
    
    See Also:
    
    Constant Field Values
  - RERATING_LOCK_CODE
```
public static final java.lang.String RERATING_LOCK_CODE
```
    Name of the criterion that describes the value of the attribute "rerating_lock_code" of the charging contract.
    The type of this criteria is a string.
    
    See Also:
    
    Constant Field Values
  - RERATING_LAST_STATUS
```
public static final java.lang.String RERATING_LAST_STATUS
```
    Name of the criterion that describes the value of the attribute "rerating_last_status" of the charging contract.
    The type of this criteria is a number.
    
    See Also:
    
    Constant Field Values
  - RERATING_LAST_CODE
```
public static final java.lang.String RERATING_LAST_CODE
```
    Name of the criterion that describes the value of the attribute "rerating_last_code" of the charging contract.
    The type of this criteria is a string.
    
    See Also:
    
    Constant Field Values
  - RERATING_SUGGESTED_DATE
```
public static final java.lang.String RERATING_SUGGESTED_DATE
```
    Name of the criterion that describes the value of the attribute "rerating_suggested_date" of the charging contract.
    The type of this criteria is a date.
    
    See Also:
    
    Constant Field Values
  - HAS_RERATING_SUGGESTED_DATE
```
public static final java.lang.String HAS_RERATING_SUGGESTED_DATE
```
    The name of the specific formula that searches for a charging contract that was rerated and for which the billing system has suggested a date.
    
    See Also:
    
    Constant Field Values
  - IS_ROOT_CHARGING_CONTRACT
```
public static final java.lang.String IS_ROOT_CHARGING_CONTRACT
```
    The name of the specific formula returning root contracts (parent provider contracts and isolated contracts) and excluding the linked contracts from the results.
    
    See Also:
    
    Constant Field Values
  - IS_ACTIVE
```
public static final java.lang.String IS_ACTIVE
```
    Name of the specific formula returning root contracts (parent provider contracts and isolated contracts) having an operational status set to active.
    
    See Also:
    
    Constant Field Values
  - IS_LOCKED
```
public static final java.lang.String IS_LOCKED
```
    Name of the specific formula returning root contracts (parent provider contracts and isolated contracts) having an operational status set to locked.
    
    See Also:
    
    Constant Field Values
  - IS_CLOSED
```
public static final java.lang.String IS_CLOSED
```
    Name of the specific formula returning root contracts (parent provider contracts and isolated contracts) having an operational status set to closed .
    
    See Also:
    
    Constant Field Values
  - SUAC_ADD_INFO_KEY
```
public static final java.lang.String SUAC_ADD_INFO_KEY
```
    Name for the additional group key for Subscriber Account additional information.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ChargingContractSearchFilterModel
```
public ChargingContractSearchFilterModel()
```
    Constructs an empty filter. The XML name is: "chargingContractSearchFilter"
  - ChargingContractSearchFilterModel
```
public ChargingContractSearchFilterModel(java.lang.String tagName)
```
    Constructs an empty filter.
    
    Parameters:
    
    tagName - The tag name of this filter
- Method Detail
  - 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.
  - 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
  - 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
  - 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.
  - 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

Class ChargingContractSearchFilterModel

Implementation in Your Client Application

Advanced

Operation Request

Filtering Features

Search Criteria

Specific Formula

By Additional Information in Contracts

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

TAG_NAME

ID

OPERATIONAL_STATUS

SUBSCRIBER_ACCOUNT_CODE

SUBSCRIBER_ACCOUNT_SERVICE_PROVIDER

ROOT_CHARGING_CONTRACT_ID

RERATING_LOCK_CODE

RERATING_LAST_STATUS

RERATING_LAST_CODE

RERATING_SUGGESTED_DATE

HAS_RERATING_SUGGESTED_DATE

IS_ROOT_CHARGING_CONTRACT

IS_ACTIVE

IS_LOCKED

IS_CLOSED

SUAC_ADD_INFO_KEY

Constructor Detail

ChargingContractSearchFilterModel

ChargingContractSearchFilterModel

Method Detail

getMainAttributeDescriptionCatalog

getMainAttributeDescriptionFromCatalog

getSpecificFormulaCatalog

getSpecificFormulaFromCatalog

getFilterGroup