asjava.uniobjects
Class UniNLSlocale

java.lang.Object
  extended byasjava.uniobjects.UniBase
      extended byasjava.uniobjects.UniNLSlocale

public class UniNLSlocale
extends UniBase

UniNLSlocale is used to control the NLS locale settings. The NLS locale conventions it can control are Time, Numeric, Monetary, Character Type, and Collate. This object allows the application to modify those values to what is appropriate for their given environment.

Since:
UNIOBJECTS 1.0
Version:
Version 1.0
Author:
David T. Meeks

Field Summary
 
Fields inherited from class asjava.uniobjects.UniBase
inPacket, outPacket, uniConnection, uniEncryptionType, uniParentSession, uniStatus
 
Method Summary
 UniDynArray getClientNames()
          returns a UniDynArray of the client representation of the locale settings.
 UniDynArray getServerNames()
          returns a UniDynArray of the server representation of the locale settings.
 void setName(java.lang.Object aName)
          sets the specified locale.
 void setName(java.lang.Object aName, int anIndex)
          sets the specified locale.
 
Methods inherited from class asjava.uniobjects.UniBase
getEncryptionType, isCommandActive, setEncryptionType, status
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getClientNames

public UniDynArray getClientNames()
returns a UniDynArray of the client representation of the locale settings.

Returns:
UniDynArray of locale settings, as seen by the client
Since:
UNIOBJECTS 1.0
See Also:
getServerNames()

getServerNames

public UniDynArray getServerNames()
                           throws UniNLSException
returns a UniDynArray of the server representation of the locale settings.

Returns:
UniDynArray of locale settings, as seen by the server
Throws:
UniNLSException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getClientNames()

setName

public void setName(java.lang.Object aName,
                    int anIndex)
             throws UniNLSException
sets the specified locale. If aName is of type UniDynArray then each individual category is set to the corresponding UniDynArray value. If it contains only one element, and anIndex is specified, only that locale setting is changed. If anIndex is not set, then all locale categories are set to the value defined by aName

Parameters:
aName - String either a String or UniDynArray representing the new locale settings
anIndex - integer representing which category to be set
Throws:
UniNLSException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getClientNames(), getServerNames()

setName

public void setName(java.lang.Object aName)
             throws UniNLSException
sets the specified locale. If aName is of type UniDynArray then each individual category is set to the corresponding UniDynArray value. If it contains only one element, and anIndex is specified, only that locale setting is changed. If anIndex is not set, then all locale categories are set to the value defined by aName

Parameters:
aName - String either a String or UniDynArray representing the new locale settings
Throws:
UniNLSException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getClientNames(), getServerNames()