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-2014 UnboundID Corp.
026     */
027    
028    package com.unboundid.directory.sdk.broker.types;
029    
030    import com.unboundid.scim.sdk.PageParameters;
031    import com.unboundid.scim.sdk.SCIMFilter;
032    import com.unboundid.scim.sdk.SCIMQueryAttributes;
033    import com.unboundid.util.NotExtensible;
034    
035    /**
036     * Represents a SEARCH request received by a DataView in the Identity Broker.
037     * All filters and query attributes are using the native SCIM schema
038     * for the StoreAdapter (as defined by
039     * {@link com.unboundid.directory.sdk.broker.api.StoreAdapter#getNativeSchema()}
040     * ).
041     */
042    @NotExtensible
043    public interface StoreSearchRequest
044    {
045      /**
046       * Gets the SCIMFilter associated with this search request.
047       *
048       * @return the SCIMFilter that should be used. This may be {@code null}.
049       */
050      SCIMFilter getSCIMFilter();
051    
052      /**
053       * Gets the SCIMQueryAttributes, which indicates whether all attributes or
054       * only a certain subset should be returned.
055       *
056       * @return the SCIMQueryAttributes. This will never be {@code null}.
057       */
058      SCIMQueryAttributes getSCIMQueryAttributes();
059    
060      /**
061       * Retrieve the pagination parameters of the request.
062       *
063       * @return The pagination parameters of the request. This may be {@code null}.
064       */
065      PageParameters getPageParameters();
066    
067    }