org.nuiton.wikitty
Interface WikittyStorage

All Known Implementing Classes:

WikittyServiceInMemory.WikittyStorageInMemory

public interface WikittyStorage

WikittyStorage is used to abstract data and extension storage in WikittyService.

Version:

$Revision: 417 $ Last update: $Date: 2010-10-15 17:24:44 +0200 (ven., 15 oct. 2010) $ by : $Author: sletellier $

Author:

poussin

Nested Class Summary

static interface

WikittyStorage.Scanner Call each time wikitty is scan.

Method Summary

void	clear(WikittyTransaction transaction) Remove all wikitty.
UpdateResponse	delete(WikittyTransaction transaction, java.util.Collection<java.lang.String> idList) Delete all object with id argument.
boolean	exists(WikittyTransaction transaction, java.lang.String id) Return true if id exists in storage.
boolean	isDeleted(WikittyTransaction transaction, java.lang.String id) Return true if wikitty object with this id are marked deleted.
Wikitty	restore(WikittyTransaction transaction, java.lang.String id, java.lang.String... fqFieldName) Restore list of wikitty object.
void	scanWikitties(WikittyTransaction transaction, WikittyStorage.Scanner scanner) Scan all wikitties with specific scanner, even if the wikitty is deleted.
UpdateResponse	store(WikittyTransaction transaction, java.util.Collection<Wikitty> wikitties, boolean force) Store wikitty in storage.

Method Detail

store

UpdateResponse store(WikittyTransaction transaction,
                     java.util.Collection<Wikitty> wikitties,
                     boolean force)

Store wikitty in storage.

Parameters:

transaction - transaction

wikitties - wikitty collection

force - boolean force non version version increment on saved wikitty or force version on wikitty creation (version 0.0)

Returns:

information usefull for client side update data

exists

boolean exists(WikittyTransaction transaction,
               java.lang.String id)

Return true if id exists in storage.

Parameters:

transaction - transaction

id - id to check

Returns:

true if wikitty id exists

isDeleted

boolean isDeleted(WikittyTransaction transaction,
                  java.lang.String id)

Return true if wikitty object with this id are marked deleted.

Parameters:

transaction - transaction

id - id to check

Returns:

true if wikitty id is deleted

restore

Wikitty restore(WikittyTransaction transaction,
                java.lang.String id,
                java.lang.String... fqFieldName)
                throws WikittyException

Restore list of wikitty object.

Parameters:

transaction - transaction

id - list of wikitty id

fqFieldName - list of field that must be loaded, other fields can be not loaded

Returns:

found wikitty

Throws:

WikittyException - if wikitty not found

delete

UpdateResponse delete(WikittyTransaction transaction,
                      java.util.Collection<java.lang.String> idList)
                      throws WikittyException

Delete all object with id argument.

Parameters:

transaction - transaction

idList -

Returns:

delete response

Throws:

WikittyException - If id is not valid or don't exist.

scanWikitties

void scanWikitties(WikittyTransaction transaction,
                   WikittyStorage.Scanner scanner)

Scan all wikitties with specific scanner, even if the wikitty is deleted.

Parameters:

transaction - transaction

scanner - scanner

clear

void clear(WikittyTransaction transaction)

Remove all wikitty.

Parameters:

transaction - transaction