001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.progmodel.facets.value.bigdecimal;
021
022import org.apache.isis.core.metamodel.facetapi.Facet;
023
024public interface BigDecimalValueFacet extends Facet {
025
026    /**
027     * Maximum length of digits for this decimal (in other words, its precision).
028     * 
029     * <p>
030     * For example:
031     * <ul>
032     * <li><tt>12345.789</tt> has a length of 8 (and a {@link #getScale() scale} of 3)</li>
033     * <li><tt>12345</tt> has a length of 5 (and {@link #getScale() scale} of 0)</li>
034     * <li><tt>12345.0</tt> has a length of 6 (and {@link #getScale() scale} of 1)</li>
035     * </ul>
036     */
037    Integer getPrecision();
038
039    /**
040     * Same as {@link #getPrecision()}.
041     *
042     * @deprecated
043     */
044    @Deprecated
045    Integer getLength();
046
047    /**
048     * The number of digits to the right of the decimal place (fractional part) for this decimal.
049     * 
050     * <p>
051     * For example:
052     * <ul>
053     * <li><tt>12345.789</tt> has scale of 3 (and a {@link #getLength() length} of 8)</li>
054     * <li><tt>12345</tt> has a scale of 0 (and a {@link #getLength() length} of 5)</li>
055     * <li><tt>12345.0</tt> has a scale of 1 (and a {@link #getLength() length} of 6)</li>
056     * </ul>
057     */
058    Integer getScale();
059
060}