SearchSubscriptionOp (SAP CC 1.0 - API Reference

Overview

Package

Class

Tree

Deprecated

Index

Help

SAP CC 1.0
API 4.2 (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 retreived 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 retreive subscriptions (other attributes are forgotten). IMPORTANT NOTE : If this operation is used in conjunction with some perimeter filter, the total item count (if required) will be always set to -1.

See Also :

SearchSubscriptionResult

Operation Failure Exception :

InvalidSearchException
ServerFailureException

Operation available with roles :

"csr" "admin"

XML Schema 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 :

Edition	Available On:
Edition	Rater	Updater	Backup	Guider	Charger	BulkLoader	BillingAssistant	EZTaxer
Rate	no	yes	no	no	no	no	no	no
Charge	no	yes	no	no	no	no	no	no
Bill	no	yes	no	no	no	no	no	no
Full	no	yes	no	no	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 objects, the `child` represents the marshallable object to be added into the content tree.
`java.util.Vector<AdditionalInfoModel>`	`getAdditionalInfos()` Deprecated. since Transactive 3.2, use the subscriptionSearchFilter.
`java.lang.String`	`getCode()` Deprecated. since Transactive 3.2, use the subscriptionSearchFilter.
`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. since Transactive 3.2, use the subscriptionSearchFilter.
`java.lang.String`	`getReference()` Deprecated. since Transactive 3.2, use the subscriptionSearchFilter.
`void`	`marshal(XMLOutputter output)` Gives an XML representation of this object, and of its children.
`void`	`setAdditionalInfos(java.util.Vector<AdditionalInfoModel> infos)` Deprecated. since Transactive 3.2, use the subscriptionSearchFilter.
`void`	`setAttributes(XMLAttributes atts)` Sets the attributes of the XML representation of the tag beeing processed.
`void`	`setCode(java.lang.String code)` Deprecated. since Transactive 3.2, use the subscriptionSearchFilter.
`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. since Transactive 3.2, use the subscriptionSearchFilter.
`void`	`setReference(java.lang.String reference)` Deprecated. since Transactive 3.2, use the subscriptionSearchFilter.

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.