Package com.unboundid.directory.sdk.common.schema

Interface DITStructureRule

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)
      Indicates whether the provided object is equal to this DIT structure rule.
      java.lang.String getDescription()
      Retrieves the description for this DIT content rule, if any.
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getExtensions()
      Retrieves a map of all defined extensions for this DIT structure rule.
      NameForm getNameForm()
      Retrieves the name form for this DIT structure rule.
      java.lang.String getNameOrRuleID()
      Retrieves the primary name for this DIT structure rule, or the rule ID if no names are defined.
      java.util.List<java.lang.String> getNames()
      Retrieves the list of names for this DIT structure rule, if any.
      int getRuleID()
      Retrieves the rule ID for this DIT structure rule.
      java.lang.String getSchemaFileName()
      Retrieves the name of the schema file in which this DIT structure rule is defined.
      ObjectClass getStructuralClass()
      Retrieves the structural object class for this DIT content rule.
      java.util.Set<DITStructureRule> getSuperiorRules()
      Retrieves the set of superior DIT structure rules for this rule, if any.
      int hashCode()
      Retrieves a hash code for this DIT structure rule.
      boolean hasNameOrRuleID​(java.lang.String name)
      Indicates whether the provided string is equal to any of the defined names or the rule ID for this DIT structure rule.
      boolean isObsolete()
      Indicates whether this DIT structure rule is declared obsolete in the server schema.
      java.lang.String toString()
      Retrieves a string representation of this DIT structure rule definition.

    • Method Detail

      • getRuleID

        int getRuleID()
        Retrieves the rule ID for this DIT structure rule.
        Returns:
        The rule ID for this DIT structure rule.

      • getNames

        java.util.List<java.lang.String> getNames()
        Retrieves the list of names for this DIT structure rule, if any.
        Returns:
        The list of names for this DIT structure rule, or an empty list if there are no user-defined names.

      • getNameOrRuleID

        java.lang.String getNameOrRuleID()
        Retrieves the primary name for this DIT structure rule, or the rule ID if no names are defined.
        Returns:
        The primary name or rule ID for this DIT structure rule.

      • hasNameOrRuleID

        boolean hasNameOrRuleID​(java.lang.String name)
        Indicates whether the provided string is equal to any of the defined names or the rule ID for this DIT structure rule.
        Parameters:
        name - The name for which to make the determination.
        Returns:
        true if the provided string matches one of the names or the rule ID for this DIT structure rule, or false if not.

      • getDescription

        java.lang.String getDescription()
        Retrieves the description for this DIT content rule, if any.
        Returns:
        The description for this DIT content rule, or null if it does not have a description.

      • getNameForm

        NameForm getNameForm()
        Retrieves the name form for this DIT structure rule.
        Returns:
        The name form for this DIT structure rule.

      • getStructuralClass

        ObjectClass getStructuralClass()
        Retrieves the structural object class for this DIT content rule.
        Returns:
        The structural object class for this DIT content rule.

      • getSuperiorRules

        java.util.Set<DITStructureRule> getSuperiorRules()
        Retrieves the set of superior DIT structure rules for this rule, if any.
        Returns:
        The set of superior DIT structure rules, or an empty set if there are no superior rules.

      • isObsolete

        boolean isObsolete()
        Indicates whether this DIT structure rule is declared obsolete in the server schema.
        Returns:
        true if this DIT structure rule is declared obsolete in the server schema, or false if not.

      • getExtensions

        java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getExtensions()
        Retrieves a map of all defined extensions for this DIT structure rule.
        Returns:
        A map of all defined extensions for this DIT structure rule.

      • getSchemaFileName

        java.lang.String getSchemaFileName()
        Retrieves the name of the schema file in which this DIT structure rule is defined.
        Returns:
        The name of the schema file in which this DIT structure rule is defined.

      • equals

        boolean equals​(java.lang.Object o)
        Indicates whether the provided object is equal to this DIT structure rule.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - The object for which to make the determination.
        Returns:
        true if the provided object is equal to this DIT structure rule, or false if not.

      • hashCode

        int hashCode()
        Retrieves a hash code for this DIT structure rule.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code for this DIT structure rule.

      • toString

        java.lang.String toString()
        Retrieves a string representation of this DIT structure rule definition.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this DIT structure rule definition.