Package org.opends.server.types

Class SearchResultEntry

java.lang.Object

org.opends.server.types.Entry

org.opends.server.types.SearchResultEntry

All Implemented Interfaces:

ProtocolElement

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public final class SearchResultEntry
extends Entry

This class defines a data structure for storing information about an entry that matches a given set of search criteria and should be returned to the client. When the search result entry contains attribute types only, the objectclass type (if requested) will be present in the user attributes. When the search result entry contains both attribute types and values, the objectclass attribute will not be present in the user attributes.

Constructor Summary

Constructors

Constructor	Description
SearchResultEntry(Entry entry)	Creates a new search result entry based on the provided entry.
SearchResultEntry(Entry entry, List<Control> controls)	Creates a new search result entry based on the provided entry.

Method Summary

Modifier and Type	Method	Description
List<Control>	getControls()	Retrieves the set of controls to include with this search result entry when it is sent to the client.

Methods inherited from class org.opends.server.types.Entry

addAttribute, addAttribute, addAttribute, addObjectClass, applyModification, applyModification, applyModifications, conformsToSchema, decode, decode, duplicate, encode, equals, filterEntry, getAliasedDN, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAttachment, getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, getName, getObjectClassAttribute, getObjectClasses, getOperationalAttribute, getOperationalAttribute, getOperationalAttributes, getProtocolElementName, getReferralURLs, getStructuralObjectClass, getTypeConformsToSchemaError, getUserAttribute, getUserAttributes, hasAttribute, hasAttribute, hasAttribute, hasAttribute, hashCode, hasObjectClass, hasOperationalAttribute, hasUserAttribute, hasValue, hasValue, incrementAttribute, isAlias, isCollectiveAttributeSubentry, isInheritedCollectiveAttributeSubentry, isInheritedFromDNCollectiveAttributeSubentry, isInheritedFromRDNCollectiveAttributeSubentry, isLDAPSubentry, isPasswordPolicySubentry, isReferral, isSubentry, matchesBaseAndScope, parseAttribute, processVirtualAttributes, putAttribute, removeAttribute, removeAttribute, removeAttribute, replaceAttribute, setAttachment, setDN, toLDIF, toLDIF, toLDIFString, toSingleLineString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultEntry

public SearchResultEntry(Entry entry)

Creates a new search result entry based on the provided entry. The provided entry should have been a duplicate of a real entry so that any changes that may be made to this entry (e.g., by access control or plugins) will not impact the original entry.

Parameters:

entry - The entry to use to create this search result entry.

SearchResultEntry

public SearchResultEntry(Entry entry,
                         List<Control> controls)

Creates a new search result entry based on the provided entry. The provided entry should have been a duplicate of a real entry so that any changes that may be made to this entry (e.g., by access control or plugins) will not impact the original entry.

Parameters:

entry - The entry to use to create this search result entry.

controls - The set of controls to return to the client with this entry.

Method Detail

getControls

public List<Control> getControls()

Retrieves the set of controls to include with this search result entry when it is sent to the client. This set of controls may be modified by the caller.

Returns:

The set of controls to include with this search result entry when it is sent to the client.