fr.paris.lutece.plugins.crm.service.category
Class CategoryService

java.lang.Object
  extended by fr.paris.lutece.plugins.crm.service.category.CategoryService

public class CategoryService
extends Object

CategoryService


Constructor Summary
protected CategoryService()
          Constructor
 
Method Summary
 int createCategory(Category category)
          Create an instance of the category class
 Category findByPrimaryKey(int nIdCategory)
          Returns an instance of a category whose identifier is specified in parameter
 Category findFirstCategory()
          Find the first category (order by the ID category)
 fr.paris.lutece.util.ReferenceList getCategories(Locale locale, boolean bAddAllCategory, boolean bIsDefaultChoiceTop)
          Load the data of all the category objects and returns them in form of a ReferenceList
 Collection<Category> getCategoriesList()
          Load the data of all the category objects and returns them in form of a collection
static CategoryService getService()
          Get the instance of CategoryService
 String removeCategory(int nIdCategory, Locale locale)
          Remove the category whose identifier is specified in parameter.
 void updateCategory(Category category)
          Update of the category which is specified in parameter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CategoryService

protected CategoryService()
Constructor

Method Detail

getService

public static CategoryService getService()
Get the instance of CategoryService

Returns:
an instance of CategoryService

getCategoriesList

public Collection<Category> getCategoriesList()
Load the data of all the category objects and returns them in form of a collection

Returns:
the collection which contains the data of all the category objects

getCategories

public fr.paris.lutece.util.ReferenceList getCategories(Locale locale,
                                                        boolean bAddAllCategory,
                                                        boolean bIsDefaultChoiceTop)
Load the data of all the category objects and returns them in form of a ReferenceList

Parameters:
locale - Locale
bAddAllCategory - true if the must contain all category, false otherwise
bIsDefaultChoiceTop - true if the default choices are put at the top of the list, false otherwise
Returns:
the ReferenceList which contains the data of all the category objects

findByPrimaryKey

public Category findByPrimaryKey(int nIdCategory)
Returns an instance of a category whose identifier is specified in parameter

Parameters:
nIdCategory - The category primary key
Returns:
an instance of Category

createCategory

public int createCategory(Category category)
Create an instance of the category class

Parameters:
category - The instance of the Category which contains the informations to store
Returns:
The instance of category which has been created with its primary key.

removeCategory

public String removeCategory(int nIdCategory,
                             Locale locale)
Remove the category whose identifier is specified in parameter. The category is removed if and only if it is not linked to any widget.

Parameters:
nIdCategory - The category Id
locale - Locale
Returns:
true if the category is linked to a widget, false otherwise

updateCategory

public void updateCategory(Category category)
Update of the category which is specified in parameter

Parameters:
category - The instance of the Category which contains the data to store

findFirstCategory

public Category findFirstCategory()
Find the first category (order by the ID category)

Returns:
a Category


Copyright © 2013 Mairie de Paris. All Rights Reserved.