Package org.forgerock.opendj.ldap.messages

Record Class SearchResultEntry

java.lang.Object
java.lang.Record
org.forgerock.opendj.ldap.messages.SearchResultEntry
Record Components:
entry - the entry found during a search operation.
controls - the List containing the controls.
All Implemented Interfaces:
ProtocolOp, Response
public record SearchResultEntry(Entry entry, List<Control> controls) extends Record implements Response
A Search Result Entry represents an entry found during a Search operation.

Each entry returned in a Search Result Entry will contain all appropriate attributes as specified in the Search request, subject to access control and other administrative policy.

Note that a Search Result Entry may hold zero attributes. This may happen when none of the attributes of an entry were requested or could be returned.

Note also that each returned attribute may hold zero attribute values. This may happen when only attribute types are requested, access controls prevent the return of values, or other reasons.

  • Constructor Details

    • SearchResultEntry

      public SearchResultEntry(Entry entry, List<Control> controls)
      Creates a new SearchResultEntry.

  • Method Details

    • name

      public Dn name()
      Returns the distinguished name of this entry.
      Returns:
      The distinguished name of this entry.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • entry

      public Entry entry()
      Returns the value of the entry record component.
      Returns:
      the value of the entry record component

    • controls

      public List<Control> controls()
      Returns the value of the controls record component.
      Specified by:
      controls in interface ProtocolOp
      Returns:
      the value of the controls record component