Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.confserver.events
Class EventLocaleRead

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.configuration.protocol.confserver.events.EventLocaleRead
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventLocaleRead
extends Message

Server response with information from data resource repository corresponding to the requested LocaleID identifier.
For example:

  int lcid = 0;
  Message resp = confProtocol.request(RequestReadLocale.create(lcid));
  if (resp != null && resp.messageId() == EventLocaleRead.ID) {
      ConfSchema lcSchema = ((EventLocaleRead) resp).getSchemaData();
      // use localization data in 'lcSchema'...
  } else {
      // handle error...
  }

See Also:
RequestReadLocale, RequestGetLocaleSets, CfgLanguageLCID

Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventLocaleRead create()
          Creates instance of EventLocaleRead with no parameters set.
static EventLocaleRead create(java.lang.Integer localeId, org.w3c.dom.Document schemaInfo)
          Deprecated. Use new configuration server structures instead of DOM.
abstract  java.lang.Integer getLocaleId()
          Locale identifier
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  ConfSchema getSchemaData()
          Configuration Schema and Localization data
abstract  org.w3c.dom.Document getSchemaInfo()
          Deprecated. Use new configuration server structures instead of DOM.
abstract  void setLocaleId(int localeId)
          Locale identifier
abstract  void setLocaleId(java.lang.Integer localeId)
          Locale identifier
abstract  void setReferenceId(int referenceId)
          Reference ID to connect response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to request.
abstract  void setSchemaData(ConfSchema schemaData)
          Configuration Schema and Localization data
abstract  void setSchemaInfo(org.w3c.dom.Document schemaInfo)
          Deprecated. Use new configuration server structures instead of DOM.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static EventLocaleRead create()
Creates instance of EventLocaleRead with no parameters set.

Returns:
instance of EventLocaleRead

create

public static EventLocaleRead create(java.lang.Integer localeId,
                                     org.w3c.dom.Document schemaInfo)
Deprecated. Use new configuration server structures instead of DOM.

Creates instance of EventLocaleRead.

Parameters:
localeId - Locale identifier
schemaInfo - Xml Schema
Returns:
instance of EventLocaleRead

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


getLocaleId

public abstract java.lang.Integer getLocaleId()
Locale identifier

Returns:
property value

setLocaleId

public abstract void setLocaleId(java.lang.Integer localeId)
Locale identifier

Parameters:
localeId - new value of the property

setLocaleId

public abstract void setLocaleId(int localeId)
Locale identifier

Parameters:
localeId - new value of the property

getSchemaInfo

@Deprecated
public abstract org.w3c.dom.Document getSchemaInfo()
Deprecated. Use new configuration server structures instead of DOM.

Xml Schema

Returns:
property value

setSchemaInfo

@Deprecated
public abstract void setSchemaInfo(org.w3c.dom.Document schemaInfo)
Deprecated. Use new configuration server structures instead of DOM.

Xml Schema

Parameters:
schemaInfo - new value of the property

getSchemaData

public abstract ConfSchema getSchemaData()
Configuration Schema and Localization data

Returns:
property value

setSchemaData

public abstract void setSchemaData(ConfSchema schemaData)
Configuration Schema and Localization data

Parameters:
schemaData - new value of the property

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.