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

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

All Implemented Interfaces:

XMLMarshallable
```
public class SubscriptionSearchFilterModel
extends SearchFilterModel
```
This class represents the subscription filter. It allows to retrieve any subscription by using attributeDescriptionModel to build search criteria.
If no attributeDescriptionModel is given, all the subscriptions are returned.
Available main AttributeDescriptionModel names are :
Please consult SearchFilterModel for more information. The element name for the subscription filter is set to "subscriptionSearchFilter". Available specific formula code for this filter are :
Please consult SpecificFormulaModel for more information on specific formula XML Schema. NOTE: The specific formula MUST_BE_ROOT_CODE is set by default in a SearchSubscriptionOp.
XML API for HCI
The XML APIs specify the following XSD fragment:
XSD Fragment
```
<xs:element name="subscriptionSearchFilter" 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 search for `batchRatingGroupId`.
`static java.lang.String`	`CANCELLATION_DATE` Name of the attributeDescription that search for `cancellationDate`.
`static java.lang.String`	`CODE` Name of the attributeDescription that search for `code`.
`static java.lang.String`	`COMMITMENT_EXPIRATION` Name of the attributeDescription that search for `commitmentExpiration`.
`static java.lang.String`	`CONTAIN_CODE` Name of the specific formula that search for a subscription containing an object.
`static java.lang.String`	`EFFECTIVE` Name of the attributeDescription that search for `effective`.
`static java.lang.String`	`EXPIRATION` Name of the attributeDescription that search for `expiration`.
`static java.lang.String`	`HAS_RERATING_SUGGESTED_DATE` Name of the specific formula that search for a subscription that was rerated and for which the billing system has suggested a date.
`static java.lang.String`	`IS_CONTAINED_CODE` Name of the specific formula that search for a subscription contained in an object.
`static java.lang.String`	`IS_HYBRID` Name of the specific formula that search for an offline.
`static java.lang.String`	`IS_LOCKED` Name of the specific formula that search for a locked subscription (has a reratingLockCode).
`static java.lang.String`	`IS_NOT_LOCKED` Name of the specific formula that search for a not locked subscription (has no reratingLockCode).
`static java.lang.String`	`IS_OFFLINE` Name of the specific formula that search for an offline.
`static java.lang.String`	`IS_ONLINE` Name of the specific formula that search for an offline.
`static java.lang.String`	`MUST_BE_ROOT_CODE` Name of the specific formula that search for a subscription which is root.
`static java.lang.String`	`OFFER_CODE` Name of the attributeDescription that search for `offerCode`.
`static java.lang.String`	`OFFER_CONDITION_CODE` Name of the attributeDescription that search for `offerConditionCode`.
`static java.lang.String`	`PARTITION_ID` Name of the attributeDescription that search for `partitionID`.
`static java.lang.String`	`PRICE_FREEZE_EFFECTIVE` Name of the attributeDescription that search for `priceFreezeEffective`.
`static java.lang.String`	`PRICE_FREEZE_EXPIRATION` Name of the attributeDescription that search for `priceFreezeExpiration`.
`static java.lang.String`	`RERATING_LAST_CODE` Name of the attributeDescription that search for `reratingLastCode`.
`static java.lang.String`	`RERATING_LAST_STATUS` Name of the attributeDescription that search for `reratingLastStatus`.
`static java.lang.String`	`RERATING_LOCK_CODE` Name of the attributeDescription that search for `reratingLockCode`.
`static java.lang.String`	`RERATING_SUGGESTED_DATE` Name of the attributeDescription that search for `reratingSuggestedDate`.
`static java.lang.String`	`RESUMPTION_DATE` Name of the attributeDescription that search for `resumptionDate`.
`static java.lang.String`	`STATUS` Name of the attributeDescription that search for `status`.
`static java.lang.String`	`SUBSCRIBER_ACCOUNT_SERVICE_PROVIDER` Name of the specific formula that search for the subscriber account service provider.
`static java.lang.String`	`SUSPENSION_DATE` Name of the attributeDescription that search for `suspensionDate`.
`static java.lang.String`	`TYPE` Name of the attributeDescription that search for `type`.

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

SubscriptionSearchFilterModel()
Builds an empty SubscriptionSearchFilterModel.

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

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 name)` 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 code)` 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
  - CODE
```
public static final java.lang.String CODE
```
    Name of the attributeDescription that search for code. The type of the corresponding attributeDescription is string
    
    See Also:
    
    Constant Field Values
  - OFFER_CODE
```
public static final java.lang.String OFFER_CODE
```
    Name of the attributeDescription that search for offerCode. The type of the corresponding attributeDescription is string
    
    See Also:
    
    Constant Field Values
  - OFFER_CONDITION_CODE
```
public static final java.lang.String OFFER_CONDITION_CODE
```
    Name of the attributeDescription that search for offerConditionCode. The type of the corresponding attributeDescription is string
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final java.lang.String TYPE
```
    Name of the attributeDescription that search for type. The type of the corresponding attributeDescription is number
    
    See Also:
    
    Constant Field Values
  - EFFECTIVE
