fr.paris.lutece.portal.business.rss
Interface IResourceRss

All Known Implementing Classes:
ResourceRss

public interface IResourceRss

IResourceRss


Method Summary
 boolean checkResource()
          verify that the resource exist
 boolean contentResourceRss()
          verified that the resource contains the resource to be exploited
 String createHtmlRss()
          Deprecated. use getFeed() instead.
 void deleteResourceRssConfig(int idResourceRss)
          Update the ResourceRss configuration
 void doSaveConfig(javax.servlet.http.HttpServletRequest request, Locale locale)
          Save the ResourceRss configuration
 void doUpdateConfig(javax.servlet.http.HttpServletRequest request, Locale locale)
          Update the ResourceRss configuration
 String doValidateConfigForm(javax.servlet.http.HttpServletRequest request, Locale locale)
          validates the user input associated to the resource rss
 String getDescription()
           
 String getDisplayCreateConfigForm(javax.servlet.http.HttpServletRequest request, Locale locale)
          returns the informations which must be displayed in the creation resourceRss configuration
 String getDisplayModifyConfigForm(javax.servlet.http.HttpServletRequest request, Locale locale)
          returns the informations which must be displayed in the modification resourceRss configuration
 String getEncoding()
          Gets the encoding
 IFeedResource getFeed()
          Gets the feed with items
 String getFeedType()
          Gets the feed type
 int getId()
           
 int getMaxItems()
          The number of displayed item.
 String getName()
           
 Map<String,String> getParameterToApply(javax.servlet.http.HttpServletRequest request)
          Return the list of parameter to keep when action apply
 IResourceRssType getResourceRssType()
           
 void setDescription(String strDescription)
          set the description
 void setEncoding(String strEncoding)
          Sets the encoding
 void setFeedType(String strFeedType)
          Sets the feed type
 void setId(int nId)
          set the rss id
 void setMaxItems(int nMaxItems)
          Sets the number of displayed item
 void setName(String strName)
          set the name
 void setResourceRssType(IResourceRssType resourceRssType)
          set the ResourceRssType object
 

Method Detail

getId

int getId()
Returns:
the rss Id

setId

void setId(int nId)
set the rss id

Parameters:
nId - the rss id

getDescription

String getDescription()
Returns:
the description

setDescription

void setDescription(String strDescription)
set the description

Parameters:
strDescription - the description

getName

String getName()
Returns:
the name

setName

void setName(String strName)
set the name

Parameters:
strName - the name

getResourceRssType

IResourceRssType getResourceRssType()
Returns:
the ResourceRssType Object

setResourceRssType

void setResourceRssType(IResourceRssType resourceRssType)
set the ResourceRssType object

Parameters:
resourceRssType - the ResourceRsstype object

doValidateConfigForm

String doValidateConfigForm(javax.servlet.http.HttpServletRequest request,
                            Locale locale)
validates the user input associated to the resource rss

Parameters:
request - request
locale - locale
Returns:
null if there is no error in the resourceRss form else return the error message url

getDisplayCreateConfigForm

String getDisplayCreateConfigForm(javax.servlet.http.HttpServletRequest request,
                                  Locale locale)
returns the informations which must be displayed in the creation resourceRss configuration

Parameters:
request - request
locale - locale
Returns:
the information which must be displayed in the creation resourceRss configuration

getDisplayModifyConfigForm

String getDisplayModifyConfigForm(javax.servlet.http.HttpServletRequest request,
                                  Locale locale)
returns the informations which must be displayed in the modification resourceRss configuration

Parameters:
request - request
locale - locale
Returns:
the information which must be displayed in the modification resourceRss configuration

doSaveConfig

void doSaveConfig(javax.servlet.http.HttpServletRequest request,
                  Locale locale)
Save the ResourceRss configuration

Parameters:
request - request
locale - locale

doUpdateConfig

void doUpdateConfig(javax.servlet.http.HttpServletRequest request,
                    Locale locale)
Update the ResourceRss configuration

Parameters:
request - request
locale - locale

contentResourceRss

boolean contentResourceRss()
verified that the resource contains the resource to be exploited

Returns:
true if resourceRss content resource

createHtmlRss

@Deprecated
String createHtmlRss()
Deprecated. use getFeed() instead.

create Html Rss

Returns:
Html rss

getFeed

IFeedResource getFeed()
Gets the feed with items

Returns:
the IFeedResource

deleteResourceRssConfig

void deleteResourceRssConfig(int idResourceRss)
Update the ResourceRss configuration

Parameters:
idResourceRss - id of resourceRss

getParameterToApply

Map<String,String> getParameterToApply(javax.servlet.http.HttpServletRequest request)
Return the list of parameter to keep when action apply

Parameters:
request - request
Returns:
the map of parameter

checkResource

boolean checkResource()
verify that the resource exist

Returns:
true if resource exist

getFeedType

String getFeedType()
Gets the feed type

Returns:
the feed type

setFeedType

void setFeedType(String strFeedType)
Sets the feed type

Parameters:
strFeedType - the feed type

getEncoding

String getEncoding()
Gets the encoding

Returns:
the encoding

setEncoding

void setEncoding(String strEncoding)
Sets the encoding

Parameters:
strEncoding - the encoding

getMaxItems

int getMaxItems()
The number of displayed item.

Returns:
the number of displayed item

setMaxItems

void setMaxItems(int nMaxItems)
Sets the number of displayed item

Parameters:
nMaxItems - number of displayed item


Copyright © 2014 Mairie de Paris. All Rights Reserved.