org.rometools.feed.module.sse.modules
Class Update

java.lang.Object
  org.rometools.feed.module.sse.modules.SSEModule
      org.rometools.feed.module.sse.modules.Update

All Implemented Interfaces:

com.sun.syndication.feed.CopyFrom, com.sun.syndication.feed.module.Module, Serializable, Cloneable

public class Update
extends SSEModule

Element within

.

See Also:

Serialized Form

Field Summary

static String	BY_ATTRIBUTE
static String	NAME
static String	WHEN_ATTRIBUTE

Fields inherited from class org.rometools.feed.module.sse.modules.SSEModule

NAMESPACES, PREFIX, SSE_NS, SSE_SCHEMA_URI

Constructor Summary

Update()

Method Summary

void	copyFrom(com.sun.syndication.feed.CopyFrom other)
String	getBy() Provides access to a text attribute identifying the unique endpoint that made a modification.
Date	getWhen() Provides access to the date-time when the modification took place.
void	setBy(String by) Sets a text attribute identifying the unique endpoint that made a modification.
void	setWhen(Date when) Set the date-time when the modification took place.

Methods inherited from class org.rometools.feed.module.sse.modules.SSEModule

clone, getInterface, getUri

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

BY_ATTRIBUTE

public static final String BY_ATTRIBUTE

See Also:

Constant Field Values

WHEN_ATTRIBUTE

public static final String WHEN_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

Update

public Update()

Method Detail

copyFrom

public void copyFrom(com.sun.syndication.feed.CopyFrom other)

Specified by:

copyFrom in interface com.sun.syndication.feed.CopyFrom

Specified by:

copyFrom in class SSEModule

getWhen

public Date getWhen()

Provides access to the date-time when the modification took place. If this attribute is omitted the value defaults to the earliest time representable in RFC 822. Either or both of the when or by attributes MUST be present; it is invalid to have neither.

setWhen

public void setWhen(Date when)

Set the date-time when the modification took place.

Parameters:

when - the date-time when the modification took place.

getBy

public String getBy()

Provides access to a text attribute identifying the unique endpoint that made a modification. This SHOULD be some combination of user and device (so that a given user can edit a feed on multiple devices). This attribute is used programmatically to break ties in case two changes happened at the same time (within the same second). Either or both of the when or by must be present; it is invalid to have neither.

Returns:

access to a text attribute identifying the unique endpoint that made a modification.

setBy

public void setBy(String by)

Sets a text attribute identifying the unique endpoint that made a modification.

Parameters:

by - a text attribute identifying the unique endpoint that made a modification.