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

Class ICEGetEvents

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

All Implemented Interfaces:

IICEElement, IICERequestElement

public class ICEGetEvents
extends Object
implements IICERequestElement

ICEGetEvents represents an ice-get-events request. Detailed informations about the ICE get events request could be found in the ICE 1.1 specification ice-get-events format

 
 
     

   

 
 


 Copyright 2004 SAP AG









Field Summary




static String
TAGNAME



           


 



Constructor Summary
ICEGetEvents()



          Create a new ICEGetEvents request.
ICEGetEvents(Attributes attributes)



          Create a new ICEGetEvents request.
ICEGetEvents(String format,
             Date start,
             Date stop,
             String subscriptionID)



          Create a new ICEGetEvents request.
 



Method Summary




 String
getFormat()



          Get the format of the event log.



 Date
getStart()



          Get the start timestamp of the event log.



 Date
getStop()



          Get the stop timestamp of the event log.



 String
getSubscriptionID()



          Get the identifier of the subscription.



 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



ICEGetEvents
public ICEGetEvents()

Create a new ICEGetEvents request. Default Constructor.





ICEGetEvents
public ICEGetEvents(String format,
                    Date start,
                    Date stop,
                    String subscriptionID)

Create a new ICEGetEvents request.


Parameters:
format - The event log format (might be null)
start - The start timestamp of the event log (might be null)
stop - The end timestamp of the event log (might be null)
subscriptionID - The id of the subscription (might be null)




ICEGetEvents
public ICEGetEvents(Attributes attributes)

Create a new ICEGetEvents request. This constructor is used by ICEInput to decode an ICE get events request from an
 ICE payload.


Parameters:
attributes - The attributes of the ice-get-events element





Method Detail



getFormat
public String getFormat()

Get the format of the event log.






Returns:
The format of the event log or null





getStart
public Date getStart()

Get the start timestamp of the event log.






Returns:
The start timestamp of the event log or null





getStop
public Date getStop()

Get the stop timestamp of the event log.






Returns:
The stop timestamp of the event log or null





getSubscriptionID
public String getSubscriptionID()

Get the identifier of the subscription.






Returns:
The identifier of the subscription or null





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-CM


[sap.com] tc/km/frwk


api


EP-KM-CM




[sap.com] KMC-WPC


[sap.com] tc/kmc/wpc/wpcfacade


api


EP-PIN-WPC-WCM