it.tidalwave.accounting.model.spi.ProjectSpi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of it-tidalwave-accounting-model Show documentation
This module implements the data model.
There is a newer version: 1.0-ALPHA-8
Show newest version
/*
 * #%L
 * *********************************************************************************************************************
 *
 * blueHour
 * http://bluehour.tidalwave.it - git clone [email protected]:tidalwave/bluehour-src.git
 * %%
 * Copyright (C) 2013 - 2015 Tidalwave s.a.s. (http://tidalwave.it)
 * %%
 * *********************************************************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); 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.
 *
 * *********************************************************************************************************************
 *
 * $Id$
 *
 * *********************************************************************************************************************
 * #L%
 */package it.tidalwave.accounting.model.spi;

import javax.annotation.Nonnull;
import java.time.Duration;
import java.time.LocalDate;
import it.tidalwave.accounting.model.Project;
import it.tidalwave.accounting.model.types.Money;

/***********************************************************************************************************************
 *
 * @author  Fabrizio Giudici
 * @version $Id$
 *
 **********************************************************************************************************************/
public interface ProjectSpi extends Project
  {
    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public String getName();

    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public String getNumber();
    
    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public String getNotes();

    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public LocalDate getStartDate();
    
    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public LocalDate getEndDate();

    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public Duration getDuration();
    
    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public Status getStatus();
    
    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public Money getEarnings();
    
    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public Money getBudget();
    
    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public Money getInvoicedEarnings();
    
    /*******************************************************************************************************************
     *
     * 
     * 
     ******************************************************************************************************************/
    @Nonnull
    public Money getHourlyRate();
  }