fr.paris.lutece.plugins.htmldocs.business

Class HtmlDocHome

java.lang.Object

fr.paris.lutece.plugins.htmldocs.business.HtmlDocHome

public final class HtmlDocHome
extends Object

This class provides instances management methods (create, find, ...) for HtmlDoc objects

Method Summary

Modifier and Type	Method and Description
static HtmlDoc	addInitialVersion(HtmlDoc htmlDoc) Create an initial version of an htmlDoc
static HtmlDoc	addNewVersion(HtmlDoc htmlDoc) Adds a new version of an htmlDoc
static HtmlDoc	create(HtmlDoc htmlDoc) Create an instance of the htmlDoc class
static HtmlDoc	createVersion(HtmlDoc htmlDoc) Create an instance of the htmlDoc class
static List<HtmlDoc>	findByFilter(HtmlDocFilter filter, Locale locale) Returns a collection of HtmlDoc objects
static HtmlDoc	findByName(String strName) Returns an instance of a htmlDoc whose identifier is specified in parameter
static HtmlDoc	findByPrimaryKey(int nKey) Returns an instance of a htmlDoc whose identifier is specified in parameter
static HtmlDoc	findVersion(int nId, int nVersion) Returns an instance of a htmlDoc whose identifier is specified in parameter
static List<HtmlDoc>	getHtmlDocsList() Load the data of all the htmlDoc objects and returns them as a list
static fr.paris.lutece.util.ReferenceList	getHtmlDocsReferenceList() Load the data of all the htmlDoc objects and returns them as a referenceList
static List<HtmlDoc>	getHtmlDocsVersionsList(int nId) Load the data of all the htmlDoc objects and returns them as a list
static List<Integer>	getIdHtmlDocsList() Load the id of all the htmlDoc objects and returns them as a list
static void	remove(int nKey) Remove the htmlDoc whose identifier is specified in parameter
static void	removeVersions(int nKey) Remove the htmlDoc's versions whose identifier is specified in parameter
static HtmlDoc	update(HtmlDoc htmlDoc) Update of the htmlDoc which is specified in parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static HtmlDoc create(HtmlDoc htmlDoc)

Create an instance of the htmlDoc class

Parameters:

htmlDoc - The instance of the HtmlDoc which contains the informations to store

Returns:

The instance of htmlDoc which has been created with its primary key.

createVersion

public static HtmlDoc createVersion(HtmlDoc htmlDoc)

Create an instance of the htmlDoc class

Parameters:

htmlDoc - The instance of the HtmlDoc which contains the informations to store

Returns:

The instance of htmlDoc which has been created with its primary key.

update

public static HtmlDoc update(HtmlDoc htmlDoc)

Update of the htmlDoc which is specified in parameter

Parameters:

htmlDoc - The instance of the HtmlDoc which contains the data to store

Returns:

The instance of the htmlDoc which has been updated

remove

public static void remove(int nKey)

Remove the htmlDoc whose identifier is specified in parameter

Parameters:

nKey - The htmlDoc Id

removeVersions

public static void removeVersions(int nKey)

Remove the htmlDoc's versions whose identifier is specified in parameter

Parameters:

nKey - The htmlDoc Id

findByPrimaryKey

public static HtmlDoc findByPrimaryKey(int nKey)

Returns an instance of a htmlDoc whose identifier is specified in parameter

Parameters:

nKey - The htmlDoc primary key

Returns:

an instance of HtmlDoc

findByName

public static HtmlDoc findByName(String strName)

Returns an instance of a htmlDoc whose identifier is specified in parameter

Parameters:

nKey - The htmlDoc primary key

Returns:

an instance of HtmlDoc

findVersion

public static HtmlDoc findVersion(int nId,
                                  int nVersion)

Returns an instance of a htmlDoc whose identifier is specified in parameter

Parameters:

nKey - The htmlDoc primary key

Returns:

an instance of HtmlDoc

getHtmlDocsList

public static List<HtmlDoc> getHtmlDocsList()

Load the data of all the htmlDoc objects and returns them as a list

Returns:

the list which contains the data of all the htmlDoc objects

getHtmlDocsVersionsList

public static List<HtmlDoc> getHtmlDocsVersionsList(int nId)

Load the data of all the htmlDoc objects and returns them as a list

Returns:

the list which contains the data of all the htmlDoc objects

getIdHtmlDocsList

public static List<Integer> getIdHtmlDocsList()

Load the id of all the htmlDoc objects and returns them as a list

Returns:

the list which contains the id of all the htmlDoc objects

getHtmlDocsReferenceList

public static fr.paris.lutece.util.ReferenceList getHtmlDocsReferenceList()

Load the data of all the htmlDoc objects and returns them as a referenceList

Returns:

the referenceList which contains the data of all the htmlDoc objects

addInitialVersion

public static HtmlDoc addInitialVersion(HtmlDoc htmlDoc)

Create an initial version of an htmlDoc

Parameters:

htmlDoc - The instance of the HtmlDoc which contains the informations to store

Returns:

The instance of htmlDoc which has been created with its primary key.

addNewVersion

public static HtmlDoc addNewVersion(HtmlDoc htmlDoc)

Adds a new version of an htmlDoc

Parameters:

htmlDoc - The instance of the HtmlDoc which contains the informations to store

Returns:

The instance of the htmlDoc which has been updated

findByFilter

public static List<HtmlDoc> findByFilter(HtmlDocFilter filter,
                                         Locale locale)

Returns a collection of HtmlDoc objects

Parameters:

filter - The filter

locale - The locale

Returns:

A collection of HtmlDocs