fr.paris.lutece.plugins.contact.business
Class ContactHome

java.lang.Object
  extended by fr.paris.lutece.plugins.contact.business.ContactHome

public final class ContactHome
extends java.lang.Object

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


Method Summary
static Contact create(Contact contact, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Creation of an instance of contact
static Contact findByPrimaryKey(int nKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns an instance of a contact whose identifier is specified in parameter
static java.util.Collection findContactsList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns a collection of contacts objects
static fr.paris.lutece.util.ReferenceList getContactList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns a reference list which contains all the contacts
static int getIdByOrder(int nContactOrder, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Search the order number of contacts
static int getMaxOrderContact(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Search the max order number of contacts
static void remove(Contact contact, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove the Contact whose identifier is specified in parameter
static Contact update(Contact contact, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update of the contact which is specified in parameter
static void updateContactOrder(int nNewOrder, int nId, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update the number order of contact
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static Contact create(Contact contact,
                             fr.paris.lutece.portal.service.plugin.Plugin plugin)
Creation of an instance of contact

Parameters:
contact - The instance of the contact which contains the informations to store
plugin - The Plugin object
Returns:
The instance of contact which has been created with its primary key.

update

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

Parameters:
contact - The instance of the contact which contains the data to store
plugin - The Plugin object
Returns:
The instance of the contact which has been updated

remove

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

Parameters:
contact - The Contact object to remove
plugin - The Plugin object

findByPrimaryKey

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

Parameters:
nKey - The Primary key of the contact
plugin - The Plugin object
Returns:
An instance of contact

findContactsList

public static java.util.Collection findContactsList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Returns a collection of contacts objects

Parameters:
plugin - The Plugin object
Returns:
A collection of contacts

getContactList

public static fr.paris.lutece.util.ReferenceList getContactList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Returns a reference list which contains all the contacts

Parameters:
plugin - The Plugin object
Returns:
a reference list

getMaxOrderContact

public static int getMaxOrderContact(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Search the max order number of contacts

Parameters:
plugin - The Plugin object
Returns:
int the max order

getIdByOrder

public static int getIdByOrder(int nContactOrder,
                               fr.paris.lutece.portal.service.plugin.Plugin plugin)
Search the order number of contacts

Parameters:
nContactOrder - the number of order of the contact
plugin - The Plugin object
Returns:
int the id by a given order

updateContactOrder

public static void updateContactOrder(int nNewOrder,
                                      int nId,
                                      fr.paris.lutece.portal.service.plugin.Plugin plugin)
Update the number order of contact

Parameters:
nNewOrder - the new number of order
nId - the Identifier of contact
plugin - The Plugin object


Copyright © 2007 Mairie de Paris. All Rights Reserved.