com.sapportals.wcm.protocol.ice.protocol.request

Class WCMSendMail

java.lang.Object
  com.sapportals.wcm.protocol.ice.protocol.request.WCMSendMail

All Implemented Interfaces:

IICEElement, IICEExtensionRequest, IICERequestElement

public class WCMSendMail
extends Object
implements IICEExtensionRequest

WCMSendMail represents a wcm-sendmail extension request. With this request the client informs the server that it should send a package update via EMail.

Detailed information about ICE extensions could be found in the ICE 1.1 specification section 8.4 . wcm-send-mail format

 <!ELEMENT wcm-send-mail               EMPTY >
 <!ATTLIST wcm-send-mail
           subscription-id            CDATA           #REQUIRED
 >

Copyright 2004 SAP AG

Field Summary

static String

TAGNAME

Constructor Summary

WCMSendMail(Attributes attributes)
Create a new WCMSendMail extension request.

WCMSendMail(String subscriptionID)
Create a new WCMSendMail extension request.

Method Summary

String	getSubscriptionID() Get the id of the subscription to be pulled.
void	write(ContentHandler handler) Write the XML representation of the ICE element to a SAX ContentHandler.
boolean	writeChunk(ContentHandler handler) Write a chunk of XML to a SAX ContentHandler.

Methods inherited from class java.lang.Object

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

Field Detail

TAGNAME

public static final String TAGNAME

See Also:

Constant Field Values

Constructor Detail

WCMSendMail

public WCMSendMail(String subscriptionID)

Create a new WCMSendMail extension request.

Parameters:

subscriptionID - The id of the subscription which references should be updated

WCMSendMail

public WCMSendMail(Attributes attributes)

Create a new WCMSendMail extension request. This constructor is used by ICEInput to decode an WCMResolveReferences request from an ICE payload.

Parameters:

attributes - The attributes of the wcm-send-mail tag

Method Detail

getSubscriptionID

public String getSubscriptionID()

Get the id of the subscription to be pulled.

Returns:

The if of the subscription to be pulled

write

public void write(ContentHandler handler)
           throws SAXException

Write the XML representation of the ICE element to a SAX ContentHandler. This method is used by ICEOutput to create an ICE payload.

Specified by:

write in interface IICEElement

Parameters:

handler - The SAX ContentHandler (usually an XMLSerializer)

Throws:

SAXException - on error (might wrap another exception)

writeChunk

public boolean writeChunk(ContentHandler handler)
                   throws SAXException

Write a chunk of XML to a SAX ContentHandler. This method is used by ICEOutput to write an ICE payload in chunked mode.

Specified by:

writeChunk in interface IICEElement

Parameters:

handler - The SAX ContentHandler (usually a XMLSerializer)

Returns:

true if there are more chunks in the queue

Throws:

SAXException - on error (might wrap another exception)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM