SearchSubscriptionOp (SAP CC 4.0 Core

Overview

Package

Class

Tree

Deprecated

Index

Help

SAP Convergent Charging

Core APIs (Java and XML)

BART APIs (Java and XML)

IEC APIs (Java)

Java and XML APIs (Core)

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.highdeal.pnr.hci
Class SearchSubscriptionOp

java.lang.Object
  com.highdeal.pnr.hci.SearchSubscriptionOp

All Implemented Interfaces:: MessageOperation, XMLMarshallable

public class SearchSubscriptionOp
extends java.lang.Object
implements MessageOperation
extends java.lang.Object
implements MessageOperation

This operation allows to retrieve subscriptions. Subscriptions could be retrieved by two way.
- First, a subscriptionSearchFilter can be used. The filter allows to describe the subscription wanted.
- The second way, which is deprecated , is to specify the subscription code or/and the offerCode or/and the subscriber or/and the subscription reference. As this research system is deprecated, favour the first usage.

If the subscriptionSearchFilter is not null, only this filter is used in order to retrieve subscriptions (other attributes are forgotten).

Operation Result

SearchSubscriptionResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchSubscription">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="subscriptionSearchFilter" minOccurs="0" maxOccurs="1"/>
       <xs:element ref="additionalInformation" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="code" type="xs:string"/>
     <xs:attribute name="offerCode" type="xs:string"/>
     <xs:attribute name="reference" type="xs:string"/>
     <xs:attribute name="fromCode" type="xs:string"/>
     <xs:attribute name="maxSize" type="xs:integer"/>
   </xs:complexType>
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

Edition	Final Target Instances
Edition	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	Yes	No	No	No	No

Field Summary
`static java.lang.String`	`OPERATION_NAME`

Constructor Summary
`SearchSubscriptionOp()` Builds a search subscription operation.

Method Summary
`void`	`addCharacterData(java.lang.String cData)` Adds character data to the content element.
`void`	`addChild(java.lang.String name, XMLMarshallable child)` Adds a child to the object, the `child` representing the marshallable object which must be added to the element.
`java.util.Vector<AdditionalInfoModel>`	`getAdditionalInfos()` Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
`java.lang.String`	`getCode()` Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
`SubscriptionSearchFilterModel`	`getFilter()` Gets the subscription filter.
`java.lang.String`	`getFromCode()` Gets the code of the subscription from which subscriptions should be fetched
`java.math.BigDecimal`	`getMaxSize()` Gets the maximum number of subscriptions to be retrieved for this operation.
`java.lang.String`	`getName()` Gets the name of the operation.
`java.lang.String`	`getOfferCode()` Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
`java.lang.String`	`getReference()` Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
`void`	`marshal(XMLOutputter output)` Gives an XML representation of this object, including its children.
`void`	`setAdditionalInfos(java.util.Vector<AdditionalInfoModel> infos)` Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
`void`	`setAttributes(XMLAttributes atts)` Sets the attributes of the XML representation of the element being processed.
`void`	`setCode(java.lang.String code)` Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
`void`	`setFilter(SubscriptionSearchFilterModel filter)` Sets the subscription filter.
`void`	`setFromCode(java.lang.String code)` Sets the from subscription code.
`void`	`setMaxSize(java.math.BigDecimal max)` Sets a maximum number of subscriptions.
`void`	`setOfferCode(java.lang.String oc)` Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
`void`	`setReference(java.lang.String reference)` Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

See Also:: Constant Field Values

Constructor Detail

SearchSubscriptionOp

public SearchSubscriptionOp()

Builds a search subscription operation.

Method Detail

getFilter

public SubscriptionSearchFilterModel getFilter()

Gets the subscription filter.

Returns:: Returns the filter.

setFilter

public void setFilter(SubscriptionSearchFilterModel filter)

Sets the subscription filter.

Parameters:: filter - The filter to set.