Referência da Interface tecgraf::openbus::data_service::IHierarchicalNavigationDataService

Serviço de Navegação Hierárquica em Dados Estruturados. Mais...

import "data_service.idl";

Diagrama de Hierarquia para tecgraf::openbus::data_service::IHierarchicalNavigationDataService:

Lista de todos os Membros.

Métodos Públicos
DataDescriptionSeq	getRoots () raises (ServiceFailure, DataAccessDenied)
	Obtém os descritores dos dados que representam as raízes da hierarquia.
DataDescriptionSeq	getChildren (in DataKey fKey) raises (ServiceFailure, InvalidDataKey, DataNotFound, DataAccessDenied)
	Obtém os descritores dos dados descendentes de um determinado dado.
DataDescription	getParent (in DataKey fKey) raises (ServiceFailure, InvalidDataKey, DataNotFound, DataAccessDenied)
	Obtém o descritor do ascendente de um dado.
DataDescription	getDataDescription (in DataKey fKey) raises (ServiceFailure, InvalidDataKey, DataNotFound, DataAccessDenied)
	Obtém o descritor de um dado.
DataView	getDataView (in DataKey fKey, in string fViewInterface) raises (ServiceFailure, InvalidDataKey, DataNotFound, UnknownViewInterface, DataAccessDenied)
	Obtém uma visão de um dado.
DataViewSeq	getDataViewSeq (in DataKeySeq fKeys, in string fViewInterface) raises (ServiceFailure, InvalidDataKey, DataNotFound, UnknownViewInterface, DataAccessDenied)
	Obtém um conjunto de visões para um conjunto de dados.

---

Descrição Detalhada

Serviço de Navegação Hierárquica em Dados Estruturados.

---

Métodos

DataDescriptionSeq tecgraf::openbus::data_service::IHierarchicalNavigationDataService::getChildren

(

in DataKey

fKey

)

raises (ServiceFailure, InvalidDataKey, DataNotFound, DataAccessDenied)

Obtém os descritores dos dados descendentes de um determinado dado.

Parâmetros:

[in]

fKey

A chave do dado que se deseja os descendentes.

Retorna:

Os dados descendentes.

Exceções:

ServiceFailure	Caso ocorra uma falha na operação.
InvalidDataKey	Caso a chave do dado não seja válida.
DataNotFound	Caso o dado não seja encontrado.
DataAccessDenied	Caso o usuário não tenha permissão de acesso.

DataDescription tecgraf::openbus::data_service::IHierarchicalNavigationDataService::getDataDescription

(

in DataKey

fKey

)

raises (ServiceFailure, InvalidDataKey, DataNotFound, DataAccessDenied)

Obtém o descritor de um dado.

Parâmetros:

[in]

fKey

A chave do dado.

Retorna:

O descritor do dado.

Exceções:

ServiceFailure	Caso ocorra uma falha na operação.
InvalidDataKey	Caso a chave do dado não seja válida.
DataNotFound	Caso o dado não seja encontrado.
DataAccessDenied	Caso o usuário não tenha permissão de acesso.

DataView tecgraf::openbus::data_service::IHierarchicalNavigationDataService::getDataView	(	in DataKey	fKey,
		in string	fViewInterface
	)		raises (ServiceFailure, InvalidDataKey, DataNotFound, UnknownViewInterface, DataAccessDenied)

Obtém uma visão de um dado.

O dado (representado pelo DataKey) pode oferecer diversas visões. O DataDescription é a estrutura responsável por informar quais visões um dado oferece.

Parâmetros:

[in]	fKey	A chave do dado.
[in]	fViewInterface	O nome da interface da visão desejada.

Retorna:

A visão.

Exceções:

ServiceFailure	Caso ocorra uma falha na operação.
InvalidDataKey	Caso a chave do dado não seja válida.
DataNotFound	Caso o dado não seja encontrado.
UnknownViewInterface	Indica que uma visão desconhecida foi solicitada.
DataAccessDenied	Caso o usuário não tenha permissão de acesso.

DataViewSeq tecgraf::openbus::data_service::IHierarchicalNavigationDataService::getDataViewSeq	(	in DataKeySeq	fKeys,
		in string	fViewInterface
	)		raises (ServiceFailure, InvalidDataKey, DataNotFound, UnknownViewInterface, DataAccessDenied)

Obtém um conjunto de visões para um conjunto de dados.

Todas as visões no conjunto implementam a mesma interface solicitada.

Parâmetros:

[in]	fKeys	As chaves dos dados.
[in]	fViewInterface	O nome da interface da visão desejada.

Retorna:

O conjunto de visões.

Exceções:

ServiceFailure	Caso ocorra uma falha na operação.
InvalidDataKey	Caso a chave do dado não seja válida.
DataNotFound	Caso o dado não seja encontrado.
UnknownViewInterface	Indica que uma visão desconhecida foi solicitada.
DataAccessDenied	Caso o usuário não tenha permissão de acesso.

DataDescription tecgraf::openbus::data_service::IHierarchicalNavigationDataService::getParent

(

in DataKey

fKey

)

raises (ServiceFailure, InvalidDataKey, DataNotFound, DataAccessDenied)

Obtém o descritor do ascendente de um dado.

Parâmetros:

[in]

fKey

A chave do dado que se deseja o ascendente.

Retorna:

O dado ascendente.

Exceções:

ServiceFailure	Caso ocorra uma falha na operação.
InvalidDataKey	Caso a chave do dado não seja válida.
DataNotFound	Caso o dado não seja encontrado.
DataAccessDenied	Caso o usuário não tenha permissão de acesso.

DataDescriptionSeq tecgraf::openbus::data_service::IHierarchicalNavigationDataService::getRoots

(

)

raises (ServiceFailure, DataAccessDenied)

Obtém os descritores dos dados que representam as raízes da hierarquia.

Este método é utilizado pelas aplicações que utilizam o serviço para iniciar a navegação nos dados.

Retorna:

Os descritores dos dados que representam as raízes da hierarquia.

Exceções:

ServiceFailure	Caso ocorra uma falha na operação.
DataAccessDenied	Caso o usuário não tenha permissão de acesso.