View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.custom.calendar;
20  
21  import javax.faces.component.UIComponent;
22  import javax.faces.context.FacesContext;
23  
24  /**
25   * Provide a bridge between the java.util.Date instance used by a component 
26   * that receive date/time values and the "business" value used to represent
27   * the value.
28   * 
29   * @since 1.1.10
30   * @author Leonardo Uribe (latest modification by $Author: lu4242 $)
31   * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (miƩ, 03 sep 2008) $
32   */
33  public interface DateBusinessConverter
34  {
35      /**
36       * Convert the java.util.Date instance calculated from submittedValue, 
37       * so the resulting object will be used later as the converted value 
38       * and validation. 
39       * 
40       * @param context
41       * @param component
42       * @param value
43       * @return
44       */
45      public Object getBusinessValue(FacesContext context,
46                         UIComponent component,
47                         java.util.Date value);
48  
49      /**
50       * Used to retrieve the value stored in the business bean and convert 
51       * it in a representation that the component (t:inputCalendar and 
52       * t:inputDate for example)using this class can manipulate. 
53       *  
54       * @param context
55       * @param component
56       * @param value
57       * @return
58       */
59      public java.util.Date getDateValue(FacesContext context,
60                         UIComponent component,
61                         Object value);
62  }