IConfigureServiceUIService.java

/*
 *  Copyright (c) 2005-2009, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 *  WSO2 Inc. licenses this file to you under the Apache License,
 *  Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 *
 */
package org.wso2.carbon.registry.admin.api.governance;

import org.wso2.carbon.registry.core.exceptions.RegistryException;

/**
 * This provides functionality to configure the user interface that is available for managing
 * services through the Management Console.
 */
public interface IConfigureServiceUIService extends IManageServicesService {

    /**
     * Method to obtain the current service UI configuration.
     *
     * @return the configuration of the service UI in XML format.
     *
     * @throws RegistryException if the operation failed.
     */
    String getServiceConfiguration() throws RegistryException;

    /**
     * Method to save the updated service UI configuration to the registry.
     *
     * @param update the updated service UI configuration.
     *
     * @return whether the operation was successful or not.
     * @throws RegistryException if the operation failed during the update.
     */
    boolean saveServiceConfiguration(String update) throws RegistryException;

}