com.highdeal.pnr.hci

Class SearchSubscriptionOp

java.lang.Object

com.highdeal.pnr.hci.SearchSubscriptionOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class SearchSubscriptionOp
extends 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

• InvalidSearchException
• ServerFailureException

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
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	Yes	No	No	No	No

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME

Constructor Summary

Constructors

Constructor and Description
SearchSubscriptionOp() Builds a search subscription operation.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String name, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
Vector<AdditionalInfoModel>	getAdditionalInfos() Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
String	getCode() Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
SubscriptionSearchFilterModel	getFilter() Gets the subscription filter.
String	getFromCode() Gets the code of the subscription from which subscriptions should be fetched
BigDecimal	getMaxSize() Gets the maximum number of subscriptions to be retrieved for this operation.
String	getName() Gets the name of the operation.
String	getOfferCode() Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
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(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(String code) Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
void	setFilter(SubscriptionSearchFilterModel filter) Sets the subscription filter.
void	setFromCode(String code) Sets the from subscription code.
void	setMaxSize(BigDecimal max) Sets a maximum number of subscriptions.
void	setOfferCode(String oc) Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.
void	setReference(String reference) Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_NAME

public static final 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.

getCode

public String getCode()

Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Gets the code of the subscription

Returns:

The code of the subscription

setCode

public void setCode(String code)

Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Sets the code of the subscription

Parameters:

code - The code of the subscription

getReference

public String getReference()

Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Gets the reference of the subscription

Returns:

The reference of the subscription

setReference

public void setReference(String reference)

Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Sets the reference of the subscription

Parameters:

reference - The reference of the subscription

getOfferCode

public String getOfferCode()

Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Gets the offer code.

Returns:

the offer code.

setOfferCode

public void setOfferCode(String oc)

Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Sets the offer code

Parameters:

oc - The offer code

getAdditionalInfos

public Vector<AdditionalInfoModel> getAdditionalInfos()

Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Returns the list of AdditionalInfoModel.

Returns:

the list of the associated additional info.

setAdditionalInfos

public void setAdditionalInfos(Vector<AdditionalInfoModel> infos)

Deprecated. Use the subscriptionSearchFilter instead. Deprecated since former Transactive 3.2.

Sets the list of additional infos.

Parameters:

infos - the list of additional info.

getFromCode

public String getFromCode()

Gets the code of the subscription from which subscriptions should be fetched

Returns:

the from subscription code

setFromCode

public void setFromCode(String code)

Sets the from subscription code. This method should be used with its companion setMaxSize(BigDecimal).

Parameters:

code - the from subscription code.

getMaxSize

public BigDecimal getMaxSize()

Gets the maximum number of subscriptions to be retrieved for this operation.

Returns:

the maximum size.

setMaxSize

public void setMaxSize(BigDecimal max)

Sets a maximum number of subscriptions.

Parameters:

max - the maximum number of subscriptions to be retrieved for this operation.

getName

public String getName()

Gets the name of the operation.

Specified by:

getName in interface MessageOperation

Returns:

the name of the operation.

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

addChild

public void addChild(String name,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

name - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into