csbase.logic.algorithms.parameters

Interface EnumerationItem

All Superinterfaces:

java.lang.Comparable<EnumerationItem>, java.io.Serializable

All Known Implementing Classes:

AbstractEnumerationItem, DefaultEnumerationItem

public interface EnumerationItem
extends java.lang.Comparable<EnumerationItem>, java.io.Serializable

Item de enumeração

O item de enumeração é o elemento do parâmetro enumeração ( EnumerationParameter). Um item de enumeração possui um identificador, um rótulo e um valor. O identificador é utilizado para criar relacionamentos com outros elementos como gatilhos e enumerações. O identificador também utilizado para verificar a igualdade entre 2 ítens de enumeração, ou seja, se 2 ítens de enumeração possuem o mesmo identificador eles são considerados iguais. O rótulo é texto que é exibido ao usuário. O valor é o texto que é utilizado na linha de comando.

Um item de enumeração pode ser habilitado/desabilitado.

Author:

lmoreira

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommandValue(CommandLineContext context) Obtém o valor que é utilizado no comando.
java.lang.String	getDescription() Obtém a descrição deste item.
java.lang.String	getId() Obtém o identificador deste item.
java.lang.String	getLabel() Obtém o rótulo deste item.
java.lang.String	getValue() Obtém o valor deste item.
boolean	isVisible() Indica se um item de enumeração está visível (true) ou oculto ( false).
boolean	setVisible(boolean isVisible) Exibe/Oculta este item de enumeração.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDescription

java.lang.String getDescription()

Obtém a descrição deste item.

Returns:

A descrição ou null se ela não existir.

getId

java.lang.String getId()

Obtém o identificador deste item.

Returns:

O identificador.

getLabel

java.lang.String getLabel()

Obtém o rótulo deste item.

Returns:

O rótulo.

getCommandValue

java.lang.String getCommandValue(CommandLineContext context)

Obtém o valor que é utilizado no comando.

Parameters:

context - O contexto (Aceita null).

Returns:

O valor.

getValue

java.lang.String getValue()

Obtém o valor deste item.

Returns:

O valor.

isVisible

boolean isVisible()

Indica se um item de enumeração está visível (true) ou oculto ( false).

Returns:

true se estiver visível ou false se estiver oculto.

setVisible

boolean setVisible(boolean isVisible)

Exibe/Oculta este item de enumeração.

Parameters:

isVisible - true para exibir ou false para ocultar.

Returns:

true se mudar o estado ou false caso contrário.