RulesManagerRemoteService.java

/* (c) 2014 Open Source Geospatial Foundation - all rights reserved
 * This code is licensed under the GPL 2.0 license, available at the root
 * application directory.
 */

package org.geoserver.geofence.gui.client.service;

import java.util.List;

import com.extjs.gxt.ui.client.data.PagingLoadResult;
import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;

import org.geoserver.geofence.gui.client.ApplicationException;
import org.geoserver.geofence.gui.client.model.RuleModel;
import org.geoserver.geofence.gui.client.model.data.LayerAttribUI;
import org.geoserver.geofence.gui.client.model.data.LayerCustomProps;
import org.geoserver.geofence.gui.client.model.data.LayerDetailsInfo;
import org.geoserver.geofence.gui.client.model.data.LayerLimitsInfo;
import org.geoserver.geofence.gui.client.model.data.LayerStyle;


/**
 * The Interface RulesManagerRemoteService.
 */
@RemoteServiceRelativePath("RulesManagerRemoteService")
public interface RulesManagerRemoteService extends RemoteService
{

    /**
     * Gets the rules.
     *
     * @param config
     *            the config
     * @param full
     *            the full
     * @return the rules
     * @throws ApplicationException
     *             the application exception
     */
    public PagingLoadResult<RuleModel> getRules(int offset, int limit, boolean full) throws ApplicationException;


    /**
     * Save rule
     *
     * @param rule
     *            the rule
     * @param callback
     *            the callback
     */
    public void saveRule(RuleModel rules) throws ApplicationException;

    /**
     * Delete rule
     *
     * @param rule
     *            the rule
     * @param callback
     *            the callback
     */
    public void deleteRule(RuleModel rules) throws ApplicationException;

    /**
     * Find rule
     *
     * @param rule
     *            the rule
     * @param callback
     *            the callback
     * @return
     * @throws Exception
     * @throws ResourceNotFoundFault
     */
    public void findRule(RuleModel rules) throws ApplicationException, Exception;

    /**
     * Shifts the priority of the rules having <TT>priority >= priorityStart</TT>
     * down by <TT>offset</TT>.
     *
     * @return the number of rules updated.
     */
    public void shift(long priorityStart, long offset) throws ApplicationException;

    /**
     * Swaps the priorities of two rules.
     */
    public void swap(long id1, long id2) throws ApplicationException;

    /**
     * Save all rules.
     *
     * @param rules
     *            the rules
     * @throws ApplicationException
     *             the application exception
     */
    public void saveAllRules(List<RuleModel> rules) throws ApplicationException;

    /**
     * Gets the layer custom props.
     *
     * @param config
     *            the config
     * @param rule
     *            the rule
     * @return the layer custom props
     * @throws ApplicationException
     *             the application exception
     */
//    public PagingLoadResult<LayerCustomProps> getLayerCustomProps(int offset, int limit, Rule rule)
//        throws ApplicationException;

    /**
     * Sets the details props.
     *
     * @param ruleId
     *            the rule id
     * @param customProps
     *            the custom props
     * @throws ApplicationException
     *             the application exception
     */
    public void setDetailsProps(Long ruleId, List<LayerCustomProps> customProps) throws ApplicationException;

    /**
     * Gets the layer attributes.
     *
     * @param rule
     *            the rule
     * @return the layer attributes
     * @throws ApplicationException
     *             the application exception
     */
    public List<LayerAttribUI> getLayerAttributes(RuleModel rule) throws ApplicationException;

    /**
     * @param ruleId
     * @param layerAttributes
     * @throws ApplicationException
     */
    public void setLayerAttributes(Long ruleId, List<LayerAttribUI> layerAttributes) throws ApplicationException;

    /**
     * @param layerDetailsForm
     * @return LayerDetailsInfo
     * @throws ApplicationException
     */
    public LayerDetailsInfo saveLayerDetailsInfo(LayerDetailsInfo layerDetailsForm, List<LayerStyle> layerStyles)
        throws ApplicationException;

    /**
     * @param rule
     * @return LayerDetailsForm
     * @throws ApplicationException
     */
    public LayerDetailsInfo getLayerDetailsInfo(RuleModel rule) throws ApplicationException;

    /**
     * @param layerLimitsForm
     * @return LayerLimitsInfo
     * @throws ApplicationException
     */
    public LayerLimitsInfo saveLayerLimitsInfo(LayerLimitsInfo layerLimitsForm) throws ApplicationException;

    /**
     * @param rule
     * @return LayerLimitsInfo
     * @throws ApplicationException
     */
    public LayerLimitsInfo getLayerLimitsInfo(RuleModel rule) throws ApplicationException;

}