com.sun.syndication.feed.module.SyModule Maven / Gradle / Ivy
/*
* Copyright 2004 Sun Microsystems, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.sun.syndication.feed.module;
import java.util.Date;
/**
* Syndication ModuleImpl.
*
* @see Syndication module.
* @author Alejandro Abdelnur
*
*/
public interface SyModule extends Module {
/**
* URI of the Syndication ModuleImpl (http://purl.org/rss/1.0/modules/syndication/).
*
*/
String URI = "http://purl.org/rss/1.0/modules/syndication/";
String HOURLY = new String("hourly");
String DAILY = new String("daily");
String WEEKLY = new String("weekly");
String MONTHLY = new String("monthly");
String YEARLY = new String("yearly");
/**
* Returns the Syndication module update period.
*
* @return the Syndication module update period, null if none.
*
*/
String getUpdatePeriod();
/**
* Sets the Syndication module update period.
*
* @param updatePeriod the Syndication module update period to set, null if none.
*
*/
void setUpdatePeriod(String updatePeriod);
/**
* Returns the Syndication module update frequency.
*
* @return the Syndication module update frequency, null if none.
*
*/
int getUpdateFrequency();
/**
* Sets the Syndication module update frequency.
*
* @param updateFrequency the Syndication module update frequency to set, null if none.
*
*/
void setUpdateFrequency(int updateFrequency);
/**
* Returns the Syndication module update base date.
*
* @return the Syndication module update base date, null if none.
*
*/
Date getUpdateBase();
/**
* Sets the Syndication module update base date.
*
* @param updateBase the Syndication module update base date to set, null if none.
*
*/
void setUpdateBase(Date updateBase);
}