com.jurismarches.vradi.services
Interface VradiDataService

All Known Implementing Classes:

VradiDataServiceImpl

public interface VradiDataService

This service contains business code to do on data before calling WikittyProxy. It's intended to be used on a local WikittyProxy.

Version:

$Revision: 1308 $ Last update : $Date: 2010-09-09 17:35:18 +0200 (jeu., 09 sept. 2010) $ By : $Author: chatellier $

Author:

chatellier

Method Summary

java.util.List<Status>	createDefaultStatuses() Create all default status.
java.util.List<Client>	findAllClients() Find all clients ordered by client name.
java.util.List<Group>	findAllGroups() Find all groups ordered by group name.
java.util.List<Thesaurus>	findAllThesaurus() Find all thesaurus orderer by thesaurus name.
java.util.List<User>	findAllUsers() Find all users ordered by user name.
java.util.List<WebHarvestStream>	findAllWebHarvest() Find all webHarvest stream ordered by stream name.
java.util.List<XmlStream>	findAllXmlStreams() Find all xml streams ordered by stream name.
java.util.List<User>	findClientUsers(java.lang.String clientId) Find all users for a client ordered by user name.
FormPagedResult	findForms(java.lang.String query, org.nuiton.wikitty.WikittyExtension extension, java.lang.String dateType, java.util.Date beginDate, java.util.Date endDate, java.lang.String streamId, java.util.List<java.lang.String> thesaurus, java.lang.String[] statusIds, FormPagedResult formPagedResult) Searches for forms with the specified filters.
java.util.List<org.nuiton.wikitty.WikittyExtension>	getAllFormTypes() Retrieves all the form types
java.util.List<Thesaurus>	getChildrenThesaurus(java.lang.String thesaurusId) Returns all children of the specified thesaurusId.
org.nuiton.wikitty.WikittyExtension	getFormType(java.lang.String name) Retrieves the form type whose name is the parameter 'name'
int	getNbFormsForThesaurus(java.lang.String thesaurusId) Computes the number of forms associated with the specified thesaurusId.
java.util.List<RootThesaurus>	getRootThesaurus() Return root thesaurus nodes.
ThesaurusCartography	getThesaurusCartography(java.lang.String query, org.nuiton.wikitty.WikittyExtension extension, java.lang.String dateType, java.util.Date beginDate, java.util.Date endDate, java.lang.String streamId, java.util.List<java.lang.String> thesaurus, java.lang.String[] statusIds) Computes the number of forms associated with every thesaurus node.
org.nuiton.wikitty.WikittyExtension	updateFormType(java.lang.String name, java.util.Map<java.lang.String,org.nuiton.wikitty.FieldType> fields, java.lang.String requires, java.util.Map<java.lang.String,java.lang.String> tagValues) Creates or Update a form type.
org.nuiton.wikitty.WikittyExtension	updateFormType(org.nuiton.wikitty.WikittyExtension extension) Creates or Update a form type.
java.util.List<XmlFieldBinding>	updateXmlFieldBindings(java.util.List<XmlFieldBinding> bindings) Update a list of XmlFieldBinding.

Method Detail

findAllClients

java.util.List<Client> findAllClients()

Find all clients ordered by client name.

Returns:

all clients

findAllUsers

java.util.List<User> findAllUsers()

Find all users ordered by user name.

Returns:

all users

findClientUsers

java.util.List<User> findClientUsers(java.lang.String clientId)

Find all users for a client ordered by user name.

Parameters:

clientId - client wikitty id

Returns:

all users for client

findAllThesaurus

java.util.List<Thesaurus> findAllThesaurus()

Find all thesaurus orderer by thesaurus name. TODO EC20100610 maybe nerver used ?

Returns:

all thesaurus

findAllGroups

java.util.List<Group> findAllGroups()

Find all groups ordered by group name.

Returns:

all groups

createDefaultStatuses

java.util.List<Status> createDefaultStatuses()
                                             throws VradiException

Create all default status.

Returns:

all status

Throws:

VradiException

findAllWebHarvest

java.util.List<WebHarvestStream> findAllWebHarvest()

Find all webHarvest stream ordered by stream name.

Returns:

all stream webHarvest

findAllXmlStreams

java.util.List<XmlStream> findAllXmlStreams()

Find all xml streams ordered by stream name.

Returns:

all xml streams

getRootThesaurus

java.util.List<RootThesaurus> getRootThesaurus()
                                               throws VradiException

