/*
 * $Id$
 *
 * This file is part of the Cloud Services Integration Platform (CSIP),
 * a Model-as-a-Service framework, API and application suite.
 *
 * 2012-2022, Olaf David and others, OMSLab, Colorado State University.
 *
 * OMSLab licenses this file to you under the MIT license.
 * See the LICENSE file in the project root for more information.
 */
package csip.api.server;

/**
 * ServiceAnnotation access.
 *
 * @author od
 */
public interface ServiceAnnotations {

  /**
   * Return the recommended polling interval for async calls in milliseconds.
   * @return the polling interval value in milliseconds
   */
  long getNextPoll();


  /**
   * Get the time until first poll for async calls in milliseconds.
   * @return time to first poll in milliseconds
   */
  long getFirstPoll();


  /**
   * Provide the service path name, e.g. 'weps/1.0'
   * @return the model service path
   */
  String getPath();


  /**
   * Get the service version.
   *
   * @return the service version as String
   */
  String getVersion();
  
  /**
   * Get the service name.
   * 
   * @return the service name.
   */
  String getName();

}