001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2013-2021 Ping Identity Corporation 026 */ 027 028package com.unboundid.directory.sdk.broker.types; 029 030import com.unboundid.util.NotExtensible; 031 032 033 034/** 035 * Represents a search request to retrieve entries from a Store Adapter. 036 */ 037@NotExtensible 038public interface StoreSearchRequest 039 extends StoreRequest 040{ 041 /** 042 * Retrieve the result listener that will be used to return results to the 043 * caller. 044 * 045 * @return The result listener that will be used to return results to the 046 * caller. 047 */ 048 StoreSearchResultListener getStoreSearchResultListener(); 049 050 /** 051 * Retrieves the SCIM Filter associated with this search request. 052 * The UnboundID scim2 SDK Filter class can be used to parse a SCIM filter. 053 * 054 * @return The SCIM Filter that should be used. This may be {@code null} if 055 * no filtering is required. 056 */ 057 String getSCIMFilter(); 058 059 /** 060 * Retrieves the maximum number of objects the store adapter should return 061 * for the search. A value of zero or less indicates that there should be 062 * no limit. 063 * 064 * @return The maximum number of objects the store adapter should return 065 * for the search. A value of zero or less indicates that there 066 * should be no limit. 067 */ 068 int getSizeLimit(); 069}