com.adobe.cq.social.enablement.resource.endpoints.api.EnablementResourceModelServiceUpdate Maven / Gradle / Ivy

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2016 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/

package com.adobe.cq.social.enablement.resource.endpoints.api;

import java.util.Map;

import javax.jcr.RepositoryException;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.PersistenceException;
import org.apache.sling.commons.json.JSONException;

import com.adobe.cq.social.enablement.exceptions.EnablementException;
import com.adobe.cq.social.enablement.resource.model.api.EnablementResourceModel;
import com.adobe.cq.social.scf.OperationException;

/**
 * @author akeith
 */
public interface EnablementResourceModelServiceUpdate {

    /**
     * @param request - SlingHttpServletRequest
     * @param fieldWhitelist - list of white listed fields
     * @return map
     * @throws OperationException thrown if any operational problem occurs
     */
    Map getOperationProperties(SlingHttpServletRequest request, String[] fieldWhitelist)
        throws OperationException;

    /**
     * @param request - SlingHttpServletRequest
     * @param properties - map of properties
     * @param fieldWhitelist - list of white listed fields
     * @return enablement resource model
     * @throws PersistenceException thrown if exception occurs while persisting data
     * @throws JSONException thrown if json error occurs
     * @throws EnablementException thrown if exception occurs while updating enablement model
     */
    public EnablementResourceModel update(final SlingHttpServletRequest request,
        final Map properties, String[] fieldWhitelist) throws PersistenceException, JSONException,
        EnablementException;

}