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-2016 UnboundID Corp.
026 */
027
028package com.unboundid.directory.sdk.broker.types;
029
030import com.unboundid.scim.data.BaseResource;
031import com.unboundid.scim.sdk.SCIMQueryAttributes;
032import com.unboundid.util.NotExtensible;
033
034
035/**
036 * Represents an update request received by a DataView in the Identity Broker.
037 * An update request can perform different operations on different attributes,
038 * so this interface splits them out by operation (update/merge and delete).
039 */
040@NotExtensible
041public interface StoreUpdateRequest
042{
043  /**
044   * Get the SCIM ID of the resource to update.
045   *
046   * @return the SCIM ID
047   */
048  String getId();
049
050  /**
051   * Get the partial resource with the modifications that may be sent in
052   * a PATCH request.
053   * <p>
054   * This resource conforms to Section 3.3.2 of the SCIM 1.1 specification
055   * (<i>draft-scim-api-01</i>), "Modifying Resources with PATCH".
056   *
057   * @return the partial resource which contains the PATCH modifications. This
058   *         will never be {@code null}.
059   */
060  BaseResource getPartialResource();
061
062  /**
063   * Get the SCIMQueryAttributes, which indicates whether all attributes or
064   * only a certain subset should be returned.
065   *
066   * @return the SCIMQueryAttributes. This will never be {@code null}.
067   */
068  SCIMQueryAttributes getSCIMQueryAttributes();
069}