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 2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.scim2.types;
028
029import com.unboundid.util.NotExtensible;
030
031/**
032 * Represents a search request to retrieve SCIM 2 resources.
033 */
034@NotExtensible
035public interface SCIMSearchRequest extends SCIMRequest
036{
037  /**
038   * Gets the result listener that will be used to return results to the
039   * server.
040   *
041   * @return  The result listener that will be used to return results to the
042   *          server.
043   */
044  SCIMSearchResultListener getSearchResultListener();
045
046  /**
047   * Retrieves the SCIM Filter associated with this search request.
048   * The SCIM 2 SDK Filter class can be used to parse a SCIM filter.
049   *
050   * @return  The SCIM Filter that should be used. This may be {@code null}.
051   */
052  String getSCIMFilter();
053}