com.hlcl.rql.as
Class OptionList

java.lang.Object
  com.hlcl.rql.as.Element
      com.hlcl.rql.as.OptionList

All Implemented Interfaces:

CmsClientContainer, PageContainer, ProjectContainer

public class OptionList
extends Element

Diese Klasse beschreibt das Seitenelement Optionsliste.

Author:

lejafr

Constructor Summary

OptionList(Page page, TemplateElement templateElement, java.lang.String name, java.lang.String elementGuid, java.lang.String value, java.lang.String defaultSelectionGuid)
OptionList constructor comment.

Method Summary

int	checkValues(java.util.List<java.lang.String> expectedPossibleValues) Prüft die möglichen Werte an dieser Optionsliste.
boolean	containsValue(java.lang.String value) Liefert true, falls der gegebene Wert ein möglicher in dieser OptionsListe ist, checked with equals().
OptionListSelection	getCurrentSelection() Liefert die aktuell gewählte Selection zurueck oder null, falls diese Optionsliste keine Selektion hat und auch im TemplateElement kein default definiert ist.
java.util.List<java.lang.String>	getSelectionDescriptions() Liefert alle an dieser Optionsliste möglichen Anzeigewerte aus den selection objects.
int	getSelectionsSize() Liefert die Anzahl der möglicher Auswahlen.
java.util.List<java.lang.String>	getSelectionValues() Liefert alle an dieser Optionsliste möglichen Werte aus den selection objects.
java.util.List<java.lang.String>	getSelectionValuesSorted() Liefert alle an dieser Optionsliste möglichen Werte aus den selection objects sortiert zurück.
void	select(java.lang.String selectionValue) Aendert den Wert der OptionList auf die Selection GUID des Selection-Objektes mit dem Wert selectionValue.
void	selectDefault() Aendert den Wert der Optionsliste auf den default Wert.

Methods inherited from class com.hlcl.rql.as.Element

callCms, callCmsWithoutParsing, deleteValue, getCmsClient, getElementGuid, getLogonGuid, getName, getPage, getPageGuid, getProject, getProjectGuid, getSessionKey, getTemplateElement, hasTemplateDefaultValue, isCombinedUpdateSupported, isEmpty, isValueEntered

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OptionList

public OptionList(Page page,
                  TemplateElement templateElement,
                  java.lang.String name,
                  java.lang.String elementGuid,
                  java.lang.String value,
                  java.lang.String defaultSelectionGuid)

OptionList constructor comment.

Parameters:

page - Seite, die diesen Container Link beinhaltet.

templateElement - TemplateElement auf dem dieses Element basiert

name - Name des Elements

elementGuid - GUID dieses Elements

value - GUID eines möglichen OptionListEntry

defaultSelectionGuid - GUID des default OptionListEntry

Method Detail

checkValues

public int checkValues(java.util.List<java.lang.String> expectedPossibleValues)
                throws RQLException

Prüft die möglichen Werte an dieser Optionsliste.

Returns:

-1, if size of possible selections and given values doesn't match

0, if all given values are exactly the possible values of this option list (values checked with equals)

1, if size matches, but values didn't

Throws:

RQLException

getCurrentSelection

public OptionListSelection getCurrentSelection()
                                        throws RQLException

Liefert die aktuell gewählte Selection zurueck oder null, falls diese Optionsliste keine Selektion hat und auch im TemplateElement kein default definiert ist.

Throws:

RQLException

containsValue

public boolean containsValue(java.lang.String value)

Liefert true, falls der gegebene Wert ein möglicher in dieser OptionsListe ist, checked with equals().

See Also:

Map.containsKey(Object)

getSelectionDescriptions

public java.util.List<java.lang.String> getSelectionDescriptions()

Liefert alle an dieser Optionsliste möglichen Anzeigewerte aus den selection objects.

getSelectionsSize

public int getSelectionsSize()

Liefert die Anzahl der möglicher Auswahlen.

getSelectionValues

public java.util.List<java.lang.String> getSelectionValues()

Liefert alle an dieser Optionsliste möglichen Werte aus den selection objects.

getSelectionValuesSorted

public java.util.List<java.lang.String> getSelectionValuesSorted()

Liefert alle an dieser Optionsliste möglichen Werte aus den selection objects sortiert zurück.

select

public void select(java.lang.String selectionValue)
            throws RQLException

Aendert den Wert der OptionList auf die Selection GUID des Selection-Objektes mit dem Wert selectionValue.

Der value wird in den HTML Source eingesetzt.

Parameters:

selectionValue - Wert der OptionListSelection auf den die OptionsListe geaendert werden soll (weder die GUID noch der dem Autor angezeigt Wert).

Throws:

RQLException

selectDefault

public void selectDefault()
                   throws RQLException

Aendert den Wert der Optionsliste auf den default Wert.

Throws:

RQLException