fr.paris.lutece.plugins.document.business.spaces
Class DocumentSpaceHome

java.lang.Object
  extended by fr.paris.lutece.plugins.document.business.spaces.DocumentSpaceHome

public final class DocumentSpaceHome
extends java.lang.Object

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


Method Summary
static DocumentSpace create(DocumentSpace documentSpace)
          Creation of an instance of documentSpace
static java.util.Collection<DocumentSpace> findAll()
          Select all spaces
static DocumentSpace findByPrimaryKey(int nKey)
          Returns an instance of a documentSpace whose identifier is specified in parameter
static java.util.List<DocumentSpace> findChilds(int nParentSpaceId)
          Returns a collection of documentSpaces objects
static fr.paris.lutece.util.ReferenceList getAllowedDocumentTypes(int nSpaceId)
          Returns all allowed document types for a given space
static fr.paris.lutece.util.ReferenceList getDocumentSpaceList()
          Returns a ReferenceList of documentSpaces objects
static fr.paris.lutece.util.ReferenceList getIconsList()
          Gets a list of icons available or space customization
static fr.paris.lutece.util.ReferenceList getViewTypeList(java.util.Locale locale)
          Returns a ReferenceList of documentSpaces objects
static void remove(int nDocumentSpaceId)
          Remove the DocumentSpace whose identifier is specified in parameter
static DocumentSpace update(DocumentSpace documentSpace)
          Update of the documentSpace 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 DocumentSpace create(DocumentSpace documentSpace)
Creation of an instance of documentSpace

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

update

public static DocumentSpace update(DocumentSpace documentSpace)
Update of the documentSpace which is specified in parameter

Parameters:
documentSpace - The instance of the documentSpace which contains the data to store
Returns:
The instance of the documentSpace which has been updated

remove

public static void remove(int nDocumentSpaceId)
Remove the DocumentSpace whose identifier is specified in parameter

Parameters:
nDocumentSpaceId -

findByPrimaryKey

public static DocumentSpace findByPrimaryKey(int nKey)
Returns an instance of a documentSpace whose identifier is specified in parameter

Parameters:
nKey - The Primary key of the documentSpace
Returns:
An instance of documentSpace

findChilds

public static java.util.List<DocumentSpace> findChilds(int nParentSpaceId)
Returns a collection of documentSpaces objects

Parameters:
nParentSpaceId -
Returns:
A collection of documentSpaces

getDocumentSpaceList

public static fr.paris.lutece.util.ReferenceList getDocumentSpaceList()
Returns a ReferenceList of documentSpaces objects

Returns:
A ReferenceList of documentSpaces

getViewTypeList

public static fr.paris.lutece.util.ReferenceList getViewTypeList(java.util.Locale locale)
Returns a ReferenceList of documentSpaces objects

Parameters:
locale -
Returns:
A ReferenceList of documentSpaces

getIconsList

public static fr.paris.lutece.util.ReferenceList getIconsList()
Gets a list of icons available or space customization

Returns:
A list of icons

findAll

public static java.util.Collection<DocumentSpace> findAll()
Select all spaces

Returns:
A collection of all spaces.

getAllowedDocumentTypes

public static fr.paris.lutece.util.ReferenceList getAllowedDocumentTypes(int nSpaceId)
Returns all allowed document types for a given space

Parameters:
nSpaceId - The space Id
Returns:
Allowed documents types as a ReferenceList


Copyright © 2010 Mairie de Paris. All Rights Reserved.