```
public static final java.lang.String EFFECTIVE
```
    Name of the attributeDescription that search for effective. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - EXPIRATION
```
public static final java.lang.String EXPIRATION
```
    Name of the attributeDescription that search for expiration. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - PRICE_FREEZE_EFFECTIVE
```
public static final java.lang.String PRICE_FREEZE_EFFECTIVE
```
    Name of the attributeDescription that search for priceFreezeEffective. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - PRICE_FREEZE_EXPIRATION
```
public static final java.lang.String PRICE_FREEZE_EXPIRATION
```
    Name of the attributeDescription that search for priceFreezeExpiration. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - COMMITMENT_EXPIRATION
```
public static final java.lang.String COMMITMENT_EXPIRATION
```
    Name of the attributeDescription that search for commitmentExpiration. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - SUSPENSION_DATE
```
public static final java.lang.String SUSPENSION_DATE
```
    Name of the attributeDescription that search for suspensionDate. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - RESUMPTION_DATE
```
public static final java.lang.String RESUMPTION_DATE
```
    Name of the attributeDescription that search for resumptionDate. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - CANCELLATION_DATE
```
public static final java.lang.String CANCELLATION_DATE
```
    Name of the attributeDescription that search for cancellationDate. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - BATCH_RATING_GROUP_ID
```
public static final java.lang.String BATCH_RATING_GROUP_ID
```
    Name of the attributeDescription that search for batchRatingGroupId. The type of the corresponding attributeDescription is number
    
    See Also:
    
    Constant Field Values
  - RERATING_LOCK_CODE
```
public static final java.lang.String RERATING_LOCK_CODE
```
    Name of the attributeDescription that search for reratingLockCode. The type of the corresponding attributeDescription is number
    
    See Also:
    
    Constant Field Values
  - RERATING_LAST_STATUS
```
public static final java.lang.String RERATING_LAST_STATUS
```
    Name of the attributeDescription that search for reratingLastStatus. The type of the corresponding attributeDescription is number
    
    See Also:
    
    Constant Field Values
  - RERATING_LAST_CODE
```
public static final java.lang.String RERATING_LAST_CODE
```
    Name of the attributeDescription that search for reratingLastCode. The type of the corresponding attributeDescription is number
    
    See Also:
    
    Constant Field Values
  - RERATING_SUGGESTED_DATE
```
public static final java.lang.String RERATING_SUGGESTED_DATE
```
    Name of the attributeDescription that search for reratingSuggestedDate. The type of the corresponding attributeDescription is date
    
    See Also:
    
    Constant Field Values
  - IS_OFFLINE
```
public static final java.lang.String IS_OFFLINE
```
    Name of the specific formula that search for an offline.
    
    See Also:
    
    Constant Field Values
  - IS_HYBRID
