org.camunda.bpm.engine.history.ReportResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-bpm-engine-api Show documentation

There is a newer version: 7.22.0

Show newest version

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.camunda.bpm.engine.history;

import org.camunda.bpm.engine.query.PeriodUnit;

/**
 * This interface defines basic methods for resulting reports.
 *
 * @author Roman Smirnov
 *
 */
public interface ReportResult {

  /**
   * Returns a period which specifies a time span within a year.
   *
   * The returned period must be interpreted in conjunction
   * with the returned {@link PeriodUnit} of {@link #getPeriodUnit()}.
   *
   * 
For example:
   * 
   *   {@link #getPeriodUnit()} returns {@link PeriodUnit#MONTH}
   *   
{@link #getPeriod()} returns 3
   * 
   *
   * The returned period 3 must be interpreted as
   * the third month of the year (i.e. it represents
   * the month March).
   *
   * If the {@link #getPeriodUnit()} returns {@link PeriodUnit#QUARTER},
   * then the returned period 3 must be interpreted as the third
   * quarter of the year.
   *
   * @return an integer representing span of time within a year
   */
  int getPeriod();

  /**
   * Returns the unit of the period.
   *
   * @return a {@link PeriodUnit}
   *
   * @see #getPeriod()
   */
  PeriodUnit getPeriodUnit();

}