com.foreach.common.spring.localization.text

Interface LocalizedTextDataStore

public interface LocalizedTextDataStore

An interface to communicate between a LocalizedTextService and a backing datastore containing the items. A bean implementing this interface should be passed to the AbstractLocalizedTextService implementation.

Method Summary

Modifier and Type	Method and Description
void	deleteLocalizedText(LocalizedText text) Deletes an item in the datastore.
void	flagAsUsed(LocalizedText text) Flags an item as used in the datastore.
List<String>	getApplications()
List<String>	getGroups(String application)
LocalizedText	getLocalizedText(String application, String group, String label) Gets an item with a specified label from a particular group.
List<LocalizedText>	getLocalizedTextForGroup(String application, String group) Gets a list of all LocalizedText items for a given group.
void	insertLocalizedText(LocalizedText text) Inserts a new item in the datastore.
List<LocalizedText>	searchLocalizedText(String textToSearch) This will do a search over all items in the datastore, looking for the text specified.
void	updateLocalizedText(LocalizedText text) Updates an existing item in the datastore.

Method Detail

getLocalizedTextForGroup

List<LocalizedText> getLocalizedTextForGroup(String application,
                                             String group)

Gets a list of all LocalizedText items for a given group.

Parameters:

application - Application to get the group of items from.

group - Name of the group.

Returns:

List of items.

getLocalizedText

LocalizedText getLocalizedText(String application,
                               String group,
                               String label)

Gets an item with a specified label from a particular group.

Parameters:

application - Application the item belongs to.

group - Name of the group the item belongs to.

label - Label of the item, unique within the group.

Returns:

Item or null if not found.

insertLocalizedText

void insertLocalizedText(LocalizedText text)

Inserts a new item in the datastore.

Parameters:

text - LocalizedText item.

updateLocalizedText

void updateLocalizedText(LocalizedText text)

Updates an existing item in the datastore.

Parameters:

text - LocalizedText item.

deleteLocalizedText

void deleteLocalizedText(LocalizedText text)

Deletes an item in the datastore.

Parameters:

text - LocalizedText item.

getApplications

List<String> getApplications()

Returns:

All applications in the datastore.

getGroups

List<String> getGroups(String application)

Parameters:

application - Name of an application in the datastore.

Returns:

List of groups for this application.

flagAsUsed

void flagAsUsed(LocalizedText text)

Flags an item as used in the datastore.

Parameters:

text - LocalizedText item to be flagged.

searchLocalizedText

List<LocalizedText> searchLocalizedText(String textToSearch)

This will do a search over all items in the datastore, looking for the text specified.

Parameters:

textToSearch - Text to search for.

Returns:

All items that have a match on the text.