com.alkacon.vie.shared.I_Entity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vie-gwt-server Show documentation
A GWT wrapper for the Vie JavaScript library. 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.
The newest version!
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * 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
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 * 
 * 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.vie.shared;

import java.util.List;

/**
 * Interface describing an entity.
 */
public interface I_Entity {

    /**
     * Adds the given attribute value.

     *
     * @param attributeName the attribute name
     * @param value the attribute value
     */
    void addAttributeValue(String attributeName, I_Entity value);

    /**
     * Adds the given attribute value.

     *
     * @param attributeName the attribute name
     * @param value the attribute value
     */
    void addAttributeValue(String attributeName, String value);

    /**
     * Creates a deep copy of this entity.

     * 
     * @param entityId the id of the new entity, if null a generic id will be used
     * 
     * @return the entity copy
     */
    I_Entity createDeepCopy(String entityId);

    /**
     * Returns an attribute.

     *
     * @param attributeName the attribute name
     *
     * @return the attribute value
     */
    I_EntityAttribute getAttribute(String attributeName);

    /**
     * Returns all entity attributes.

     * 
     * @return the entity attributes
     */
    List getAttributes();

    /**
     * Returns the entity id/URI.

     *
     * @return the id/URI
     */
    String getId();

    /**
     * Returns the entity type name.

     * 
     * @return the entity type name
     */
    String getTypeName();

    /**
     * Returns if the entity has the given attribute.

     *
     * @param attributeName the attribute name
     *
     * @return true if the entity has the given attribute
     */
    boolean hasAttribute(String attributeName);

    /**
     * Inserts a new attribute value at the given index.

     * 
     * @param attributeName the attribute name
     * @param value the attribute value
     * @param index the value index
     */
    void insertAttributeValue(String attributeName, I_Entity value, int index);

    /**
     * Inserts a new attribute value at the given index.

     * 
     * @param attributeName the attribute name
     * @param value the attribute value
     * @param index the value index
     */
    void insertAttributeValue(String attributeName, String value, int index);

    /**
     * Removes the given attribute.

     *
     * @param attributeName the attribute name
     */
    void removeAttribute(String attributeName);

    /**
     * Removes the attribute without triggering any change events.

     *
     * @param attributeName the attribute name
     */
    void removeAttributeSilent(String attributeName);

    /**
     * Removes a specific attribute value.

     * 
     * @param attributeName the attribute name
     * @param index the value index
     */
    void removeAttributeValue(String attributeName, int index);

    /**
     * Sets the given attribute value. Will remove all previous attribute values.

     *
     * @param attributeName the attribute name
     * @param value the attribute value
     */
    void setAttributeValue(String attributeName, I_Entity value);

    /**
     * Sets the given attribute value at the given index.

     * 
     * @param attributeName the attribute name
     * @param value the attribute value
     * @param index the value index
     */
    void setAttributeValue(String attributeName, I_Entity value, int index);

    /**
     * Sets the given attribute value. Will remove all previous attribute values.

     *
     * @param attributeName the attribute name
     * @param value the attribute value
     */
    void setAttributeValue(String attributeName, String value);

    /**
     * Sets the given attribute value at the given index.

     * 
     * @param attributeName the attribute name
     * @param value the attribute value
     * @param index the value index
     */
    void setAttributeValue(String attributeName, String value, int index);

    /**
     * Returns the JSON string representation of this entity.
     * 
     * @return the JSON string representation of this entity
     */
    String toJSON();
}