com.sun.syndication.feed.module.sse.modules
Class Related

java.lang.Object
  extended by com.sun.syndication.feed.module.sse.modules.SSEModule
      extended by com.sun.syndication.feed.module.sse.modules.Related
All Implemented Interfaces:
com.sun.syndication.feed.CopyFrom, com.sun.syndication.feed.module.Module, java.io.Serializable, java.lang.Cloneable

public class Related
extends SSEModule

Element within
.

See Also:
Serialized Form

Field Summary
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 java.lang.String LINK_ATTRIBUTE
           
static java.lang.String NAME
           
static java.lang.String SINCE_ATTRIBUTE
           
static java.lang.String TITLE_ATTRIBUTE
           
static java.lang.String TYPE_ATTRIBUTE
           
static java.lang.String UNTIL_ATTRIBUTE
           
 
Fields inherited from class com.sun.syndication.feed.module.sse.modules.SSEModule
NAMESPACES, PREFIX, SSE_NS, SSE_SCHEMA_URI
 
Constructor Summary
Related()
           
 
Method Summary
 void copyFrom(java.lang.Object obj)
           
 java.lang.String getLink()
          link A required, URL attribute.
 java.util.Date getSince()
          An optional, date-time attribute.
 java.lang.String getTitle()
          title An optional, string attribute.
 java.lang.Integer getType()
          type A required, string attribute.
 java.util.Date getUntil()
          An optional, date-time attribute.
 void setLink(java.lang.String link)
          Set the URL for related feeds.
 void setSince(java.util.Date since)
          Set the starting point of the related feed.
 void setTitle(java.lang.String title)
          Set the name or description of the related feed.
 void setType(java.lang.Integer type)
          Set the type of relationship, complete or aggregated.
 void setUntil(java.util.Date until)
          Set the ending point of the feed, until.
 
Methods inherited from class com.sun.syndication.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 java.lang.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 java.lang.String LINK_ATTRIBUTE
See Also:
Constant Field Values

SINCE_ATTRIBUTE

public static final java.lang.String SINCE_ATTRIBUTE
See Also:
Constant Field Values

TITLE_ATTRIBUTE

public static final java.lang.String TITLE_ATTRIBUTE
See Also:
Constant Field Values

TYPE_ATTRIBUTE

public static final java.lang.String TYPE_ATTRIBUTE
See Also:
Constant Field Values

UNTIL_ATTRIBUTE

public static final java.lang.String UNTIL_ATTRIBUTE
See Also:
Constant Field Values
Constructor Detail

Related

public Related()
Method Detail

copyFrom

public void copyFrom(java.lang.Object obj)
Specified by:
copyFrom in interface com.sun.syndication.feed.CopyFrom
Specified by:
copyFrom in class SSEModule

getLink

public java.lang.String getLink()
link A required, URL attribute. The URL for related feeds.

Returns:
the URL for related feeds

setLink

public void setLink(java.lang.String link)
Set the URL for related feeds.

Parameters:
link - the URL for related feeds.

getTitle

public java.lang.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(java.lang.String title)
Set the name or description of the related feed.

Parameters:
title - the name or description of the related feed.

getType

public java.lang.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(java.lang.Integer type)
Set the type of relationship, complete or aggregated.

Parameters:
type - the type of relationship, complete or aggregated.

getSince

public java.util.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(java.util.Date since)
Set the starting point of the related feed.

Parameters:
since - the starting point of the related feed.

getUntil

public java.util.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(java.util.Date until)
Set the ending point of the feed, until. An optional, date-time attribute.

Parameters:
until - the ending point of the feed.


Copyright © 2006-2009. All Rights Reserved.