csdk.v1_0.api.core

Interface ICSDKEnvironment

public interface ICSDKEnvironment

Interface com o ambiente CSDK.

Method Summary

Methods

Modifier and Type	Method and Description
void	finishApplication() Requisita o encerramento da execução da aplicação.
Charset	getCharset() Obtém o charset do ambiente.
<T extends IContext> T	getContext(Class<T> contextClass) Obtém um contexto do ambiente a partir da sua interface.
Locale	getLocale() Obtém o locale do ambiente.
Charset	getServerCharset() Obtém o charset do servidor.
void	handleException(Exception error, Window parent) Delega para o ambiente o tratamento de uma exceção.
String	runApplication(String appId) Inicia a execução de outra aplicação.
boolean	sendMessage(String instanceId, IMessage message) Envia uma mensagem a uma instância de aplicação em execução.

Method Detail

runApplication

String runApplication(String appId)
                      throws ApplicationException

Inicia a execução de outra aplicação.

Parameters:

appId - identificador da aplicação.

Returns:

o identificador da nova instância da aplicação ou null caso não exista aplicação com o identificador definido.

Throws:

ApplicationException - caso ocorra falha ao iniciar a nova aplicação.

sendMessage

boolean sendMessage(String instanceId,
                  IMessage message)

Envia uma mensagem a uma instância de aplicação em execução.

Parameters:

instanceId - o identificador da instância da aplicação.

message - a mensagem a ser enviada.

Returns:

true, se a instância foi encontrada e recebeu a mensagem com sucesso ou false, caso contrário.

finishApplication

void finishApplication()

Requisita o encerramento da execução da aplicação. Este método deve ser chamado caso a aplicação deseje ser terminada a qualquer hora antes da finalização pelo próprio ambiente. A aplicação precisa estar ativa para que possa ser finalizada.

handleException

void handleException(Exception error,
                   Window parent)

Delega para o ambiente o tratamento de uma exceção.

Parameters:

error - a exceção.

parent - janela que pode ser usada como base para mostrar mensagens de erro, se necessário. Aceita null.

getLocale

Locale getLocale()

Obtém o locale do ambiente.

Returns:

o locale.

getServerCharset

Charset getServerCharset()

Obtém o charset do servidor.

Returns:

o charset.

getCharset

Charset getCharset()

Obtém o charset do ambiente.

Returns:

o charset.

getContext

<T extends IContext> T getContext(Class<T> contextClass)

Obtém um contexto do ambiente a partir da sua interface. O contexto pode não estar disponível no ambiente e, nesse caso, o método retorna null.

Type Parameters:

T - interface do contexto.

Parameters:

contextClass - a interface do contexto desejado.

Returns:

uma instância do contexto ou null caso este contexto não esteja disponível no ambiente.