Obtenha informações sobre como criar um contexto de apresentação de listas.
No
IBM® Digital
Data Connector (DDC) for WebSphere Portal, o contexto de apresentação
de listas representa um objecto de dados agregado. Os suplementos do DDC podem utilizar o
objecto de dados para determinar os dados que deverão ser carregados e o modo de
filtragem e ordenação dos dados. Pode criar um contexto de apresentação de listas
adicionando um controlo
[Plugin:ListRenderingContext] às concepções do
Web Content Manager.
Partes do conteúdo de contexto são automaticamente concluídos pelo contexto do DDC. Estas
partes incluem o pedido e a resposta da portlet actual, bem como os parâmetros de
apresentação pública do
Digital Data Connector. Outras partes têm de ser
especificadas através dos parâmetros do controlo
Plugin:ListRenderingContext.
A sintaxe geral do controlo é a seguinte:
[Plugin:ListRenderingContext action=”” extension-id=”” profile=””attribute=””
key=”” format=”” separator=”” escape=”” prefix]
Os parâmetros são descritos na seguinte lista:
- action
- Este parâmetro é obrigatório. Utilize este parâmetro para identificar a acção que
pretende que seja executada. Os valores suportados são os seguintes:
- set
- Utilize este valor para estabelecer um novo contexto de apresentação de listas. Pode
imbricar contextos de apresentação de listas. Se especificar este valor, é necessário que
também defina o parâmetro extension-id.
- remove
- Utilize este valor para remover o contexto de apresentação de listas actual. Se este
contexto de apresentação de listas se tratar de um contexto de apresentação de listas
imbricado, o contexto de apresentação de listas externo torna-se novamente activo.
- getListProperty
- Utilize este valor para extrair propriedades da lista de beans que foi carregada para
o contexto de apresentação de listas actual.
- getAttribute
- Utilize este valor para extrair os atributos individuais que especificou ao criar o
contexto de apresentação de listas actual.
- getFilter
- Utilize este valor para obter o valor de um parâmetro de apresentação pública do
filtro do DDC específico.
- reloadProfiles
- Utilize este valor para limpar todas as caches relacionadas com o DDC e recarregar
todos os perfis de apresentação de listas. Este parâmetro pode ser útil em ambientes de
desenvolvimento para activar modificações em perfis de apresentação de listas
implementados.
- clearCaches
- Utilize este valor para limpar todas as caches relacionadas com o DDC. Este parâmetro
pode ser útil em ambientes de desenvolvimento para analisar problemas de colocação em
cache.
- exceptionOccured
- Utilize este valor para verificar se ocorreu uma excepção durante o cálculo da lista
de beans. A portlet Visualizador de conteúdo da Web apenas apresenta o conteúdo do
controlo do suplemento ListRenderingContext com esta acção, se tiver
ocorrido uma excepção aquando do processamento do contexto de apresentação de listas
actual.
- getExceptionMessage
- Utilize este valor para obter a mensagem de uma excepção que ocorreu durante o
cálculo da lista de beans.
- extension-id
- Utilize este parâmetro para identificar o suplemento do DDC específico que pretende
que processe este contexto. Este parâmetro é obrigatório com a definição
action="set". Para endereçar o suplemento do DDC de XML genérico,
especifique o valor ibm.portal.ddc.xml.
- profile
- Utilize este parâmetro para identificar o perfil de apresentação de listas que
pretende que seja utilizado. Este parâmetro torna-se efectivo apenas em conjunto com a
definição action="set". Este parâmetro é obrigatório ao
endereçar o suplemento do DDC de XML genérico no parâmetro extension-id.
- attribute
- Utilize este parâmetro como um atributo com vários valores que pode ser utilizado
para adicionar mais informações ao contexto de apresentação de listas. Este parâmetro é
relevante apenas para a definição action="set".
O suplemento do DDC de XML genérico suporta um conjunto de atributos. Para obter detalhes sobre estes
atributos, consulte o tópico Suplemento do
Digital Data Connector de XML genérico.
- key
- Utilize este parâmetro para identificar um atributo específico ou uma propriedade de
lista que pretende que seja gravada na marcação. Este parâmetro é relevante apenas para
as definições action="getListProperty" e
action="getAttribute".
- format
- Utilize este parâmetro para especificar a formatação que pretende que seja utilizada
quando o suplemento grava as propriedades da lista do tipo Date na
marcação. Este parâmetro é relevante apenas para a definição action="getListProperty".
- separator
- Utilize este parâmetro para especificar o fragmento da marcação que pretende que seja
gravado na marcação entre os elementos de uma propriedade de lista com vários valores. O valor predefinido é uma vírgula ( , ).
Este parâmetro é relevante apenas para a definição action="getListProperty".
- escape
- Utilize este parâmetro para especificar a mudança de código que pretende aplicar à
marcação gerada pelo suplemento. Os valores suportados são os seguintes:
xml, json, javascript e
none. O valor predefinido é none.
Este parâmetro é relevante apenas para action="getListProperty",
action="getAttribute", action="getFilter" e
action="getExceptionMessage".
- prefix
- Utilize este parâmetro para especificar o prefixo para o parâmetro de apresentação
pública do filtro do DDC que pretende que seja obtido. Este parâmetro é relevante apenas
para action="getFilter".
A tabela a seguir
apresenta que acções são suportadas pelos parâmetros e se são obrigatórias.
Tabela 1. Parâmetros obrigatórios e acções suportadas pelos mesmosParâmetro |
O parâmetro é relevante para estas acções |
O parâmetro é obrigatório com as acções na coluna anterior |
action |
N/D |
N/D |
extension-id |
set |
sim |
profile |
set |
O parâmetro profile é obrigatório dependendo
do valor do parâmetro extension-id.
Se endereçar o suplemento do DDC de XML genérico, o parâmetro profile é obrigatório. |
attribute |
set |
não |
key |
getListProperty, getAttribute |
sim |
format |
getListProperty |
não |
separator |
getListProperty, getFilter |
não |
escape |
getListProperty, getAttribute, getFilter |
não |
Para obter exemplos da
definição do contexto de apresentação de listas, consulte os seguintes tópicos.