asjava.uniobjects
Class UniNLSmap

java.lang.Object
  asjava.uniobjects.UniBase
      asjava.uniobjects.UniNLSmap

public class UniNLSmap

extends UniBase

UniNLSmap is used to control the NLS map settings. It is only available if NLS is enabled on the server uniConnection.

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

java.lang.String	getClientNames() returns the client representation of the map name.
java.lang.String	getMarkCharacter(int aTokenVal) returns the requested mark character.
java.lang.String	getServerNames() returns the server representation of the map name.
void	setName(java.lang.Object aName) sets the specified map.

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

setName

public void setName(java.lang.Object aName)
             throws UniNLSException

sets the specified map. If aName

Parameters:

aName - New NLS map name to be set for this client/server relationship

Throws:

UniNLSException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

See Also:

getClientNames(), getServerNames()

getClientNames

public java.lang.String getClientNames()

returns the client representation of the map name. This is the same name that was used to establish the NLS Map from the application perspective, via the setName method.

Returns:

String representing client side map name

Since:

UNIOBJECTS 1.0

See Also:

getServerNames(), setName(java.lang.Object)

getServerNames

public java.lang.String getServerNames()
                                throws UniNLSException

returns the server representation of the map name. This value may differ from the name that was requested via the setName method. This is due to a client-server NLS Map name mapping that is done.

Returns:

String representing server side map name

Throws:

UniNLSException - is thrown if an error occurs

Since:

UNIOBJECTS 1.0

See Also:

getClientNames(), setName(java.lang.Object)

getMarkCharacter

public java.lang.String getMarkCharacter(int aTokenVal)
                                  throws UniNLSException

returns the requested mark character. This may change from the default values depending on the map that was established.

Returns:

String representing the requested mark character

Throws:

UniNLSException - is thrown if an error occurs

Since:

#UNIOBJECTS 1.0