org.nuiton.wikitty.storage

Interface WikittyExtensionStorage

All Known Implementing Classes:

WikittyExtensionStorageInMemory

public interface WikittyExtensionStorage

Version:

$Revision: 1136 $ Last update: $Date: 2011-08-12 16:24:03 +0200 (Fri, 12 Aug 2011) $ by : $Author: tchemit $

Author:

poussin

Method Summary

Methods

Modifier and Type	Method and Description
WikittyEvent	clear(WikittyTransaction transaction) Remove all extensions.
WikittyEvent	delete(WikittyTransaction transaction, Collection<String> extNames) delete extensions
boolean	exists(WikittyTransaction transaction, String id) Return true if id exists in storage.
List<String>	getAllExtensionIds(WikittyTransaction transaction) Return all extension ids.
List<String>	getAllExtensionsRequires(WikittyTransaction transaction, String extensionName) Return all extension ids where the specified extensionName is required.
String	getLastVersion(WikittyTransaction transaction, String extName) return last version available for specified extension name.
WikittyExtension	restore(WikittyTransaction transaction, String name, String version) Restore one extension from storage, if not found an exception is thrown.
WikittyEvent	store(WikittyTransaction transaction, Collection<WikittyExtension> extensions) Store extension in storage.

Method Detail

store

WikittyEvent store(WikittyTransaction transaction,
                 Collection<WikittyExtension> extensions)

Store extension in storage.

Parameters:

transaction - the current transaction

extensions - the extensions to store

Returns:

information usefull for client side update data

delete

WikittyEvent delete(WikittyTransaction transaction,
                  Collection<String> extNames)

delete extensions

Parameters:

transaction - transaction

extNames - extension name (extName)

exists

boolean exists(WikittyTransaction transaction,
             String id)

Return true if id exists in storage.

Parameters:

transaction - the current transaction

id - an extension id

Returns:

true if the extension exists

getAllExtensionIds

List<String> getAllExtensionIds(WikittyTransaction transaction)

Return all extension ids.

Parameters:

transaction - the current transaction

Returns:

a list of extension ids

getAllExtensionsRequires

List<String> getAllExtensionsRequires(WikittyTransaction transaction,
                                    String extensionName)

Return all extension ids where the specified extensionName is required.

Parameters:

transaction - the current transaction

extensionName - the extension required

Returns:

a list of extension ids

getLastVersion

String getLastVersion(WikittyTransaction transaction,
                    String extName)

return last version available for specified extension name.

Parameters:

transaction - the current transaction

extName - name of extension

Returns:

last version availble for this version, or null if extension doesn't exist

restore

WikittyExtension restore(WikittyTransaction transaction,
                       String name,
                       String version)
                         throws WikittyException

Restore one extension from storage, if not found an exception is thrown.

Parameters:

transaction - the current transaction

name - extension name to restore

version - extension version to restore

Returns:

an extension

Throws:

WikittyException - if exception during restore

clear

WikittyEvent clear(WikittyTransaction transaction)

Remove all extensions.

Parameters:

transaction - transaction