org.efaps.admin.datamodel.ui.IUIProvider Maven / Gradle / Ivy

Go to download

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.

The newest version!

/*
 * Copyright 2003 - 2013 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$
 * Last Changed:    $Date$
 * Last Changed By: $Author$
 */

package org.efaps.admin.datamodel.ui;

import org.efaps.util.EFapsException;

/**
 * TODO comment!
 *
 * @author The eFaps Team
 * @version $Id$
 */
public interface IUIProvider
{

    /**
     * Get the Value for the UserInterface.
     * @param _uiValue  the UIValue the value for the UserInterface is wanted for
     * @return Object   for the UserInterface
     * @throws EFapsException on any error
     */
    Object getValue(final UIValue _uiValue)
        throws EFapsException;

    /**
     * Method is used to validate a value given from an UserInterface.
     *
     * @param _uiValue UIValue to validate
     * @return if the given value is valid for this type null must be returned,
     *         else the message that will be shown to the user as a snipplet
     *         must be returned
     * @throws EFapsException on error
     */
    String validateValue(final UIValue _uiValue)
        throws EFapsException;

    /**
     * Method is used to transform a object retrieved from an FieldValue Event into
     * the form specified by the UIProvider.
     *
     * @param _uiValue UIValue to transform
     * @param _object the object to transform
     * @return the transformed value
     * @throws EFapsException on error
     */
    Object transformObject(final UIValue _uiValue,
                           final Object _object)
        throws EFapsException;

}