1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski package com.sun.star.report;
24*b1cdbd2cSJim Jagielski 
25*b1cdbd2cSJim Jagielski /**
26*b1cdbd2cSJim Jagielski  * Functions are statefull computation components.
27*b1cdbd2cSJim Jagielski  *
28*b1cdbd2cSJim Jagielski  * Functions are allowed to have a state, but are considered
29*b1cdbd2cSJim Jagielski  * immutable (the same is true for expressions). Functions are
30*b1cdbd2cSJim Jagielski  * allowed to update their state on every call to 'advance', which
31*b1cdbd2cSJim Jagielski  * signals, that the cursor has been moved.
32*b1cdbd2cSJim Jagielski  *
33*b1cdbd2cSJim Jagielski  * Functions have no way to 'reset' their state, if a reset is needed,
34*b1cdbd2cSJim Jagielski  * the report engine is urged to query a new instance from the ReportAddin.
35*b1cdbd2cSJim Jagielski  */
36*b1cdbd2cSJim Jagielski public interface ReportFunction extends ReportExpression
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski 
advance(DataRow row)39*b1cdbd2cSJim Jagielski     public ReportFunction advance(DataRow row);
40*b1cdbd2cSJim Jagielski }
41