org.efaps.admin.datamodel.IAttributeType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2003 - 2012 The eFaps Team
 *
 * Licensed 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.
 *
 * Revision:        $Rev: 7483 $
 * Last Changed:    $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
 * Last Changed By: $Author: [email protected] $
 */

package org.efaps.admin.datamodel;

import java.sql.SQLException;
import java.util.List;

import org.efaps.db.query.CachedResult;
import org.efaps.db.wrapper.SQLInsert;
import org.efaps.db.wrapper.SQLUpdate;
import org.efaps.util.EFapsException;

/**
 * Classes which implements this interface are used to handle the mapping of
 * attributes between eFaps and the database.
 *
 * @author The eFaps Team
 * @version $Id: IAttributeType.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public interface IAttributeType
{
    /**
     * The method prepares the statement for update the object in the database.
     *
     * @param _update       SQL update statement
     * @param _attribute    attribute which is updated
     * @param _values       new object value to set; values are localized and
     *                      are coming from the user interface
     * @throws SQLException if preparation for the update failed
     */
    void prepareUpdate(final SQLUpdate _update,
                       final Attribute _attribute,
                       final Object... _values)
        throws SQLException;

    /**
     * The method prepares the statement for insert the object in the database.
     *
     * @param _insert       SQL insert statement
     * @param _attribute    attribute which is inserted
     * @param _values       new object value to set; values are localized and
     *                      are coming from the user interface
     * @throws SQLException if preparation for the insert failed
     */
    void prepareInsert(final SQLInsert _insert,
                       final Attribute _attribute,
                       final Object... _values)
        throws SQLException;

    /**
     * Method is used to read the values, retrieved from an JDBC result set and
     * put into the given parameter _objectList. This is
     * necessary, because only in the different instances of this interface
     * it can be determined what to do with the objects from the database. e.g.
     * in case of DateTimeType the values will be cased into a DateTime Object
     * and in case of a PersonLinkType a Person or Role instance will be
     * returned. This method is called from the {@link org.efaps.db.PrintQuery}.
     *
     * @param _attribute    related attribute which is read
     * @param _objectList   list of objects from the eFaps Database
     * @return Object as needed for eFaps
     * @throws EFapsException on error
     */
    Object readValue(final Attribute _attribute,
                     final List