1   /*
2    * Copyright 2003 - 2013 The eFaps Team
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   * Revision:        $Rev$
17   * Last Changed:    $Date$
18   * Last Changed By: $Author$
19   */
20  
21  package org.efaps.admin.datamodel.ui;
22  
23  import org.efaps.util.EFapsException;
24  
25  /**
26   * TODO comment!
27   *
28   * @author The eFaps Team
29   * @version $Id$
30   */
31  public interface IUIProvider
32  {
33  
34      /**
35       * Get the Value for the UserInterface.
36       * @param _uiValue  the UIValue the value for the UserInterface is wanted for
37       * @return Object   for the UserInterface
38       * @throws EFapsException on any error
39       */
40      Object getValue(final UIValue _uiValue)
41          throws EFapsException;
42  
43      /**
44       * Method is used to validate a value given from an UserInterface.
45       *
46       * @param _uiValue UIValue to validate
47       * @return if the given value is valid for this type null must be returned,
48       *         else the message that will be shown to the user as a snipplet
49       *         must be returned
50       * @throws EFapsException on error
51       */
52      String validateValue(final UIValue _uiValue)
53          throws EFapsException;
54  
55      /**
56       * Method is used to transform a object retrieved from an FieldValue Event into
57       * the form specified by the UIProvider.
58       *
59       * @param _uiValue UIValue to transform
60       * @param _object the object to transform
61       * @return the transformed value
62       * @throws EFapsException on error
63       */
64      Object transformObject(final UIValue _uiValue,
65                             final Object _object)
66          throws EFapsException;
67  
68  }