Package org.ametys.plugins.glossary

Interface Definition

All Known Implementing Classes:

DefaultDefinition

public interface Definition

A glossary definition.

Method Summary

Modifier and Type	Method	Description
boolean	displayOnText()	Get the displayOnText.
Set<String>	getAllForms()	Get all forms.
String	getContent()	Get the content.
String[]	getThemes()	Get the themes.
Set<String>	getVariants()	Get the variants.
String	getWord()	Get the word.
void	removeTheme(String themeId)	Remove theme if exist
void	setContent(String content)	Set the content.
void	setDisplayOnText(boolean displayOnText)	Set the displayOnText.
void	setThemes(String[] themes)	Set the themes.
void	setVariants(Collection<String> variants)	Set the variants.
void	setWord(String word)	Set the word.

Method Details

getWord

String getWord()
        throws AmetysRepositoryException

Get the word.

Returns:

the word

Throws:

AmetysRepositoryException - if an error occurs.

setWord

void setWord(String word)
      throws AmetysRepositoryException

Set the word.

Parameters:

word - the word to set

Throws:

AmetysRepositoryException - if an error occurs.

getVariants

Set<String> getVariants()
                 throws AmetysRepositoryException

Get the variants.

Returns:

the variants

Throws:

AmetysRepositoryException - if an error occurs.

setVariants

void setVariants(Collection<String> variants)
          throws AmetysRepositoryException

Set the variants.

Parameters:

variants - the variants to set

Throws:

AmetysRepositoryException - if an error occurs.

getContent

String getContent()
           throws AmetysRepositoryException

Get the content.

Returns:

_the content

Throws:

AmetysRepositoryException - if an error occurs.

setContent

void setContent(String content)
         throws AmetysRepositoryException

Set the content.

Parameters:

content - the content to set

Throws:

AmetysRepositoryException - if an error occurs.

displayOnText

boolean displayOnText()
               throws AmetysRepositoryException

Get the displayOnText.

Returns:

_the displayOnText

Throws:

AmetysRepositoryException - if an error occurs.

setDisplayOnText

void setDisplayOnText(boolean displayOnText)
               throws AmetysRepositoryException

Set the displayOnText.

Parameters:

displayOnText - the displayOnText to set

Throws:

AmetysRepositoryException - if an error occurs.

getThemes

String[] getThemes()
            throws AmetysRepositoryException

Get the themes.

Returns:

the themes in an Array

Throws:

AmetysRepositoryException - if an error occurs.

setThemes

void setThemes(String[] themes)
        throws AmetysRepositoryException

Set the themes.

Parameters:

themes - the themes to set.

Throws:

AmetysRepositoryException - if an error occurs.

removeTheme

void removeTheme(String themeId)
          throws AmetysRepositoryException

Remove theme if exist

Parameters:

themeId - The id of theme to remove

Throws:

AmetysRepositoryException - if an error occurs

getAllForms

Set<String> getAllForms()
                 throws AmetysRepositoryException

Get all forms.

Returns:

a list of all the word forms (word + variants).

Throws:

AmetysRepositoryException - if an error occurs.