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.data.BaseResource;
031    import com.unboundid.scim.sdk.SCIMQueryAttributes;
032    import com.unboundid.util.NotExtensible;
033    
034    
035    /**
036     * Represents a create request received by a DataView in the Identity Broker.
037     */
038    @NotExtensible
039    public interface StoreCreateRequest
040    {
041      /**
042       * Get the SCIM resource to create. This may be updated by any
043       * StoreAdapter to add useful attributes for other StoreAdapters.
044       *
045       * @return the BaseResource instance
046       */
047      BaseResource getResource();
048    
049      /**
050       * Get the SCIMQueryAttributes, which indicates whether all attributes or only
051       * a certain subset should be returned.
052       *
053       * @return the SCIMQueryAttributes
054       */
055      SCIMQueryAttributes getSCIMQueryAttributes();
056    }