Home > Class Reference > HSLIB namespace > EnsLib.LDAP.Message.Search

EnsLib.LDAP.Message.Search

persistent class EnsLib.LDAP.Message.Search extends Ens.Request

SQL Table Name: EnsLib_LDAP_Message.Search

Generic Ensemble Search class

Property Inventory

Properties

property AttributesOnly as %Boolean [ InitialExpression = 0 ];
Only return Attribute names. Default is false
Property methods: AttributesOnlyDisplayToLogical(), AttributesOnlyGet(), AttributesOnlyGetStored(), AttributesOnlyIsValid(), AttributesOnlyLogicalToDisplay(), AttributesOnlyLogicalToXSD(), AttributesOnlyNormalize(), AttributesOnlySet(), AttributesOnlyXSDToLogical()
property AttributesToReturn as %String);
Comma separated list of Attributes to return. If empty then all attributes.
Property methods: AttributesToReturnDisplayToLogical(), AttributesToReturnGet(), AttributesToReturnGetStored(), AttributesToReturnIsValid(), AttributesToReturnLogicalToDisplay(), AttributesToReturnLogicalToOdbc(), AttributesToReturnNormalize(), AttributesToReturnSet()
property Authenticate as %Boolean [ InitialExpression = 1 ];
Ensure process authenticates before searching. Default is to authenticate. Set to "" if leave to adapter
Property methods: AuthenticateDisplayToLogical(), AuthenticateGet(), AuthenticateGetStored(), AuthenticateIsValid(), AuthenticateLogicalToDisplay(), AuthenticateLogicalToXSD(), AuthenticateNormalize(), AuthenticateSet(), AuthenticateXSDToLogical()
property BinaryAttributes as %String);
Comma separate list of attributes in search that require Binary retrieval. Optional.
Property methods: BinaryAttributesDisplayToLogical(), BinaryAttributesGet(), BinaryAttributesGetStored(), BinaryAttributesIsValid(), BinaryAttributesLogicalToDisplay(), BinaryAttributesLogicalToOdbc(), BinaryAttributesNormalize(), BinaryAttributesSet()
property Filter as %String);
Search Filter
Property methods: FilterDisplayToLogical(), FilterGet(), FilterGetStored(), FilterIsValid(), FilterLogicalToDisplay(), FilterLogicalToOdbc(), FilterNormalize(), FilterSet()
property IgnoreObjectNotInDIT as %Boolean [ InitialExpression = 1 ];
Indicate if should ignore no such object in DIT
Property methods: IgnoreObjectNotInDITDisplayToLogical(), IgnoreObjectNotInDITGet(), IgnoreObjectNotInDITGetStored(), IgnoreObjectNotInDITIsValid(), IgnoreObjectNotInDITLogicalToDisplay(), IgnoreObjectNotInDITLogicalToXSD(), IgnoreObjectNotInDITNormalize(), IgnoreObjectNotInDITSet(), IgnoreObjectNotInDITXSDToLogical()
property PageSize as %Integer;
Set this property to specify page size for paged searches.
Property methods: PageSizeDisplayToLogical(), PageSizeGet(), PageSizeGetStored(), PageSizeIsValid(), PageSizeLogicalToDisplay(), PageSizeNormalize(), PageSizeSet(), PageSizeXSDToLogical()
property Scope as Ens.DataType.LDAP.Scope [ InitialExpression = 0 ];
Scope of search. Default is 0/base
Property methods: ScopeDisplayToLogical(), ScopeGet(), ScopeGetStored(), ScopeIsValid(), ScopeLogicalToDisplay(), ScopeNormalize(), ScopeSet(), ScopeXSDToLogical()
property SearchBase as %String);
Search Base
Property methods: SearchBaseDisplayToLogical(), SearchBaseGet(), SearchBaseGetStored(), SearchBaseIsValid(), SearchBaseLogicalToDisplay(), SearchBaseLogicalToOdbc(), SearchBaseNormalize(), SearchBaseSet()
property SearchSizeLimit as %Integer;
Search results Size Limit. If not set the adapter will set the value
Property methods: SearchSizeLimitDisplayToLogical(), SearchSizeLimitGet(), SearchSizeLimitGetStored(), SearchSizeLimitIsValid(), SearchSizeLimitLogicalToDisplay(), SearchSizeLimitNormalize(), SearchSizeLimitSet(), SearchSizeLimitXSDToLogical()
property SearchTimeout as %Integer;
Search time out default. If "" then the adapter will set the value
Property methods: SearchTimeoutDisplayToLogical(), SearchTimeoutGet(), SearchTimeoutGetStored(), SearchTimeoutIsValid(), SearchTimeoutLogicalToDisplay(), SearchTimeoutNormalize(), SearchTimeoutSet(), SearchTimeoutXSDToLogical()

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)

^Ens.MessageBodyD(ID)
=
%%CLASSNAME

Storage Model: Storage (EnsLib.LDAP.Message.Search)

^Ens.MessageBodyD(ID,"Search")
=
SearchBase
Filter
AttributesToReturn
BinaryAttributes
AttributesOnly
Scope
SearchTimeout
SearchSizeLimit
Authenticate
IgnoreObjectNotInDIT
PageSize
FeedbackOpens in a new window