com.sun.syndication.feed.module
Interface SyModule

All Superinterfaces:
java.lang.Cloneable, CopyFrom, Module, ToString
All Known Implementing Classes:
SyModuleImpl

public interface SyModule
extends Module

Syndication ModuleImpl.

Author:
Alejandro Abdelnur
See Also:
Syndication module.

Nested Class Summary
static class SyModule.Period
          Enumeration type for the 'update period' property of the Syndication module.
 
Field Summary
static SyModule.Period DAILY
           
static SyModule.Period HOURLY
           
static SyModule.Period MONTHLY
           
static java.lang.String URI
          URI of the Syndication ModuleImpl (http://purl.org/rss/1.0/modules/syndication/).
static SyModule.Period WEEKLY
           
static SyModule.Period YEARLY
           
 
Method Summary
 java.util.Date getUpdateBase()
          Returns the Syndication module update base date.
 int getUpdateFrequency()
          Returns the Syndication module update frequency.
 SyModule.Period getUpdatePeriod()
          Returns the Syndication module update period.
 void setUpdateBase(java.util.Date updateBase)
          Sets the Syndication module update base date.
 void setUpdateFrequency(int updateFrequency)
          Sets the Syndication module update frequency.
 void setUpdatePeriod(SyModule.Period updatePeriod)
          Sets the Syndication module update period.
 
Methods inherited from interface com.sun.syndication.feed.module.Module
clone, getUri
 
Methods inherited from interface com.sun.syndication.common.ToString
toString
 
Methods inherited from interface com.sun.syndication.common.CopyFrom
copyFrom, getInterface
 

Field Detail

URI

public static final java.lang.String URI
URI of the Syndication ModuleImpl (http://purl.org/rss/1.0/modules/syndication/).

See Also:
Constant Field Values

HOURLY

public static final SyModule.Period HOURLY

DAILY

public static final SyModule.Period DAILY

WEEKLY

public static final SyModule.Period WEEKLY

MONTHLY

public static final SyModule.Period MONTHLY

YEARLY

public static final SyModule.Period YEARLY
Method Detail

getUpdatePeriod

public SyModule.Period getUpdatePeriod()
Returns the Syndication module update period.

Returns:
the Syndication module update period, null if none.

setUpdatePeriod

public void setUpdatePeriod(SyModule.Period updatePeriod)
Sets the Syndication module update period.

Parameters:
updatePeriod - the Syndication module update period to set, null if none.

getUpdateFrequency

public int getUpdateFrequency()
Returns the Syndication module update frequency.

Returns:
the Syndication module update frequency, null if none.

setUpdateFrequency

public void setUpdateFrequency(int updateFrequency)
Sets the Syndication module update frequency.

Parameters:
updateFrequency - the Syndication module update frequency to set, null if none.

getUpdateBase

public java.util.Date getUpdateBase()
Returns the Syndication module update base date.

Returns:
the Syndication module update base date, null if none.

setUpdateBase

public void setUpdateBase(java.util.Date updateBase)
Sets the Syndication module update base date.

Parameters:
updateBase - the Syndication module update base date to set, null if none.


Copyright © 2004 Sun Microsystems. All Rights Reserved.