Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.novell.service.nds
Class NdsDistinguishedName

    java.lang.Object
      |
      +--com.novell.service.nds.NdsString
            |
            +--com.novell.service.nds.NdsDistinguishedName

public class NdsDistinguishedName
extends NdsString
implements NdsAttributeValue, java.lang.Cloneable, java.io.Serializable

Provides access to attribute values of the NdsDistinguishedName syntax. It is used for attributes whose values are the names of objects in the Directory tree. The largest supported Distinguished Name (DN) is 256 Unicode characters, not including the terminating NULL character. Distinguished Names are not case sensitive, even if one of the naming attributes is case sensitive.

Matching Rules: Equality

See Also:
  `NdsSyntaxId`, Serialized Form

Fields inherited from class com.novell.service.nds.NdsString
`name, value`

Constructor Summary
`NdsDistinguishedName(java.lang.String value)` Constructs an NdsDistinguishedName object based on the specified value parameter.

Method Summary
`boolean` | `approximate(java.lang.Object anObject)` Compares two Objects using the approximate matching rule.
`java.lang.Object` | `clone()` Creates a new object of the same class as this object.
`int` | `compareTo(java.lang.Object anObject)` Compares two objects for ordering, or compares two strings lexicographically.
`boolean` | `equals(java.lang.Object anObject)` Compares two Objects for equality.
`java.lang.String` | `getDistinguishedName()` Returns the String value of DistinguishedName stored in the object data member.
`int` | `getNdsSyntaxId()` Returns the int that represents the NDS syntax ID.
`boolean` | `supportsMatchingRules(int matchingRules)` Checks to see if this object supports the specified matching rules.

Methods inherited from class com.novell.service.nds.NdsString
`getName, stringValue, toString`

Methods inherited from class java.lang.Object
`finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### NdsDistinguishedName

    public NdsDistinguishedName(java.lang.String value)
                         throws com.novell.service.jncp.NSIException

  Constructs an NdsDistinguishedName object based on the specified value parameter.
  Parameters:
    `value` - The name of a DN object to be stored as a String value.
  Throws:
    com.novell.service.jncp.NSIException - Standard NJCL exception for working on top of XPlat libraries.

Method Detail

### compareTo

    public int compareTo(java.lang.Object anObject)
                  throws java.lang.Exception

  Compares two objects for ordering, or compares two strings lexicographically. The compareTo method does not apply to the NdsDistinguishedName syntax because this syntax does not support the ordering and substrings matching rules.
  Overrides:
    compareTo in class NdsString

### equals

    public boolean equals(java.lang.Object anObject)

  Compares two Objects for equality. The equals method compares this object value with the value of the reference object in the anObject parameter.

  The equals method implements the most discriminating possible equivalence relation on objects; that is, for any reference values X and Y, this method returns TRUE if and only if X and Y refer to the same object (X==Y has the value TRUE).

  Parameters:
    `anObject` - The reference object with which to compare.
  Returns:
    A boolean set to TRUE if and only if the argument is not NULL and is an NDS integer object that contains the same value as this object, otherwise set to FALSE.
  Overrides:
    equals in class NdsString

### approximate

    public boolean approximate(java.lang.Object anObject)
                        throws java.lang.Exception

  Compares two Objects using the approximate matching rule. The approximate method does not apply to the NdsDistinguishedName syntax because this syntax does not support the approximate equals matching rule.
  Specified by:
    approximate in interface NdsAttributeValue

### getNdsSyntaxId

    public int getNdsSyntaxId()

  Returns the int that represents the NDS syntax ID.
  Specified by:
    getNdsSyntaxId in interface NdsAttributeValue
  Returns:
    The syntax ID as an int.

### supportsMatchingRules

    public boolean supportsMatchingRules(int matchingRules)

  Checks to see if this object supports the specified matching rules.

  The NdsDistinguishedName syntax supports only the equality matching rule.

  Specified by:
    supportsMatchingRules in interface NdsAttributeValue
  Parameters:
    `matchingRules` - The set of matching rules to check.
  Returns:
    A Boolean set to TRUE if the matching rules for this object are equal to the matchingRules parameter.

### clone

    public java.lang.Object clone()

  Creates a new object of the same class as this object. It then initializes each of the new object's fields by assigning them the same value as the corresponding fields in this object. No constructor is called.
  Returns:
    A clone of this object instance containing the cloned syntax.
  Overrides:
    clone in class NdsString

### getDistinguishedName

    public java.lang.String getDistinguishedName()

  Returns the String value of DistinguishedName stored in the object data member.
  Returns:
    The stored String value.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD