public class ICEDeliveryRule extends Object implements IICEElement, IDOMStorable
Copyright 2004 SAP AG
Modifier and Type | Field and Description |
---|---|
static String |
CID_DELIVERY_RULE
Description of the Field
|
static String |
TAGNAME
Description of the Field
|
Constructor and Description |
---|
ICEDeliveryRule(Attributes attributes)
Create a new ICEDeliveryRule.
|
ICEDeliveryRule(Element element)
Create an ICEDeliveryRule object from a DOM-element.
|
ICEDeliveryRule(ICEDeliveryMode mode)
Create a new ICEDeliveryRule.
|
ICEDeliveryRule(String configId) |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Returns a clone of this delivery rule.
|
void |
deleteConfig(com.sapportals.config.fwk.IConfigPlugin icePlugin) |
boolean |
equals(Object obj)
Compare two delivery rules.
|
String |
getConfigId()
Gets the identifier of the configurable which stores the configuration of
this rule.
|
ICEDeliveryMode |
getDeliveryMode()
Get the delivery mode.
|
long |
getDuration()
Get the duration.
|
long |
getMaxUpdateInterval()
Get the maximum update interval.
|
long |
getMinUpdateInterval()
Get the minimum update interval.
|
int[] |
getMonthDay()
Get the allowed month days.
|
Date |
getStartDate()
Get the start date.
|
Date |
getStartTime()
Get the start time.
|
Date |
getStopDate()
Get the stop date.
|
String |
getUrl()
Get the url of the delivery policy.
|
int[] |
getWeekDay()
Get the allowed week days.
|
int |
hashCode()
Calculate a hash code for the delivery rule.
|
boolean |
match(ICEDeliveryMode mode,
Date date,
Date lastUpdate)
Checks if a certain time is matched by this delivery rule.
|
void |
saveConfig(com.sapportals.config.fwk.IConfigPlugin icePlugin) |
void |
setMaxUpdateInterval(long maxUpdateInterval)
Set the maximum update interval.
|
void |
setMinUpdateInterval(long minUpdateInterval)
Set the minimum update interval.
|
void |
setMonthDay(int[] monthDay)
Set the allowed month days.
|
void |
setStartDate(Date startDate)
Set the start date of the delivery rule.
|
void |
setStopDate(Date stopDate)
Set the stop date of the delivery rule.
|
void |
setTimeWindow(Date startTime,
long duration)
Set the start time and duration.
|
void |
setUrl(String url)
Set the url of the delivery policy.
|
void |
setWeekDay(int[] weekDay)
Set the allowed week days.
|
Node |
store(Document document)
Store the informations into a DOM.
|
String |
toString()
Returns a string representation of this delivery rule.
|
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.
|
public static final String TAGNAME
public static final String CID_DELIVERY_RULE
public ICEDeliveryRule(ICEDeliveryMode mode)
mode
- The delivery mode (push or pull)public ICEDeliveryRule(Attributes attributes) throws SAXException
attributes
- The attributes of the ice-delivery-policy tag.SAXException
- Exception raised in failure situationSAXException
- on error (might encapsulate another exceptionpublic ICEDeliveryRule(Element element)
element
- A DOM-element containing the data of the delivery rulepublic ICEDeliveryRule(String configId) throws com.sapportals.config.fwk.InitialConfigException, com.sapportals.config.fwk.CannotAccessConfigException
configId
- Description of the Parametercom.sapportals.config.fwk.CannotAccessConfigException
- Description of the Exceptioncom.sapportals.config.fwk.InitialConfigException
- Description of the Exceptionpublic void setUrl(String url)
url
- The url of the delivery policypublic void setStartDate(Date startDate)
startDate
- The start datepublic void setStopDate(Date stopDate)
stopDate
- The stop datepublic void setTimeWindow(Date startTime, long duration)
startTime
- The start timeduration
- The durationpublic void setMonthDay(int[] monthDay)
monthDay
- The allowed month dayspublic void setWeekDay(int[] weekDay)
weekDay
- The allowed week dayspublic void setMinUpdateInterval(long minUpdateInterval)
minUpdateInterval
- The minimum update intervalpublic void setMaxUpdateInterval(long maxUpdateInterval)
maxUpdateInterval
- The maximum update intervalpublic String getUrl()
public Date getStartDate()
public Date getStopDate()
public Date getStartTime()
public long getDuration()
public int[] getMonthDay()
public int[] getWeekDay()
public ICEDeliveryMode getDeliveryMode()
public long getMinUpdateInterval()
public long getMaxUpdateInterval()
public String getConfigId()
public Object clone()
public boolean match(ICEDeliveryMode mode, Date date, Date lastUpdate)
mode
- the delivery mode to filter the rulesdate
- the date that has to be matched (might be null)lastUpdate
- the date of the last update (might be null)public void write(ContentHandler handler) throws SAXException
write
in interface IICEElement
handler
- The SAX ContentHandler (usually an XMLSerializer)SAXException
- on error (might wrap another exception)public boolean writeChunk(ContentHandler handler) throws SAXException
writeChunk
in interface IICEElement
handler
- The SAX ContentHandler (usually a XMLSerializer)SAXException
- on error (might wrap another exception)public Node store(Document document)
store
in interface IDOMStorable
document
- The DOM document that should be used as factory for the DOM elementspublic void saveConfig(com.sapportals.config.fwk.IConfigPlugin icePlugin) throws com.sapportals.config.fwk.ConfigException
com.sapportals.config.fwk.ConfigException
public void deleteConfig(com.sapportals.config.fwk.IConfigPlugin icePlugin) throws com.sapportals.config.fwk.ConfigException
com.sapportals.config.fwk.ConfigException
public boolean equals(Object obj)
public int hashCode()
Access Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice