fr.paris.lutece.plugins.document.business

Interface IDocumentDAO

All Known Implementing Classes:

DocumentDAO

public interface IDocumentDAO

Interface for DocumentDAO

Method Summary

Modifier and Type	Method and Description
void	delete(int nDocumentId) Delete a record from the table
String	getPageTemplateDocumentPath(int idPageTemplateDocument) Load document pageTemplatePath
void	insert(Document document) Insert a new record in the table.
Document	load(int nDocumentId) Load the data of Document from the table
void	loadAttributes(Document document) Load document attributes
void	loadAttributesWithoutBinaries(Document document, boolean bValidated) Load document attributes
List<Document>	loadFromSpaceId(int nSpaceId) Returns documents by space id
Document	loadLastModifiedAttributes(int nDocumentId) Load document type and date last modification for HTTP GET conditional request ("If-Modified-Since")
Document	loadLastModifiedDocumentFromUser(String strUserName) Load the data of last Document the user worked in from the table
Document	loadLastPublishedDocument() Load the data of last Document the user worked in from the table
DocumentResource	loadResource(int nDocumentId) Load a resource (image, file, ...) corresponding to an attribute of a Document
DocumentResource	loadSpecificResource(int nDocumentId, int nAttributeId, boolean bValidated) Load a resource (image, file, ...) corresponding to an attribute of a Document
Document	loadWithoutBinaries(int nDocumentId) Returns an instance of a document whose identifier is specified in parameter
int	newPrimaryKey() Generates a new primary key
List<Document>	selectAll() Gets all documents
Collection<Integer>	selectAllPrimaryKeys() Gets all documents id
List<Document>	selectByFilter(DocumentFilter filter) Load the list of documents
List<Document>	selectByRelatedCategories(Document document) Load the list of published documents in relation with categories of specified document
Collection<Integer>	selectPrimaryKeysByFilter(DocumentFilter filter) Load the list of documents
void	store(Document document, boolean bUpdateContent) Update the record in the table
void	validateAttributes(int nDocumentId) Validate the document attributes

Method Detail

newPrimaryKey

int newPrimaryKey()

Generates a new primary key

Returns:

The new primary key

delete

void delete(int nDocumentId)

Delete a record from the table

Parameters:

nDocumentId - the document identifier

insert

void insert(Document document)

Insert a new record in the table.

Parameters:

document - The document object

load

Document load(int nDocumentId)

Load the data of Document from the table

Parameters:

nDocumentId - The identifier of Document

Returns:

the instance of the Document

loadWithoutBinaries

Document loadWithoutBinaries(int nDocumentId)

Returns an instance of a document whose identifier is specified in parameter

Parameters:

nDocumentId - The Primary key of the document

Returns:

An instance of document

loadFromSpaceId

List<Document> loadFromSpaceId(int nSpaceId)

Returns documents by space id

Parameters:

nSpaceId - The space Id

Returns:

A list of documents

loadResource

DocumentResource loadResource(int nDocumentId)

Load a resource (image, file, ...) corresponding to an attribute of a Document

Parameters:

nDocumentId - The Document Id

Returns:

the instance of the DocumentResource

loadSpecificResource

DocumentResource loadSpecificResource(int nDocumentId,
                                      int nAttributeId,
                                      boolean bValidated)

Load a resource (image, file, ...) corresponding to an attribute of a Document

Parameters:

nDocumentId - The Document Id

nAttributeId - The Attribute Id

bValidated - true if we want the validated resource

Returns:

the instance of the DocumentResource

selectAllPrimaryKeys

Collection<Integer> selectAllPrimaryKeys()

Gets all documents id

Returns:

A collection of Integer

selectAll

List<Document> selectAll()

Gets all documents

Returns:

the document list

selectPrimaryKeysByFilter

Collection<Integer> selectPrimaryKeysByFilter(DocumentFilter filter)

Load the list of documents

Parameters:

filter - The DocumentFilter Object

Returns:

The Collection of the Document ids

selectByFilter

List<Document> selectByFilter(DocumentFilter filter)

Load the list of documents

Parameters:

filter - The DocumentFilter Object

Returns:

The Collection of the Documents

selectByRelatedCategories

List<Document> selectByRelatedCategories(Document document)

Load the list of published documents in relation with categories of specified document

Parameters:

document - The document with the categories

Returns:

The Collection of the Documents

store

void store(Document document,
           boolean bUpdateContent)

Update the record in the table

Parameters:

document - The reference of document

bUpdateContent - the boolean

loadAttributes

void loadAttributes(Document document)

Load document attributes

Parameters:

document - the reference of the document

loadAttributesWithoutBinaries

void loadAttributesWithoutBinaries(Document document,
                                   boolean bValidated)

Load document attributes

Parameters:

document - the reference of the document

bValidated - true if the content of the document must be validated, false otherwise

getPageTemplateDocumentPath

String getPageTemplateDocumentPath(int idPageTemplateDocument)

Load document pageTemplatePath

Parameters:

idPageTemplateDocument - the Id page template identifier

Returns:

The page template document path

loadLastModifiedAttributes

Document loadLastModifiedAttributes(int nDocumentId)

Load document type and date last modification for HTTP GET conditional request ("If-Modified-Since")

Parameters:

nDocumentId -

Returns:

the document

validateAttributes

void validateAttributes(int nDocumentId)

Validate the document attributes

Parameters:

nDocumentId - the Id of the document

loadLastModifiedDocumentFromUser

Document loadLastModifiedDocumentFromUser(String strUserName)

Load the data of last Document the user worked in from the table

Parameters:

strUserName - the user name

Returns:

the instance of the Document

loadLastPublishedDocument

Document loadLastPublishedDocument()

Load the data of last Document the user worked in from the table

Returns:

the instance of the Document