View Javadoc
1   /*
2    * Copyright 2007-2008 The Kuali Foundation
3    * 
4    * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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  package org.kuali.ole.sys.document;
17  
18  import org.kuali.rice.core.api.util.type.KualiDecimal;
19  
20  /**
21   * Any class that implements this interface should provide a document total.
22   */
23  public interface AmountTotaling {
24    
25      /**
26       * This method returns the total dollar amount for the document.
27       * 
28       * @return The total dollar amount as a KualiDecimal object instance.
29       */
30      public KualiDecimal getTotalDollarAmount();
31  }