Package com.rometools.modules.sse.modules

Class Related

java.lang.Object

com.rometools.modules.sse.modules.SSEModule

com.rometools.modules.sse.modules.Related

All Implemented Interfaces:

CopyFrom, Module, Serializable, Cloneable

public class Related
extends SSEModule

Element within

.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	AGGREGATED	Indicates whether the link points to a feed whose contents are being incorporated into this feed by the publisher.
static int	COMPLETE	Indicates whether the link points to a file containing the complete collection of items for this feed.
static String	LINK_ATTRIBUTE
static String	NAME
static String	SINCE_ATTRIBUTE
static String	TITLE_ATTRIBUTE
static String	TYPE_ATTRIBUTE
static String	UNTIL_ATTRIBUTE

Fields inherited from class com.rometools.modules.sse.modules.SSEModule

NAMESPACES, PREFIX, SSE_NS, SSE_SCHEMA_URI

Constructor Summary

Constructors

Constructor	Description
Related()

Method Summary

Modifier and Type	Method	Description
void	copyFrom(CopyFrom obj)
String	getLink()	link A required, URL attribute.
Date	getSince()	An optional, date-time attribute.
String	getTitle()	title An optional, string attribute.
Integer	getType()	type A required, string attribute.
Date	getUntil()	An optional, date-time attribute.
void	setLink(String link)	Set the URL for related feeds.
void	setSince(Date since)	Set the starting point of the related feed.
void	setTitle(String title)	Set the name or description of the related feed.
void	setType(Integer type)	Set the type of relationship, complete or aggregated.
void	setUntil(Date until)	Set the ending point of the feed, until.

Methods inherited from class com.rometools.modules.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

COMPLETE

public static final int COMPLETE

Indicates whether the link points to a file containing the complete collection of items for this feed.

See Also:

Constant Field Values

AGGREGATED

public static final int AGGREGATED

Indicates whether the link points to a feed whose contents are being incorporated into this feed by the publisher.

See Also:

Constant Field Values

LINK_ATTRIBUTE

public static final String LINK_ATTRIBUTE

See Also:

Constant Field Values

SINCE_ATTRIBUTE

public static final String SINCE_ATTRIBUTE

See Also:

Constant Field Values

TITLE_ATTRIBUTE

public static final String TITLE_ATTRIBUTE

See Also:

Constant Field Values

TYPE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

See Also:

Constant Field Values

UNTIL_ATTRIBUTE

public static final String UNTIL_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

Related

public Related()

Method Detail

copyFrom

public void copyFrom(CopyFrom obj)

Specified by:

copyFrom in interface CopyFrom

Specified by:

copyFrom in class SSEModule

getLink

public String getLink()

link A required, URL attribute. The URL for related feeds.

Returns:

the URL for related feeds

setLink

public void setLink(String link)

Set the URL for related feeds.

Parameters:

link - the URL for related feeds.

getTitle

public String getTitle()

title An optional, string attribute. The name or description of the related feed.

Returns:

The name or description of the related feed.

setTitle

public void setTitle(String title)

Set the name or description of the related feed.

Parameters:

title - the name or description of the related feed.

getType

public Integer getType()

type A required, string attribute. This attribute can have one of the following values:

"complete" if the link points to file containing the complete collection of items for this feed.

"aggregated" if the link points to a feed whose contents are being incorporated into this feed by the publisher.

Returns:

the type of the releated feed.

setType

public void setType(Integer type)

Set the type of relationship, complete or aggregated.

Parameters:

type - the type of relationship, complete or aggregated.

getSince

public Date getSince()

An optional, date-time attribute. This is the starting point of the related feed. If this attribute is omitted or blank, it is assumed that this is a complete feed.

Returns:

the starting point of the related feed.

setSince

public void setSince(Date since)

Set the starting point of the related feed.

Parameters:

since - the starting point of the related feed.

getUntil

public Date getUntil()

An optional, date-time attribute. This is the ending point of a feed.

Returns:

the ending point of the feed, until.

setUntil

public void setUntil(Date until)

Set the ending point of the feed, until. An optional, date-time attribute.

Parameters:

until - the ending point of the feed.