oracle.syndication.ice.payload
Class Ice_request

java.lang.Object
  |
  +--oracle.xml.classgen.CGNode
        |
        +--oracle.syndication.ice.payload.Ice_request

public class Ice_request

extends oracle.xml.classgen.CGNode

implements Printable

The Node Class representing the ice-request element within an ICE payload. The child elements allowed under this element include the following:

• Ice_get_catalog
• Ice_offer
• Ice_get_package
• Ice_package (For PUSH)

The child elements that will not be covered in this release are:

• Ice_code

Since:

9.0.0.0.0 Beta

Method Summary

Type	Method
Ice_cancel	getCancelSubscription() Un-subscribe action in the current request
Ice_payload	getDocument() Get Document Class Ice_payload
oracle.xml.parser.v2.DTD	getDTDNode() Returns the Ice_payload DTD.
Ice_get_events	getGE() Get events for a given subscription
Ice_get_status	getGS() Get status for a given subscription
Ice_get_catalog	getICEGetCatalogRequest() If the current request is a request for catalog, the method will return a Ice_get_catalog object This method usually is used combined with hasCatalogRequest()
Ice_get_package	getICEGetPackageRequest() The current request is a PULL content request
Ice_offer	getICEOffer() If the current request is a subscribing request, the method will return an Ice_offer, which will contain the offer item id from the server and the delivery policy, business terms from the subscriber itself This method should be combined used with hasOffer()
java.util.List	getICEPushedPackages() The current request is sent out by the syndicator and used for delivering PUSHed content
Ice_notify	getNofication() Notification message inside the current request
Ice_nop	getNop() NOP action for the current request
java.lang.String	getRequestId() This is a string identifying this request.
java.lang.String	getRequestOperationName()
java.lang.String	getSubscriptionId() Support for event logging It only makes sense when there is a subscription associated with the current request
boolean	hasCancelSubscription() Has CancelSubscription typed request
boolean	hasCatalogRequest() Has GetCatalog typed request
boolean	hasGetEvents() Has Get events typed request
boolean	hasGetStatus() Has Get status typed request
boolean	hasNop() Has Nop typed request
boolean	hasNotify() Has Notify typed request
boolean	hasOffer() Has Ice-offer typed request
boolean	hasPackageRequest() Has GetPackage typed request
boolean	hasPushedPackage() Has PushedPackage typed request
void	print(java.lang.String szSpace, java.io.Writer wrt) Printable interface allows this node to be printed.

Methods inherited from class oracle.xml.classgen.CGNode

setDocument

Methods inherited from class java.lang.Object

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

Method Detail

getRequestId

public java.lang.String getRequestId()

This is a string identifying this request. The id is generated by the Sender and MUST be unique across all ICE payloads that a Sender sends to a particular Receiver.

Returns:

Id in the format of java.lang.String

getSubscriptionId

public java.lang.String getSubscriptionId()

Support for event logging It only makes sense when there is a subscription associated with the current request

getICEGetCatalogRequest

public Ice_get_catalog getICEGetCatalogRequest()

If the current request is a request for catalog, the method will return a Ice_get_catalog object This method usually is used combined with hasCatalogRequest()

Returns:

Ice_get_catalog

getICEOffer

public Ice_offer getICEOffer()

If the current request is a subscribing request, the method will return an Ice_offer, which will contain the offer item id from the server and the delivery policy, business terms from the subscriber itself This method should be combined used with hasOffer()

Returns:

Ice_offer if there is any; otherwise a NULL will be returned

getICEGetPackageRequest

public Ice_get_package getICEGetPackageRequest()

The current request is a PULL content request

Returns:

Ice_get_package

getICEPushedPackages

public java.util.List getICEPushedPackages()

The current request is sent out by the syndicator and used for delivering PUSHed content

Returns:

Packages in a java.util.List format

getCancelSubscription

public Ice_cancel getCancelSubscription()

Un-subscribe action in the current request

Returns:

Ice_cancel

getNop

public Ice_nop getNop()

NOP action for the current request

Returns:

Ice_nop

getNofication

public Ice_notify getNofication()

Notification message inside the current request

Returns:

Ice_notify

getGS

public Ice_get_status getGS()

Get status for a given subscription

Returns:

Ice_get_status

getGE

public Ice_get_events getGE()

Get events for a given subscription

Returns:

Ice_get_events

hasNop

public boolean hasNop()

Has Nop typed request

Returns:

TRUE if there is one element; FALSE otherwise

hasNotify

public boolean hasNotify()

Has Notify typed request

Returns:

TRUE if there is one element; FALSE otherwise

hasCatalogRequest

public boolean hasCatalogRequest()

Has GetCatalog typed request

Returns:

TRUE if there is one element; FALSE otherwise

hasOffer

public boolean hasOffer()

Has Ice-offer typed request

Returns:

TRUE if there is one element; FALSE otherwise

hasPackageRequest

public boolean hasPackageRequest()

Has GetPackage typed request

Returns:

TRUE if there is one element; FALSE otherwise

hasPushedPackage

public boolean hasPushedPackage()

Has PushedPackage typed request

Returns:

TRUE if there is one element; FALSE otherwise

hasCancelSubscription

public boolean hasCancelSubscription()

Has CancelSubscription typed request

Returns:

TRUE if there is one element; FALSE otherwise

hasGetStatus

public boolean hasGetStatus()

Has Get status typed request

Returns:

TRUE if there is one element; FALSE otherwise

hasGetEvents

public boolean hasGetEvents()

Has Get events typed request

Returns:

TRUE if there is one element; FALSE otherwise

getRequestOperationName

public java.lang.String getRequestOperationName()

getDTDNode

public oracle.xml.parser.v2.DTD getDTDNode()

Returns the Ice_payload DTD.

Returns:

the DTD

See Also:

DTD

getDocument

public Ice_payload getDocument()

Get Document Class Ice_payload

Returns:

Ice_payload class

print

public void print(java.lang.String szSpace,
                  java.io.Writer wrt)
           throws java.io.IOException

Printable interface allows this node to be printed.

Specified by:

print in interface Printable