```
public static final java.lang.String IS_HYBRID
```
    Name of the specific formula that search for an offline.
    
    See Also:
    
    Constant Field Values
  - IS_ONLINE
```
public static final java.lang.String IS_ONLINE
```
    Name of the specific formula that search for an offline.
    
    See Also:
    
    Constant Field Values
  - IS_LOCKED
```
public static final java.lang.String IS_LOCKED
```
    Name of the specific formula that search for a locked subscription (has a reratingLockCode).
    
    See Also:
    
    Constant Field Values
  - IS_NOT_LOCKED
```
public static final java.lang.String IS_NOT_LOCKED
```
    Name of the specific formula that search for a not locked subscription (has no reratingLockCode).
    
    See Also:
    
    Constant Field Values
  - HAS_RERATING_SUGGESTED_DATE
```
public static final java.lang.String HAS_RERATING_SUGGESTED_DATE
```
    Name of the specific formula that search for a subscription that was rerated and for which the billing system has suggested a date.
    
    See Also:
    
    Constant Field Values
  - PARTITION_ID
```
public static final java.lang.String PARTITION_ID
```
    Name of the attributeDescription that search for partitionID. The type of the corresponding attributeDescription is number
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final java.lang.String STATUS
```
    Name of the attributeDescription that search for status. The type of the corresponding attributeDescription is number
    
    See Also:
    
    Constant Field Values
  - IS_CONTAINED_CODE
```
public static final java.lang.String IS_CONTAINED_CODE
```
    Name of the specific formula that search for a subscription contained in an object.
    
    See Also:
    
    Constant Field Values
  - CONTAIN_CODE
```
public static final java.lang.String CONTAIN_CODE
```
    Name of the specific formula that search for a subscription containing an object.
    
    See Also:
    
    Constant Field Values
  - MUST_BE_ROOT_CODE
```
public static final java.lang.String MUST_BE_ROOT_CODE
```
    Name of the specific formula that search for a subscription which is root.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBER_ACCOUNT_SERVICE_PROVIDER
```
public static final java.lang.String SUBSCRIBER_ACCOUNT_SERVICE_PROVIDER
```
    Name of the specific formula that search for the subscriber account service provider.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SubscriptionSearchFilterModel
```
public SubscriptionSearchFilterModel()
```
    Builds an empty SubscriptionSearchFilterModel.
- Method Detail
  - getSpecificFormulaFromCatalog
```
public SpecificFormulaModel getSpecificFormulaFromCatalog(java.lang.String code)
```
    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:
    
    code - 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 name)
```
    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:
    
    name - 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

Class SubscriptionSearchFilterModel

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

CODE

OFFER_CODE

OFFER_CONDITION_CODE

TYPE

EFFECTIVE

EXPIRATION

PRICE_FREEZE_EFFECTIVE

PRICE_FREEZE_EXPIRATION

COMMITMENT_EXPIRATION

SUSPENSION_DATE

RESUMPTION_DATE

CANCELLATION_DATE

BATCH_RATING_GROUP_ID

RERATING_LOCK_CODE

RERATING_LAST_STATUS

RERATING_LAST_CODE

RERATING_SUGGESTED_DATE

IS_OFFLINE

IS_HYBRID

IS_ONLINE

IS_LOCKED

IS_NOT_LOCKED

HAS_RERATING_SUGGESTED_DATE

PARTITION_ID

STATUS

IS_CONTAINED_CODE

CONTAIN_CODE

MUST_BE_ROOT_CODE

SUBSCRIBER_ACCOUNT_SERVICE_PROVIDER

Constructor Detail

SubscriptionSearchFilterModel

Method Detail

getSpecificFormulaFromCatalog

getSpecificFormulaCatalog

getMainAttributeDescriptionFromCatalog

getMainAttributeDescriptionCatalog

getFilterGroup