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.trinidad.model;
20  
21  /**
22   * Model that represents a bounded range, 0 <- value <- maximum if value > -1 and
23   * maximum > -1.  'value' or 'maximum' being -1 indicates that they are unknown.
24   * This model is used by the 'progress' components.
25   *
26   * @version $Name:  $ ($Revision: adfrt/faces/adf-faces-api/src/main/java/oracle/adf/view/faces/model/BoundedRangeModel.java#0 $) $Date: 10-nov-2005.19:08:49 $
27   */
28  
29  public abstract class BoundedRangeModel 
30  {
31    /**
32     * Gets the maximum value for this model.
33     * @return the maximum value. A return of -1 indicates that maximum is unknown.
34     */
35    public abstract long getMaximum();
36  
37    /**
38     * Gets the current value for this model.
39     * @return the current value. A return of -1 indicates that value is unknown.
40     */
41    public abstract long getValue();
42  }