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
 java.lang.String createHtmlRss()
          create Html Rss
 void deleteResourceRssConfig(int idResourceRss)
          Update the ResourceRss configuration
 void doSaveConfig(javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          Save the ResourceRss configuration
 void doUpdateConfig(javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          Update the ResourceRss configuration
 java.lang.String doValidateConfigForm(javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          validates the user input associated to the resource rss
 java.lang.String getDescription()
           
 java.lang.String getDisplayCreateConfigForm(javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          returns the informations which must be displayed in the creation resourceRss configuration
 java.lang.String getDisplayModifyConfigForm(javax.servlet.http.HttpServletRequest request, java.util.Locale locale)
          returns the informations which must be displayed in the modification resourceRss configuration
 int getId()
           
 java.lang.String getName()
           
 java.util.Map<java.lang.String,java.lang.String> getParameterToApply(javax.servlet.http.HttpServletRequest request)
          Return the list of parameter to keep when action apply
 IResourceRssType getResourceRssType()
           
 void setDescription(java.lang.String strDescription)
          set the description
 void setId(int nId)
          set the rss id
 void setName(java.lang.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

java.lang.String getDescription()
Returns:
the description

setDescription

void setDescription(java.lang.String strDescription)
set the description

Parameters:
strDescription - the description

getName

java.lang.String getName()
Returns:
the name

setName

void setName(java.lang.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

java.lang.String doValidateConfigForm(javax.servlet.http.HttpServletRequest request,
                                      java.util.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

java.lang.String getDisplayCreateConfigForm(javax.servlet.http.HttpServletRequest request,
                                            java.util.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

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

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

doSaveConfig

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

Parameters:
request - request
locale - locale

doUpdateConfig

void doUpdateConfig(javax.servlet.http.HttpServletRequest request,
                    java.util.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

java.lang.String createHtmlRss()
create Html Rss

Returns:
Html rss

deleteResourceRssConfig

void deleteResourceRssConfig(int idResourceRss)
Update the ResourceRss configuration

Parameters:
idResourceRss - id of resourceRss

getParameterToApply

java.util.Map<java.lang.String,java.lang.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


Copyright © 2010 Mairie de Paris. All Rights Reserved.