org.nuxeo.ecm.webapp.edit.vocabularies
Interface VocabularyActions

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

VocabularyActionsBean

Deprecated. use DirectoryUIActionsBean

@Deprecated
public interface VocabularyActions
extends java.io.Serializable

Interface for an action listener that will provide methods to edit a vocabulary.

Author:

Bogdan Tatar

Method Summary

java.lang.String	addVocabularyEntry() Deprecated. Adds an entry to a vocabulary.
java.lang.String	cancel() Deprecated. Cancels the process of adding or editing a vocabulary entry.
java.lang.String	clearSearchCriteria() Deprecated. Resets the search criteria.
java.lang.String	clearVocabulary() Deprecated. Erases all the entries of a vocabulary.
java.lang.String	deleteVocabularyEntry() Deprecated. Deletes an entry of a vocabulary.
void	destroy() Deprecated.
java.lang.String	editVocabulary() Deprecated. Edits a vocabulary.
java.lang.String	editVocabularyEntry() Deprecated. Edit an entry of a vocabulary.
java.lang.String	getCommandName1() Deprecated. Sets the first button command name from the page used to add/edit a vocabulary entry.
java.lang.String	getCommandName2() Deprecated. Sets the second button command name from the page used to add/edit a vocabulary entry.
boolean	getEditable() Deprecated. Decides if the edit or view action was selected.
java.util.List<javax.faces.model.SelectItem>	getParentIds() Deprecated. This method is used to populated the select for parent ids.
VocabularyEntry	getSearchCriteria() Deprecated. Returns the criteria which is used to perform the search for a vocabulary entries.
VocabularyEntry	getSelectedVocabularyEntry() Deprecated. Returns the selected vocabulary entry chosen for modifying actions.
java.lang.String	getSelectedVocabularyName() Deprecated. Returns the name of vocabulary chosen by the user to modify.
boolean	getShowAddEntryForm() Deprecated. Decides what icon will be rendered for the add entry button.
java.lang.String	getStyle() Deprecated. Returns the style depending on the action that was chosen,view or edit.
java.lang.String	getTitle() Deprecated. Returns the title that will appear above the list with the entries of a vocabulary.
void	initialize() Deprecated. Initializes the vocabulary bean Seam component.
boolean	isHierarchical() Deprecated. Checks if the vocabulary is hierarchical (has parents).
boolean	isNullParentAllowed() Deprecated. Checks if null parents are allowed.
java.lang.String	searchVocabularyEntries() Deprecated. Gets the vocabulary entries searched by the entered criteria.It returns the way to a page, depending on what the search process returns.
void	setCommandName1(java.lang.String commandName) Deprecated. Sets the first command button name.
void	setCommandName2(java.lang.String commandName) Deprecated. Sets the second command button name.
void	setEditable(boolean editable) Deprecated. Sets the boolean which tells if a view or edit action was chosen.
void	setSearchCriteria(VocabularyEntry searchCriteria) Deprecated. Performs the search for a vocabulary entries.
void	setSelectedVocabularyEntry(VocabularyEntry entry) Deprecated. Sets the vocabulary entry the user is going to use for modifying actions.
void	setSelectedVocabularyName(java.lang.String name) Deprecated. Sets the name of vocabulary which the user is going to use for modifying actions.
void	setStyle(java.lang.String style) Deprecated. Sets the style of the page depending on the action that was chosen, view or edit.
void	toggleAddEntryForm(javax.faces.event.ActionEvent event) Deprecated. Used to decide what icon should appear for the add new entry button.
java.lang.String	viewAllVocabularies() Deprecated. Initializes the list with all the available vocabularies.
java.lang.String	viewVocabularyEntry() Deprecated. Views (does not to edit) the entry of a vocabulary.

Method Detail

initialize

void initialize()

Deprecated.

Initializes the vocabulary bean Seam component.

editVocabulary

java.lang.String editVocabulary()
                                throws ClientException

Deprecated.

Edits a vocabulary.

Returns:

the page to which to forward after the edit process.

Throws:

ClientException

clearVocabulary

java.lang.String clearVocabulary()
                                 throws ClientException

Deprecated.

Erases all the entries of a vocabulary.

Returns:

the page to which to forward after the clear process.

Throws:

ClientException

viewAllVocabularies

java.lang.String viewAllVocabularies()
                                     throws ClientException

Deprecated.

Initializes the list with all the available vocabularies.

Returns:

the page to which to forward after.

Throws:

ClientException

addVocabularyEntry

java.lang.String addVocabularyEntry()
                                    throws ClientException

Deprecated.

Adds an entry to a vocabulary.

Returns:

the page to which to forward after.

Throws:

ClientException

editVocabularyEntry

