import { ASN1Element as _Element, BIT_STRING, BOOLEAN, INTEGER, OPTIONAL } from "@wildboar/asn1"; import * as $ from "@wildboar/asn1/functional"; import { ContextSelection } from "../DirectoryAbstractService/ContextSelection.ta.mjs"; import { EntryInformationSelection } from "../DirectoryAbstractService/EntryInformationSelection.ta.mjs"; import { FamilyGrouping, _enum_for_FamilyGrouping } from "../DirectoryAbstractService/FamilyGrouping.ta.mjs"; import { Filter } from "../DirectoryAbstractService/Filter.ta.mjs"; import { HierarchySelections } from "../DirectoryAbstractService/HierarchySelections.ta.mjs"; import { JoinArgument } from "../DirectoryAbstractService/JoinArgument.ta.mjs"; import { PagedResultsRequest } from "../DirectoryAbstractService/PagedResultsRequest.ta.mjs"; import { SearchArgumentData_joinType, _enum_for_SearchArgumentData_joinType } from "../DirectoryAbstractService/SearchArgumentData-joinType.ta.mjs"; import { SearchArgumentData_subset } from "../DirectoryAbstractService/SearchArgumentData-subset.ta.mjs"; import { SearchControlOptions } from "../DirectoryAbstractService/SearchControlOptions.ta.mjs"; import { SecurityParameters } from "../DirectoryAbstractService/SecurityParameters.ta.mjs"; import { ServiceControls } from "../DirectoryAbstractService/ServiceControls.ta.mjs"; import { Exclusions } from "../DistributedOperations/Exclusions.ta.mjs"; import { OperationProgress } from "../DistributedOperations/OperationProgress.ta.mjs"; import { ReferenceType, _enum_for_ReferenceType } from "../DistributedOperations/ReferenceType.ta.mjs"; import { DistinguishedName } from "../InformationFramework/DistinguishedName.ta.mjs"; import { Name } from "../InformationFramework/Name.ta.mjs"; import { RelaxationPolicy } from "../ServiceAdministration/RelaxationPolicy.ta.mjs"; import { CommonArguments } from "../DirectoryAbstractService/CommonArguments.ta.mjs"; /** * @summary SearchArgumentData * @description * * ### ASN.1 Definition: * * ```asn1 * SearchArgumentData ::= SET { * baseObject [0] Name, * subset [1] INTEGER { * baseObject (0), * oneLevel (1), * wholeSubtree (2)} DEFAULT baseObject, * filter [2] Filter DEFAULT and:{}, * searchAliases [3] BOOLEAN DEFAULT TRUE, * selection [4] EntryInformationSelection DEFAULT {}, * pagedResults [5] PagedResultsRequest OPTIONAL, * matchedValuesOnly [6] BOOLEAN DEFAULT FALSE, * extendedFilter [7] Filter OPTIONAL, * checkOverspecified [8] BOOLEAN DEFAULT FALSE, * relaxation [9] RelaxationPolicy OPTIONAL, * extendedArea [10] INTEGER OPTIONAL, * hierarchySelections [11] HierarchySelections DEFAULT {self}, * searchControlOptions [12] SearchControlOptions DEFAULT {searchAliases}, * joinArguments [13] SEQUENCE SIZE (1..MAX) OF JoinArgument OPTIONAL, * joinType [14] ENUMERATED { * innerJoin (0), * leftOuterJoin (1), * fullOuterJoin (2)} DEFAULT leftOuterJoin, * ..., * ..., * COMPONENTS OF CommonArguments } * ``` * */ export declare class SearchArgumentData implements CommonArguments { /** * @summary `baseObject`. * @public * @readonly */ readonly baseObject: Name; /** * @summary `subset`. * @public * @readonly */ readonly subset?: OPTIONAL; /** * @summary `filter`. * @public * @readonly */ readonly filter?: OPTIONAL; /** * @summary `searchAliases`. * @public * @readonly */ readonly searchAliases?: OPTIONAL; /** * @summary `selection`. * @public * @readonly */ readonly selection?: OPTIONAL; /** * @summary `pagedResults`. * @public * @readonly */ readonly pagedResults?: OPTIONAL; /** * @summary `matchedValuesOnly`. * @public * @readonly */ readonly matchedValuesOnly?: OPTIONAL; /** * @summary `extendedFilter`. * @public * @readonly */ readonly extendedFilter?: OPTIONAL; /** * @summary `checkOverspecified`. * @public * @readonly */ readonly checkOverspecified?: OPTIONAL; /** * @summary `relaxation`. * @public * @readonly */ readonly relaxation?: OPTIONAL; /** * @summary `extendedArea`. * @public * @readonly */ readonly extendedArea?: OPTIONAL; /** * @summary `hierarchySelections`. * @public * @readonly */ readonly hierarchySelections?: OPTIONAL; /** * @summary `searchControlOptions`. * @public * @readonly */ readonly searchControlOptions?: OPTIONAL; /** * @summary `joinArguments`. * @public * @readonly */ readonly joinArguments?: OPTIONAL; /** * @summary `joinType`. * @public * @readonly */ readonly joinType?: OPTIONAL; /** * @summary Extensions that are not recognized. * @public * @readonly */ readonly _unrecognizedExtensionsList: _Element[]; /** * @summary `serviceControls`. * @public * @readonly */ readonly serviceControls?: OPTIONAL; /** * @summary `securityParameters`. * @public * @readonly */ readonly securityParameters?: OPTIONAL; /** * @summary `requestor`. * @public * @readonly */ readonly requestor?: OPTIONAL; /** * @summary `operationProgress`. * @public * @readonly */ readonly operationProgress?: OPTIONAL; /** * @summary `aliasedRDNs`. * @public * @readonly */ readonly aliasedRDNs?: OPTIONAL; /** * @summary `criticalExtensions`. * @public * @readonly */ readonly criticalExtensions?: OPTIONAL; /** * @summary `referenceType`. * @public * @readonly */ readonly referenceType?: OPTIONAL; /** * @summary `entryOnly`. * @public * @readonly */ readonly entryOnly?: OPTIONAL; /** * @summary `exclusions`. * @public * @readonly */ readonly exclusions?: OPTIONAL; /** * @summary `nameResolveOnMaster`. * @public * @readonly */ readonly nameResolveOnMaster?: OPTIONAL; /** * @summary `operationContexts`. * @public * @readonly */ readonly operationContexts?: OPTIONAL; /** * @summary `familyGrouping`. * @public * @readonly */ readonly familyGrouping?: OPTIONAL; constructor( /** * @summary `baseObject`. * @public * @readonly */ baseObject: Name, /** * @summary `subset`. * @public * @readonly */ subset?: OPTIONAL, /** * @summary `filter`. * @public * @readonly */ filter?: OPTIONAL, /** * @summary `searchAliases`. * @public * @readonly */ searchAliases?: OPTIONAL, /** * @summary `selection`. * @public * @readonly */ selection?: OPTIONAL, /** * @summary `pagedResults`. * @public * @readonly */ pagedResults?: OPTIONAL, /** * @summary `matchedValuesOnly`. * @public * @readonly */ matchedValuesOnly?: OPTIONAL, /** * @summary `extendedFilter`. * @public * @readonly */ extendedFilter?: OPTIONAL, /** * @summary `checkOverspecified`. * @public * @readonly */ checkOverspecified?: OPTIONAL, /** * @summary `relaxation`. * @public * @readonly */ relaxation?: OPTIONAL, /** * @summary `extendedArea`. * @public * @readonly */ extendedArea?: OPTIONAL, /** * @summary `hierarchySelections`. * @public * @readonly */ hierarchySelections?: OPTIONAL, /** * @summary `searchControlOptions`. * @public * @readonly */ searchControlOptions?: OPTIONAL, /** * @summary `joinArguments`. * @public * @readonly */ joinArguments?: OPTIONAL, /** * @summary `joinType`. * @public * @readonly */ joinType?: OPTIONAL, /** * @summary Extensions that are not recognized. * @public * @readonly */ _unrecognizedExtensionsList?: _Element[], /** * @summary `serviceControls`. * @public * @readonly */ serviceControls?: OPTIONAL, /** * @summary `securityParameters`. * @public * @readonly */ securityParameters?: OPTIONAL, /** * @summary `requestor`. * @public * @readonly */ requestor?: OPTIONAL, /** * @summary `operationProgress`. * @public * @readonly */ operationProgress?: OPTIONAL, /** * @summary `aliasedRDNs`. * @public * @readonly */ aliasedRDNs?: OPTIONAL, /** * @summary `criticalExtensions`. * @public * @readonly */ criticalExtensions?: OPTIONAL, /** * @summary `referenceType`. * @public * @readonly */ referenceType?: OPTIONAL, /** * @summary `entryOnly`. * @public * @readonly */ entryOnly?: OPTIONAL, /** * @summary `exclusions`. * @public * @readonly */ exclusions?: OPTIONAL, /** * @summary `nameResolveOnMaster`. * @public * @readonly */ nameResolveOnMaster?: OPTIONAL, /** * @summary `operationContexts`. * @public * @readonly */ operationContexts?: OPTIONAL, /** * @summary `familyGrouping`. * @public * @readonly */ familyGrouping?: OPTIONAL); /** * @summary Restructures an object into a SearchArgumentData * @description * * This takes an `object` and converts it to a `SearchArgumentData`. * * @public * @static * @method * @param {Object} _o An object having all of the keys and values of a `SearchArgumentData`. * @returns {SearchArgumentData} */ static _from_object(_o: { [_K in keyof SearchArgumentData]: SearchArgumentData[_K]; }): SearchArgumentData; /** * @summary Getter that returns the default value for `subset`. * @public * @static * @method */ static get _default_value_for_subset(): SearchArgumentData_subset; /** * @summary Getter that returns the default value for `filter`. * @public * @static * @method */ static get _default_value_for_filter(): Filter; /** * @summary Getter that returns the default value for `searchAliases`. * @public * @static * @method */ static get _default_value_for_searchAliases(): BOOLEAN; /** * @summary Getter that returns the default value for `selection`. * @public * @static * @method */ static get _default_value_for_selection(): EntryInformationSelection; /** * @summary Getter that returns the default value for `matchedValuesOnly`. * @public * @static * @method */ static get _default_value_for_matchedValuesOnly(): BOOLEAN; /** * @summary Getter that returns the default value for `checkOverspecified`. * @public * @static * @method */ static get _default_value_for_checkOverspecified(): BOOLEAN; /** * @summary Getter that returns the default value for `hierarchySelections`. * @public * @static * @method */ static get _default_value_for_hierarchySelections(): HierarchySelections; /** * @summary Getter that returns the default value for `searchControlOptions`. * @public * @static * @method */ static get _default_value_for_searchControlOptions(): SearchControlOptions; /** * @summary Getter that returns the default value for `joinType`. * @public * @static * @method */ static get _default_value_for_joinType(): SearchArgumentData_joinType; /** * @summary Getter that returns the default value for `serviceControls`. * @public * @static * @method */ static get _default_value_for_serviceControls(): ServiceControls; /** * @summary Getter that returns the default value for `operationProgress`. * @public * @static * @method */ static get _default_value_for_operationProgress(): OperationProgress; /** * @summary Getter that returns the default value for `entryOnly`. * @public * @static * @method */ static get _default_value_for_entryOnly(): BOOLEAN; /** * @summary Getter that returns the default value for `nameResolveOnMaster`. * @public * @static * @method */ static get _default_value_for_nameResolveOnMaster(): BOOLEAN; /** * @summary Getter that returns the default value for `familyGrouping`. * @public * @static * @method */ static get _default_value_for_familyGrouping(): FamilyGrouping; /** * @summary The enum used as the type of the component `joinType` * @public * @static */ static _enum_for_joinType: typeof _enum_for_SearchArgumentData_joinType; /** * @summary The enum used as the type of the component `referenceType` * @public * @static */ static _enum_for_referenceType: typeof _enum_for_ReferenceType; /** * @summary The enum used as the type of the component `familyGrouping` * @public * @static */ static _enum_for_familyGrouping: typeof _enum_for_FamilyGrouping; } /** * @summary The Leading Root Component Types of SearchArgumentData * @description * * This is an array of `ComponentSpec`s that define how to decode the leading root component type list of a SET or SEQUENCE. * * @constant */ export declare const _root_component_type_list_1_spec_for_SearchArgumentData: $.ComponentSpec[]; /** * @summary The Trailing Root Component Types of SearchArgumentData * @description * * This is an array of `ComponentSpec`s that define how to decode the trailing root component type list of a SET or SEQUENCE. * * @constant */ export declare const _root_component_type_list_2_spec_for_SearchArgumentData: $.ComponentSpec[]; /** * @summary The Extension Addition Component Types of SearchArgumentData * @description * * This is an array of `ComponentSpec`s that define how to decode the extension addition component type list of a SET or SEQUENCE. * * @constant */ export declare const _extension_additions_list_spec_for_SearchArgumentData: $.ComponentSpec[]; /** * @summary Decodes an ASN.1 element into a(n) SearchArgumentData * @function * @param {_Element} el The element being decoded. * @returns {SearchArgumentData} The decoded data structure. */ export declare function _decode_SearchArgumentData(el: _Element): SearchArgumentData; /** * @summary Encodes a(n) SearchArgumentData into an ASN.1 Element. * @function * @param value The element being encoded. * @param elGetter A function that can be used to get new ASN.1 elements. * @returns {_Element} The SearchArgumentData, encoded as an ASN.1 Element. */ export declare function _encode_SearchArgumentData(value: SearchArgumentData, elGetter: $.ASN1Encoder): _Element; //# sourceMappingURL=SearchArgumentData.ta.d.mts.map