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 2016-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.broker.types;
028
029import com.unboundid.scim2.common.filters.Filter;
030
031/**
032 * Request context for the method called before an entry is retrieved from the
033 * native data store.
034 */
035public interface StorePreRetrieveRequestContext extends StoreRequestContext
036{
037  /**
038   * Get the SCIM filter which identifies the entry to be retrieved.
039   *
040   * @return  The SCIM filter which identifies the entry to be retrieved.
041   */
042  Filter getSCIMFilter();
043
044  /**
045   * Sets the SCIM filter which identifies the entry to be retrieved.
046   *
047   * @param scimFilter The SCIM filter which identifies the entry to be
048   *                   retrieved.
049   */
050  void setSCIMFilter(Filter scimFilter);
051}