fr.paris.lutece.plugins.directory.business
Class FieldHome

java.lang.Object
  extended by fr.paris.lutece.plugins.directory.business.FieldHome

public final class FieldHome
extends java.lang.Object

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


Method Summary
static void copy(Field field, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Copy of an instance of field
static int create(Field field, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Creation of an instance of field
static void createVerifyBy(int nIdField, int nIdExpression, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          insert an association between field and a regular expression
static Field findByPrimaryKey(int nKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns an instance of a Field whose identifier is specified in parameter
static Field findByValue(int nIdEntry, java.lang.String strValue, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns an instance of a Field whose value is specified in parameter ^@param the entry id
static java.util.List<Field> getFieldListByIdEntry(int nIdEntry, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the data of all the field of the entry and returns them in a list
static java.util.List<java.lang.Integer> getListRegularExpressionKeyByIdField(int nIdField, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the key of all the regularExpression associate to the field and returns them in a list
static boolean isRegularExpressionIsUse(int nIdExpression, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          verify if the regular expresssion is use
static void remove(int nIdField, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove the field whose identifier is specified in parameter
static void removeVerifyBy(int nIdField, int nIdExpression, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Delete an association between field and a regular expression
static void update(Field field, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update of the field 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 int create(Field field,
                         fr.paris.lutece.portal.service.plugin.Plugin plugin)
Creation of an instance of field

Parameters:
field - The instance of the Field which contains the informations to store
plugin - the Plugin
Returns:
The primary key of the new Field.

copy

public static void copy(Field field,
                        fr.paris.lutece.portal.service.plugin.Plugin plugin)
Copy of an instance of field

Parameters:
field - The instance of the Field who must copy
plugin - the Plugin

update

public static void update(Field field,
                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Update of the field which is specified in parameter

Parameters:
field - The instance of the Field which contains the informations to update
plugin - the Plugin

remove

public static void remove(int nIdField,
                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Remove the field whose identifier is specified in parameter

Parameters:
nIdField - The field Id
plugin - the Plugin

findByPrimaryKey

public static Field findByPrimaryKey(int nKey,
                                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Returns an instance of a Field whose identifier is specified in parameter

Parameters:
nKey - The field primary key
plugin - the Plugin
Returns:
an instance of Field

findByValue

public static Field findByValue(int nIdEntry,
                                java.lang.String strValue,
                                fr.paris.lutece.portal.service.plugin.Plugin plugin)
Returns an instance of a Field whose value is specified in parameter ^@param the entry id

Parameters:
strValue - strValue
plugin - the Plugin
Returns:
an instance of Field

getFieldListByIdEntry

public static java.util.List<Field> getFieldListByIdEntry(int nIdEntry,
                                                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Load the data of all the field of the entry and returns them in a list

Parameters:
nIdEntry - the id of the entry
plugin - the plugin
Returns:
the list of field

removeVerifyBy

public static void removeVerifyBy(int nIdField,
                                  int nIdExpression,
                                  fr.paris.lutece.portal.service.plugin.Plugin plugin)
Delete an association between field and a regular expression

Parameters:
nIdField - The identifier of the field
nIdExpression - The identifier of the regular expression
plugin - the plugin

createVerifyBy

public static void createVerifyBy(int nIdField,
                                  int nIdExpression,
                                  fr.paris.lutece.portal.service.plugin.Plugin plugin)
insert an association between field and a regular expression

Parameters:
nIdField - The identifier of the field
nIdExpression - The identifier of the regular expression
plugin - the plugin

getListRegularExpressionKeyByIdField

public static java.util.List<java.lang.Integer> getListRegularExpressionKeyByIdField(int nIdField,
                                                                                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Load the key of all the regularExpression associate to the field and returns them in a list

Parameters:
nIdField - the id of the field
plugin - the plugin
Returns:
the list of regular expression key

isRegularExpressionIsUse

public static boolean isRegularExpressionIsUse(int nIdExpression,
                                               fr.paris.lutece.portal.service.plugin.Plugin plugin)
verify if the regular expresssion is use

Parameters:
nIdExpression - The identifier of the regular expression
plugin - the plugin
Returns:
true if the regular expression is use


Copyright © 2012 Mairie de Paris. All Rights Reserved.