Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.commons.protocol
Class EnumDescriptions

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.EnumDescriptions

public class EnumDescriptions
extends java.lang.Object


Method Summary
static java.lang.String getDescription(GEnum enumValue)
          Retrieve enum value description.
static void registerDescription(GEnum enumValue, java.lang.String description)
          Register description of the enum value.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

registerDescription

public static void registerDescription(GEnum enumValue,
                                       java.lang.String description)
Register description of the enum value. This method is called by protocol runtime and not expected to be used somewhere else.

Parameters:
enumValue - value of the enum to register description for
description - text description of the value

getDescription

public static java.lang.String getDescription(GEnum enumValue)
Retrieve enum value description. If there is not description for the value null is returned.

Parameters:
enumValue - enum value to look for description
Returns:
description text or null

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.