ecar.pojo
Interface ObjetoEstrutura

All Known Implementing Classes:

EstrutTpFuncAcmpEtttfa, EstruturaAtributoEttat

public interface ObjetoEstrutura

Author:

garten

Field Summary

static int	DEFAULT_LARGURA_TELA_CAMPO Define a largura em porcentagem de uma coluna em telas de listagem.
static int	DEFAULT_TAMANHO_CAMPO_TEXT Define o tamanho default de um campo input, quando o usu�rio n�o define o tamanho.
static int	MAX_SEQUENCIA_COLUNA_LISTAGEM Define um valor limite para a sequencia de colunas em listagens de itens.
static int	MAX_SEQUENCIA_TELA_CAMPO Define um valor limite para a sequencia de um campo na tela de dados gerais.

Method Summary

java.lang.Boolean	iGetBloqueado() Retorna verdadeiro ou falso dependendo da configura��o do atributo poder ser alterado, mesmo o cadastro estando bloqueado.
java.lang.String	iGetCodFk() Devolve o nome do codigo da fk descrito no atributo_atb. por exemplo codAre
java.lang.String	iGetDica() Devolve a dica do campo a ser utilizado em telas de cadastro e relat�rios
SisGrupoAtributoSga	iGetGrupoAtributosLivres() Devolve o grupo de atributos livres de um atributo
java.lang.Boolean	iGetIndOpcional()
java.lang.String	iGetLabel() Devolve o label a ser utilizado em telas de cadastro e relat�rios.
java.lang.Integer	iGetLargura() Devolve a largura de uma coluna em porcentagem nas telas de listagens de item em colunas.
java.util.Set<TipoFuncAcompTpfa>	iGetLibTipoFuncAcompTpfas()
java.lang.String	iGetNome() Devolve o nome do atributo da estrutura.
java.lang.String	iGetNomeFk() Devolve o nome do nome da fk descrito no atributo_atb. por exemplo nomeAre
java.lang.String	iGetNomeOrdenarLista() Devolve o nome do atributo que ser� utilizado para ordenar uma lista de itemEstruturaIett.
java.lang.Boolean	iGetObrigatorio() Retorna verdadeiro ou falso dependendo da obrigatoriedade do objeto
java.lang.Integer	iGetSequenciaCampoEmTela() Devolve o numero que corresponde � sequencia dos campos em uma tela de cadastro.
java.lang.Integer	iGetSequenciaColunaEmListagem() Devolve o numero que corresponde � sequencia das colunas em telas de listagem.
java.lang.Integer	iGetTamanhoConteudoAtrib() Devolve o tamanho do conte�do de um atributo.
java.lang.Class<?>	iGetTipo() Retorna o tipo da classe que est� encapsulada no ObjetoEstrutura.
java.lang.String	iGetValor(ItemEstruturaIett item) Obtem o valor cadastrado na tabela de itemEstruturaIett de um determinado campo.
java.lang.String	iGetValor(ItemEstruturarevisaoIettrev itemRev) Obtem o valor cadastrado na tabela de itemEstruturaIett de um determinado campo.
java.lang.String	iGetValorCodFk(ItemEstruturaIett item) Obtem o valor do codigo de um campo caso ele seja uma FK dentro da tabela de ItemEstruturaIett.
java.lang.String	iGetValorCodFk(ItemEstruturarevisaoIettrev itemRev) Obtem o valor do codigo de um campo caso ele seja uma FK dentro da tabela de ItemEstruturaIett.

Field Detail

MAX_SEQUENCIA_TELA_CAMPO

static final int MAX_SEQUENCIA_TELA_CAMPO

Define um valor limite para a sequencia de um campo na tela de dados gerais. Quando o usuario esquece de informar a sequencia do campo no cadastro de estrutura_atributo, o campo toma este valor como default, ou seja, ficar� por ultimo na tela.

See Also:

Constant Field Values

MAX_SEQUENCIA_COLUNA_LISTAGEM

static final int MAX_SEQUENCIA_COLUNA_LISTAGEM

Define um valor limite para a sequencia de colunas em listagens de itens. Quando o usuario esquece de informar a sequencia da coluna no cadastro de estrutura_atributo, a coluna toma este valor como default, ou seja, ficar� por ultimo na lista.

See Also:

Constant Field Values

DEFAULT_LARGURA_TELA_CAMPO

static final int DEFAULT_LARGURA_TELA_CAMPO

Define a largura em porcentagem de uma coluna em telas de listagem. Quando usuario esquece de definir a largura de uma coluna em telas de listagem assume esse valor como default.

See Also:

Constant Field Values

DEFAULT_TAMANHO_CAMPO_TEXT

static final int DEFAULT_TAMANHO_CAMPO_TEXT

Define o tamanho default de um campo input, quando o usu�rio n�o define o tamanho. Este tamanho tamb�m � levado em conta na hora do sistema exibir uma text ou textArea. Quando o usu�rio define um tamanho maior que 80, ser� exibido um textArea. Caso o valor seja menor que 80, ser� exibido um text.

See Also:

Constant Field Values

Method Detail

iGetNome

java.lang.String iGetNome()

Devolve o nome do atributo da estrutura. Este � o nome que est� mapeado como um campo na tabela TB_Item_Estrutura_Iett. O nome est� na sintaxe de atributo de objeto, ex: nomeIett

Returns:

nome do campo na tabela ItemEstruturaIett

iGetCodFk

java.lang.String iGetCodFk()

Devolve o nome do codigo da fk descrito no atributo_atb. por exemplo codAre

Returns:

iGetNomeFk

java.lang.String iGetNomeFk()

