com.versionone.apiclient.interfaces.IV1Configuration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of VersionOne.SDK.Java.APIClient Show documentation

A library for custom Java development against the VersionOne Development Platform's REST API.

There is a newer version: 16.1.3

Show newest version

package com.versionone.apiclient.interfaces;

import com.versionone.apiclient.exceptions.APIException;
import com.versionone.apiclient.exceptions.ConnectionException;

/**
 * Interface to access to VersionOne server configuration
 */
public interface IV1Configuration {

    /**
     * Enumeration of tracking levels
     */
    public enum TrackingLevel {
        /**
         * Track Detail Estimate and ToDo at PrimaryWorkitem level only
         */
        On,
        /**
         * Track Detail Estimate and ToDo at Task/Test level only
         */
        Off,
        /**
         * Track Detail Estimate and ToDo at both the PrimaryWorkitem and the Task/Test levels
         */
        Mix
    }

    /**
     * Gets EffortTracking
     *
     * @return true if EffortTracking is enabled, false - otherwise.
     * @throws APIException if any problems occur with reading settings
     * @throws ConnectionException if any connection problems occur
     */
    boolean isEffortTracking() throws ConnectionException, APIException;

    /**
     * Gets level of Story tracking.
     *
     * @return Story tracking level
     * @throws APIException if any problems occur with reading settings
     * @throws ConnectionException if any connection problems occur
     */
    TrackingLevel getStoryTrackingLevel() throws ConnectionException, APIException;

    /**
     * Gets level of Defect tracking.
     *
     * @return Defect tracking level
     * @throws APIException if any problems occur with reading settings
     * @throws ConnectionException if any connection problems occur
     */
    TrackingLevel getDefectTrackingLevel() throws ConnectionException, APIException;

    /**
     * Gets maximum size of attachment file.
     *
     * @return maximum size
     * @throws APIException if any problems occur with building XML document
     * @throws ConnectionException if any connection problems occur
     */
    int getMaxAttachmentSize() throws ConnectionException, APIException;
}