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

Interface IDocumentSpaceDAO

All Known Implementing Classes:

DocumentSpaceDAO

public interface IDocumentSpaceDAO

DocumentSpaceDAO Interface

Method Summary

Modifier and Type	Method and Description
void	delete(int nSpaceId) Delete a record from the table
fr.paris.lutece.util.ReferenceList	getAllowedDocumentTypes(int nSpaceId) Returns all allowed document types for a given space
fr.paris.lutece.util.ReferenceList	getDocumentSpaceList() Load the list of documentSpaces
fr.paris.lutece.util.ReferenceList	getIconsList() Gets a list of icons available or space customization
fr.paris.lutece.util.ReferenceList	getViewTypeList(Locale locale) Load the list of documentSpaces
void	insert(DocumentSpace space) Insert a new record in the table.
DocumentSpace	load(int nDocumentSpaceId) Load the data of DocumentSpace from the table
List<DocumentSpace>	selectAll() Select all spaces
List<DocumentSpace>	selectChilds(int nSpaceId, String strCodeType) Load the list of documentSpaces childs
List<DocumentSpace>	selectSpacesAllowingDocumentCreationByDocumentType(String strCodeType, int createDocumentIsAllowed) Load the list of documentSpaces authorizing the selected document type
void	store(DocumentSpace space) Update the record in the table

Method Detail

delete

void delete(int nSpaceId)

Delete a record from the table

Parameters:

nSpaceId - The Id to delete

getAllowedDocumentTypes

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

getDocumentSpaceList

fr.paris.lutece.util.ReferenceList getDocumentSpaceList()

Load the list of documentSpaces

Returns:

The Collection of the DocumentSpaces

getIconsList

fr.paris.lutece.util.ReferenceList getIconsList()

Gets a list of icons available or space customization

Returns:

A list of icons

getViewTypeList

fr.paris.lutece.util.ReferenceList getViewTypeList(Locale locale)

Load the list of documentSpaces

Parameters:

locale - The Locale

Returns:

The Collection of the DocumentSpaces

insert

void insert(DocumentSpace space)

Insert a new record in the table.

Parameters:

space - The space object

load

DocumentSpace load(int nDocumentSpaceId)

Load the data of DocumentSpace from the table

Parameters:

nDocumentSpaceId - The identifier of DocumentSpace

Returns:

the instance of the DocumentSpace

selectAll

List<DocumentSpace> selectAll()

Select all spaces

Returns:

A collection of all spaces.

selectChilds

List<DocumentSpace> selectChilds(int nSpaceId,
                                 String strCodeType)

Load the list of documentSpaces childs

Parameters:

strCodeType - the document type filter if needed (null if not)

nSpaceId - The space identifier

Returns:

The Collection of the DocumentSpaces

selectSpacesAllowingDocumentCreationByDocumentType

List<DocumentSpace> selectSpacesAllowingDocumentCreationByDocumentType(String strCodeType,
                                                                       int createDocumentIsAllowed)

Load the list of documentSpaces authorizing the selected document type

Parameters:

strCodeType - the document type filter

createDocumentIsAllowed - code to define if document creation is allowed or not

Returns:

The Collection of the DocumentSpaces

store

void store(DocumentSpace space)

Update the record in the table

Parameters:

space - The reference of space