Devolve o nome do nome da fk descrito no atributo_atb. por exemplo nomeAre

Returns:

iGetNomeOrdenarLista

java.lang.String iGetNomeOrdenarLista()

Devolve o nome do atributo que ser� utilizado para ordenar uma lista de itemEstruturaIett. Ser� utilizado na clausula order by do HQL que lista os itens na relacao de acesso � estrutura. Precisa ser um campo que est� mapeado na tabela ItemEstruturaIett. Se for um objeto complexo, resolve o campo desse objeto. ex: "codOrg.descricaoOrg" Ex. retorna "codOrg.descricaoOrg" ou "nomeIett", etc

Returns:

nome do campo que ser� utilizado para ordenar os itens.

iGetLabel

java.lang.String iGetLabel()

Devolve o label a ser utilizado em telas de cadastro e relat�rios. Geralmente � o labelEstruturaEttat ou labelPadraoAtb ou labelTpfa

Returns:

nome do label que ser� mostrado ao usu�rio

iGetValor

java.lang.String iGetValor(ItemEstruturaIett item)
                           throws ECARException

Obtem o valor cadastrado na tabela de itemEstruturaIett de um determinado campo. Utiliza o item e o nome no atributo para determinar seu valor. Por exemplo, devolve o valor do campo nome_iett realizando um getNomeIett() ou getOrgaoOrg().getDescricaoOrg() conforme estiver cadastrado em tb_atributos_atb no campo nome_fk_atb

Parameters:

item -

Returns:

string contendo o valor do campo na tabela ItemEstruturaIett

Throws:

ECARException

iGetValorCodFk

java.lang.String iGetValorCodFk(ItemEstruturaIett item)
                                throws ECARException

Obtem o valor do codigo de um campo caso ele seja uma FK dentro da tabela de ItemEstruturaIett. Por exemplo, para AreaAre, vai voltar o valor do codigo da Area (codAre). Para um objeto que n�o seja FK, n�o se aplica, vai retornar o mesmo valor que iGetValor

Parameters:

item -

Returns:

string contendo o codigo do campo na tabela ItemEstruturaIett

Throws:

ECARException

iGetLargura

java.lang.Integer iGetLargura()

Devolve a largura de uma coluna em porcentagem nas telas de listagens de item em colunas. Se nao estiver especificado um valor, deve retornar DEFAULT_LARGURA_TELA_CAMPO

Returns:

valor correspondendo a largura de uma coluna

iGetSequenciaColunaEmListagem

java.lang.Integer iGetSequenciaColunaEmListagem()

Devolve o numero que corresponde � sequencia das colunas em telas de listagem.

Returns:

o numero de sequencia entre 0..1000

iGetSequenciaCampoEmTela

java.lang.Integer iGetSequenciaCampoEmTela()

Devolve o numero que corresponde � sequencia dos campos em uma tela de cadastro.

Returns:

numero da sequencia entre 0..1000

iGetTipo

java.lang.Class<?> iGetTipo()

Retorna o tipo da classe que est� encapsulada no ObjetoEstrutura. Geralmente deve retornar ecar.pojo.EstruturaAtributoEttAt ou ecar.pojo.EstrutTpFuncAcmpEtttfa

Returns:

o tipo da classe

iGetObrigatorio

java.lang.Boolean iGetObrigatorio()

Retorna verdadeiro ou falso dependendo da obrigatoriedade do objeto

Returns:

Boolean(true) ou Boolean(false)

iGetBloqueado

java.lang.Boolean iGetBloqueado()

Retorna verdadeiro ou falso dependendo da configura��o do atributo poder ser alterado, mesmo o cadastro estando bloqueado.

Returns:

Boolean(true) ou Boolean(false)

iGetValor

java.lang.String iGetValor(ItemEstruturarevisaoIettrev itemRev)
                           throws ECARException

Obtem o valor cadastrado na tabela de itemEstruturaIett de um determinado campo. Utiliza o item e o nome no atributo para determinar seu valor. Por exemplo, devolve o valor do campo nome_iett realizando um getNomeIett() ou getOrgaoOrg().getDescricaoOrg() conforme estiver cadastrado em tb_atributos_atb no campo nome_fk_atb

Parameters:

item -

Returns:

string contendo o valor do campo na tabela ItemEstruturaIett

Throws:

ECARException

iGetValorCodFk

java.lang.String iGetValorCodFk(ItemEstruturarevisaoIettrev itemRev)
                                throws ECARException

Obtem o valor do codigo de um campo caso ele seja uma FK dentro da tabela de ItemEstruturaIett. Por exemplo, para AreaAre, vai voltar o valor do codigo da Area (codAre). Para um objeto que n�o seja FK, n�o se aplica, vai retornar o mesmo valor que iGetValor

Parameters:

item -

Returns:

string contendo o codigo do campo na tabela ItemEstruturaIett

Throws:

ECARException

iGetIndOpcional

java.lang.Boolean iGetIndOpcional()

iGetDica

java.lang.String iGetDica()

Devolve a dica do campo a ser utilizado em telas de cadastro e relat�rios. � o campo dicaEttat.

Returns:

dica do campo que ser� mostrado ao usu�rio

iGetGrupoAtributosLivres

SisGrupoAtributoSga iGetGrupoAtributosLivres()

Devolve o grupo de atributos livres de um atributo

Returns:

SisGrupoAtributoSga

iGetTamanhoConteudoAtrib

java.lang.Integer iGetTamanhoConteudoAtrib()

Devolve o tamanho do conte�do de um atributo.

Returns:

Integer

iGetLibTipoFuncAcompTpfas

java.util.Set<TipoFuncAcompTpfa> iGetLibTipoFuncAcompTpfas()