Return root thesaurus nodes. Since 0.1.0, root thesaurus are not created anymore.

Returns:

a RootThesaurus

Throws:

VradiException

getFormType

org.nuiton.wikitty.WikittyExtension getFormType(java.lang.String name)
                                                throws VradiException

Retrieves the form type whose name is the parameter 'name'

Parameters:

name - the name of the form type we want to retrieve

Returns:

the form type whose name is the parameter

Throws:

VradiException

updateFormType

org.nuiton.wikitty.WikittyExtension updateFormType(org.nuiton.wikitty.WikittyExtension extension)
                                                   throws VradiException

Creates or Update a form type.

Parameters:

extension - the extension designing the form type

Returns:

a WikittyExtension

Throws:

VradiException

updateFormType

org.nuiton.wikitty.WikittyExtension updateFormType(java.lang.String name,
                                                   java.util.Map<java.lang.String,org.nuiton.wikitty.FieldType> fields,
                                                   java.lang.String requires,
                                                   java.util.Map<java.lang.String,java.lang.String> tagValues)
                                                   throws VradiException

Creates or Update a form type.

Parameters:

name - the name of the form type

fields - the fields of the form type

requires - the extension required by the extension to update

tagValues - the map containing the tags and their values

Returns:

a WikittyExtension

Throws:

VradiException

findForms

FormPagedResult findForms(java.lang.String query,
                          org.nuiton.wikitty.WikittyExtension extension,
                          java.lang.String dateType,
                          java.util.Date beginDate,
                          java.util.Date endDate,
                          java.lang.String streamId,
                          java.util.List<java.lang.String> thesaurus,
                          java.lang.String[] statusIds,
                          FormPagedResult formPagedResult)
                          throws VradiException,
                                 UnsupportedQueryException

Searches for forms with the specified filters. The beginDate and endDate specifies a date range filter which is applied on dateType field. The date range filter is applied only if the three parameters are not null.

Parameters:

query - the query filter

extension - the extension filter

dateType - the date field. Must be fully qualified (extension.field)

beginDate - the begin date filter

endDate - the end date filter

streamId - id of stream

thesaurus - the thesaurus filter

statusIds - the ids of the status filters

formPagedResult - ...

Returns:

FormPagedResult

Throws:

UnsupportedQueryException

VradiException

getThesaurusCartography

ThesaurusCartography getThesaurusCartography(java.lang.String query,
                                             org.nuiton.wikitty.WikittyExtension extension,
                                             java.lang.String dateType,
                                             java.util.Date beginDate,
                                             java.util.Date endDate,
                                             java.lang.String streamId,
                                             java.util.List<java.lang.String> thesaurus,
                                             java.lang.String[] statusIds)
                                             throws VradiException,
                                                    UnsupportedQueryException

Computes the number of forms associated with every thesaurus node.

Parameters:

query - the query filter

extension - the extension filter

dateType - the date field. Must be fully qualified (extension.field)

beginDate - the begin date filter

endDate - the end date filter

streamId - id of stream

thesaurus - the thesaurus filter

statusIds - the ids of the status filters

Returns:

a VradiCartographyDTO containing forms result and a map of form count indexed by thesaurus nodes

Throws:

VradiException

UnsupportedQueryException

updateXmlFieldBindings

java.util.List<XmlFieldBinding> updateXmlFieldBindings(java.util.List<XmlFieldBinding> bindings)
                                                       throws VradiException

Update a list of XmlFieldBinding.

Parameters:

bindings - the list of XmlFieldBinding to update

Returns:

the list of updated XmlFieldBinding

Throws:

VradiException

getAllFormTypes

java.util.List<org.nuiton.wikitty.WikittyExtension> getAllFormTypes()
                                                                    throws VradiException

Retrieves all the form types

Returns:

a list containing all the form types

Throws:

VradiException

getChildrenThesaurus

java.util.List<Thesaurus> getChildrenThesaurus(java.lang.String thesaurusId)
                                               throws VradiException

Returns all children of the specified thesaurusId.

Parameters:

thesaurusId -

Returns:

all list of TreeNodeImpl

Throws:

VradiException

getNbFormsForThesaurus

int getNbFormsForThesaurus(java.lang.String thesaurusId)
                           throws VradiException

Computes the number of forms associated with the specified thesaurusId.

Parameters:

thesaurusId - thesaurus id

Returns:

the number of forms associated

Throws:

VradiException