fr.cnes.sitools.common.store
Interface SitoolsStore<T extends IResource>

Type Parameters:

T - Class derived from IResource to allow basic fields for serialization

All Superinterfaces:

java.io.Closeable

All Known Implementing Classes:

AppRegistryStoreXML, CollectionsStoreXML, ConceptTemplateStoreXML, ConverterStoreXML, DataSetStoreXML, DatasetViewStoreXML, DictionaryStoreXML, DimensionStoreXML, FeedsStoreXML, FilterPluginStoreXML, FilterStoreXML, FormComponentsStoreXML, FormProjectStoreXML, FormStoreXML, GraphStoreXML, GuiServicePluginStoreXML, GuiServiceStoreXML, InscriptionStoreXML, JDBCDataSourceStoreXML, MongoDBDataSourceStoreXML, OpenSearchStoreXML, OrderStoreXML, ProjectModuleStoreXML, ProjectStoreXML, ResourcePluginStoreXML, RoleStoreXML, ServiceStoreXML, SitoolsStoreXML, SitoolsSynchronizedStoreXML, TaskStoreXML, UserBlackListStoreXML

public interface SitoolsStore<T extends IResource>
extends java.io.Closeable

Base class for Store interfaces

Author:

m.marseille (AKKA technologies)

Method Summary

T	create(T resource) Method for creating a object
boolean	delete(java.lang.String id) Method for deleting a object by its id
T[]	getArray() Method for getting all objects
T[]	getArray(ResourceCollectionFilter filter) Method for getting objects according to the specified filter
T[]	getArrayByXQuery(java.lang.String xquery) Method for getting objects according to the XQuery
java.util.List<T>	getList() Method for getting all objects
java.util.List<T>	getList(ResourceCollectionFilter filter) Method for getting objects with specific criteria
java.util.List<T>	getListByXQuery(java.lang.String xquery) Method for getting objects with XQuery request syntax
java.util.List<T>	getPage(ResourceCollectionFilter filter, java.util.List<T> resources) Method for getting objects according to the pagination criteria
T	retrieve(java.lang.String id) Method for retrieving a object by its id
java.util.List<T>	retrieveByParent(java.lang.String id) Get the list of object by parent ID
T	update(T resource) Method for updating a object

Methods inherited from interface java.io.Closeable

close

Method Detail

getArray

T[] getArray()

Method for getting all objects

Returns:

Array

getArrayByXQuery

T[] getArrayByXQuery(java.lang.String xquery)

Method for getting objects according to the XQuery

Parameters:

xquery - String with XQuery syntax

Returns:

Array

getArray

T[] getArray(ResourceCollectionFilter filter)

Method for getting objects according to the specified filter

Parameters:

filter - criteria (pagination, ...)

Returns:

Array

getList

java.util.List<T> getList()

Method for getting all objects

Returns:

ArrayList of objects

getList

java.util.List<T> getList(ResourceCollectionFilter filter)

Method for getting objects with specific criteria

Parameters:

filter - criteria (pagination, ...)

Returns:

ArrayList of objects

getPage

java.util.List<T> getPage(ResourceCollectionFilter filter,
                          java.util.List<T> resources)

Method for getting objects according to the pagination criteria

Parameters:

filter - pagination

resources - input

Returns:

ArrayList of objects

getListByXQuery

java.util.List<T> getListByXQuery(java.lang.String xquery)

Method for getting objects with XQuery request syntax

Parameters:

xquery - String

Returns:

ArrayList of objects

create

T create(T resource)

Method for creating a object

Parameters:

resource - input

Returns:

created object

retrieve

T retrieve(java.lang.String id)

Method for retrieving a object by its id

Parameters:

id - project identifier

Returns:

retrieved object

update

T update(T resource)

Method for updating a object

Parameters:

resource - input

Returns:

updated object

delete

boolean delete(java.lang.String id)

Method for deleting a object by its id

Parameters:

id - object identifier

Returns:

true if deleted

retrieveByParent

java.util.List<T> retrieveByParent(java.lang.String id)

Get the list of object by parent ID

Parameters:

id - the parent ID

Returns:

the list of resource objects