com.alkacon.acacia.shared.rpc.I_ContentService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acacia-editor-client Show documentation

A GWT based resource editor. This component is used as a part of OpenCms, an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 2.1

Show newest version

/*
 * This library is part of the Acacia Editor -
 * an open source inline and form based content editor for GWT.
 *
 * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package com.alkacon.acacia.shared.rpc;

import com.alkacon.acacia.shared.ContentDefinition;
import com.alkacon.acacia.shared.Entity;
import com.alkacon.acacia.shared.EntityHtml;
import com.alkacon.acacia.shared.ValidationResult;

import java.util.List;

import com.google.gwt.user.client.rpc.RemoteService;

/**
 * The content service used to load and persist entity and type information.
 * 
 * Implement this on the server side.

 */
public interface I_ContentService extends RemoteService {

    /**
     * Loads the content definition for a given entity.

     * 
     * @param entityId the entity id/URI
     * 
     * @return the content type definition
     * 
     * @throws Exception if something goes wrong processing the request
     */
    ContentDefinition loadContentDefinition(String entityId) throws Exception;

    /**
     * Saves the given entities and returns a validation result in case of invalid entities.

     * Invalid entities will not be saved.

     * 
     * @param entities the entities to save
     * 
     * @return the validation result in case of invalid entities
     * 
     * @throws Exception if something goes wrong processing the request
     */
    ValidationResult saveEntities(List entities) throws Exception;

    /**
     * Saves the given entity and returns a validation result in case of invalid entities.

     * Invalid entities will not be saved.

     * 
     * @param entity the entity to save
     * 
     * @return the validation result in case of invalid entities
     * 
     * @throws Exception if something goes wrong processing the request
     */
    ValidationResult saveEntity(Entity entity) throws Exception;

    /**
     * Retrieves the updated entity HTML representation.

     * The entity data will be validated but not persisted on the server.

     * 
     * @param entity the entity
     * @param contextUri the context URI
     * @param htmlContextInfo information about the HTML context
     * 
     * @return the HTML representation including the validation result
     * 
     * @throws Exception if something goes wrong processing the request
     */
    EntityHtml updateEntityHtml(Entity entity, String contextUri, String htmlContextInfo) throws Exception;

    /**
     * Validates the given entities and returns maps of error and warning messages in case of invalid attributes.
     * 
     * @param changedEntities the entities to validate
     * 
     * @return the validation result
     * 
     * @throws Exception if something goes wrong processing the request
     */
    ValidationResult validateEntities(List changedEntities) throws Exception;
}