org.llorllale.youtrack.api.ProjectTimeTracking Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of youtrack-api Show documentation
Fluent, object-oriented Java API for YouTrack.
The newest version!
/*
 * Copyright 2017 George Aristy
 *
 * 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.
 */

package org.llorllale.youtrack.api;

import java.io.IOException;
import java.util.stream.Stream;

import org.llorllale.youtrack.api.session.Login;
import org.llorllale.youtrack.api.session.UnauthorizedException;

/**
 * Access to a {@link Project project's} timetracking settings.
 *
 * Note: it is important that you first check whether timetracking is 
 * {@link #enabled() enabled} for the {@link Project}.
 * 
 * @author George Aristy ([email protected])
 * @see Issue#timetracking() 
 * @since 0.8.0
 */
public interface ProjectTimeTracking {
  /**
   * The parent {@link Project}.
   * 
   * @return the parent {@link Project}
   * @since 0.8.0
   */
  Project project();

  /**
   * Whether timetracking is enabled for the {@link Project} or not.
   * 
   * The determination is made by making sure that all these conditions are met:
   * 

   *   Timetracking is enabled for the project
   *   An estimation field has been configured
   *   A "time spent" field has been configured
   * 
   * 
   * @return {@code true} if timetracking is enabled for the {@link Project} according to the rules
   *     above, {@code false} otherwise
   * @throws IOException if the server is unavailable
   * @throws UnauthorizedException if the user's {@link Login} is not authorized to perform this
   *     operation
   * @since 0.8.0
   */
  boolean enabled() throws IOException, UnauthorizedException;

  /**
   * A stream of all {@link TimeTrackEntryType timetracking entry types}, if 
   * timetracking is {@link #enabled() enabled}.
   * 
   * @return a stream of all {@link TimeTrackEntryType timetracking entry types}
   * @throws IOException if the server is unavailable, or if timetracking is not 
   *     {@link #enabled() enabled} for this {@link Project}
   * @throws UnauthorizedException if the user's {@link Login} is not authorized to perform this
   *     operation
   * @since 0.8.0
   */
  Stream types() throws IOException, UnauthorizedException;
}