java.lang.String editVocabularyEntry()

Deprecated.

Edit an entry of a vocabulary.

Returns:

the page to which to forward after.

viewVocabularyEntry

java.lang.String viewVocabularyEntry()

Deprecated.

Views (does not to edit) the entry of a vocabulary.

Returns:

the page to which to forward after.

deleteVocabularyEntry

java.lang.String deleteVocabularyEntry()
                                       throws ClientException

Deprecated.

Deletes an entry of a vocabulary.

Returns:

the page to which to forward after.

Throws:

ClientException

setSelectedVocabularyName

void setSelectedVocabularyName(java.lang.String name)

Deprecated.

Sets the name of vocabulary which the user is going to use for modifying actions.

getSelectedVocabularyName

java.lang.String getSelectedVocabularyName()

Deprecated.

Returns the name of vocabulary chosen by the user to modify.

Returns:

- the chosen vocabulary.

setSelectedVocabularyEntry

void setSelectedVocabularyEntry(VocabularyEntry entry)

Deprecated.

Sets the vocabulary entry the user is going to use for modifying actions.

Parameters:

entry - - the entry selected for modifying actions.

getSelectedVocabularyEntry

VocabularyEntry getSelectedVocabularyEntry()

Deprecated.

Returns the selected vocabulary entry chosen for modifying actions.

Returns:

the selected vocabulary entry.

toggleAddEntryForm

void toggleAddEntryForm(javax.faces.event.ActionEvent event)

Deprecated.

Used to decide what icon should appear for the add new entry button.

getShowAddEntryForm

boolean getShowAddEntryForm()

Deprecated.

Decides what icon will be rendered for the add entry button.

Returns:

getEditable

boolean getEditable()

Deprecated.

Decides if the edit or view action was selected.

Returns:

true if the view action was selected - false otherwise

setEditable

void setEditable(boolean editable)

Deprecated.

Sets the boolean which tells if a view or edit action was chosen.

Parameters:

editable -

getCommandName1

java.lang.String getCommandName1()

Deprecated.

Sets the first button command name from the page used to add/edit a vocabulary entry.

Returns:

the name of the command button

setCommandName1

void setCommandName1(java.lang.String commandName)

Deprecated.

Sets the first command button name.

Parameters:

commandName - the name of the command button

getCommandName2

java.lang.String getCommandName2()

Deprecated.

Sets the second button command name from the page used to add/edit a vocabulary entry.

Returns:

the name of the command button

setCommandName2

void setCommandName2(java.lang.String commandName)

Deprecated.

Sets the second command button name.

Parameters:

commandName - the name of the command button

cancel

java.lang.String cancel()

Deprecated.

Cancels the process of adding or editing a vocabulary entry.

Returns:

where to forward to after canceling

setStyle

void setStyle(java.lang.String style)

Deprecated.

Sets the style of the page depending on the action that was chosen, view or edit.

Parameters:

style -

getStyle

java.lang.String getStyle()

Deprecated.

Returns the style depending on the action that was chosen,view or edit.

Returns:

setSearchCriteria

void setSearchCriteria(VocabularyEntry searchCriteria)

Deprecated.

Performs the search for a vocabulary entries.

Parameters:

searchCriteria - - the criteria used to meke the search.

getSearchCriteria

VocabularyEntry getSearchCriteria()

Deprecated.

Returns the criteria which is used to perform the search for a vocabulary entries.

Returns:

- the criteria used to perform the search.

clearSearchCriteria

java.lang.String clearSearchCriteria()
                                     throws ClientException

Deprecated.

Resets the search criteria.

Throws:

ClientException

searchVocabularyEntries

java.lang.String searchVocabularyEntries()
                                         throws ClientException

Deprecated.

Gets the vocabulary entries searched by the entered criteria.It returns the way to a page, depending on what the search process returns.

Returns:

the corresponding map of the page

Throws:

ClientException

getTitle

java.lang.String getTitle()

Deprecated.

Returns the title that will appear above the list with the entries of a vocabulary.

Returns:

the title

getParentIds

java.util.List<javax.faces.model.SelectItem> getParentIds()

Deprecated.

This method is used to populated the select for parent ids.

isHierarchical

boolean isHierarchical()
                       throws DirectoryException

Deprecated.

Checks if the vocabulary is hierarchical (has parents).

Returns:

true if the vocabulary is hierarchical.

Throws:

DirectoryException

isNullParentAllowed

boolean isNullParentAllowed()
                            throws DirectoryException

Deprecated.

Checks if null parents are allowed.

Returns:

true if this is a recursive hierarchical vocabulary.

Throws:

DirectoryException

destroy

@Destroy
void destroy()

Deprecated.