com.remedy.arsys.api
Class NameID

java.lang.Object
  |
  +--com.remedy.arsys.api.NameID

Direct Known Subclasses:

ActiveLinkKey, ContainerKey, EscalationKey, FilterKey, MenuKey, SchemaKey

public class NameID

extends java.lang.Object

implements java.lang.Cloneable, IARIdentifier, java.io.Serializable

The NameID class represents the names of objects.

See Also:

Serialized Form

Constructor Summary

NameID()
constructor

NameID(char[] str)
Constructor that takes a character array.

NameID(NameID nameID)
Constructor that takes a NameID.

NameID(java.lang.String str)
Constructor that takes a string.

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(java.lang.Object anObject) Use this method for checking equality of NameID.
java.lang.String	getValue() Returns name information.
int	hashCode() This method can be used to populate a hash table.
void	setValue(java.lang.String str) Sets name information whose limit is specified by Constants.AR_MAX_NAME_SIZE.
char[]	toCharArray() Returns a string description of the object.
java.lang.String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NameID

public NameID()

constructor

NameID

public NameID(java.lang.String str)
       throws java.lang.IllegalArgumentException

Constructor that takes a string. Throws IllegalArgumentException if str length is longer than Constants.AR_MAX_NAME_SIZE

NameID

public NameID(char[] str)
       throws java.lang.IllegalArgumentException

Constructor that takes a character array. Throws IllegalArgumentException if str length is longer than Constants.AR_MAX_NAME_SIZE

NameID

public NameID(NameID nameID)

Constructor that takes a NameID.

Method Detail

toCharArray

public char[] toCharArray()

Returns a string description of the object. Access Methods for m_name.

toString

public java.lang.String toString()

Returns a string description of the object.

Overrides:

toString in class java.lang.Object

getValue

public java.lang.String getValue()

Returns name information.

setValue

public void setValue(java.lang.String str)
              throws java.lang.IllegalArgumentException

Sets name information whose limit is specified by Constants.AR_MAX_NAME_SIZE.

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality of NameID. The result is true if and only if the argument is not null and is a NameID object that represents the same content.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

This method can be used to populate a hash table. Implicitly used method to test equality of objects.

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class java.lang.Object