com.hcl.domino.BuildVersionInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * 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 .
 *
 * 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 com.hcl.domino;

/**
 * Version information about local or remote environments
 */
public interface BuildVersionInfo {
  /**
   * Returns the Fixpack/feature version installed on machine
   *
   * @return fixpack/feature version
   */
  int getFixpackNumber();

  /**
   * Returns the Hotfixes installed on machine
   *
   * @return hotfixes
   */
  int getHotfixNumber();

  /**
   * Returns the major version identifier
   *
   * @return identifier
   */
  int getMajorVersion();

  /**
   * Returns the minor version identifier
   *
   * @return identifier
   */
  int getMinorVersion();

  /**
   * Returns the Maintenance Release identifier
   *
   * @return identifier
   */
  int getQMRNumber();

  /**
   * Returns the Maintenance Update identifier
   *
   * @return identifier
   */
  int getQMUNumber();

  /**
   * Returns whether this is a non-production style build (internal only)
   *
   * @return true if non-production build
   */
  boolean isNonProductionBuild();
  
  /**
   * Determines whether the build version is at least a Domino version number.
   * 
   * Note: this is expected to check only number values, and does not take into
   * account release dates. For example, version 12.0.0 is considered "newer"
   * than 11.0.1FP4 despite coming out several months previous.
   * 
   * @param majorVersion the {@link #getMajorVersion() major version} to check
   * @param minorVersion the {@link #getMinorVersion() minor version} to check
   * @param qmrNumber the {@link #getQMRNumber() QMR version} to check
   * @param qmuNumber the {@link #getQMUNumber() QMU number} to check
   * @param hotfixNumber the {@link #getHotfixNumber() hotfix number} to check
   * @return {@code true} if this build version represents a version considered
   *         the same or higher than the provided values; {@code false} otherwise
   * @since 1.1.1
   */
  boolean isAtLeast(int majorVersion, int minorVersion, int qmrNumber, int qmuNumber, int hotfixNumber);

  /**
   * This function returns the "major" portion of the build number of the Domino or
   * Notes executable running on the system where the specified database resides.
   * Use this information to determine what Domino or Notes release is running on a given system.
   * The database handle input may represent a local database, or a database that resides
   * on a Lotus Domino Server.

   * 

   * Domino or Notes Release 1.0 (all preliminary and final versions) are build numbers 1 to 81.

   * Domino or Notes Release 2.0 (all preliminary and final versions) are build numbers 82 to 93.

   * Domino or Notes Release 3.0 (all preliminary and final versions) are build numbers 94 to 118.

   * Domino or Notes Release 4.0 (all preliminary and final versions) are build numbers 119 to 136.

   * Domino or Notes Release 4.1 (all preliminary and final versions) are build number 138.

   * Domino or Notes Release 4.5 (all preliminary and final versions) are build number 140 - 145.

   * Domino or Notes Release 4.6 (all preliminary and final versions) are build number 147.

   * Domino or Notes Release 5.0 Beta 1 is build number 161.

   * Domino or Notes Release 5.0 Beta 2 is build number 163.

   * Domino or Notes Releases 5.0 - 5.0.11 are build number 166.

   * Domino or Notes Release Rnext Beta 1 is build number 173.

   * Domino or Notes Release Rnext Beta 2 is build number 176.

   * Domino or Notes Release Rnext Beta 3 is build number 178.

   * Domino or Notes Release Rnext Beta 4 is build number 179.

   * Domino or Notes 6  Pre-release 1 is build number 183.

   * Domino or Notes 6  Pre-release 2 is build number 185.

   * Domino or Notes 6  Release Candidate is build number 190.

   * Domino or Notes 6 - 6.0.2 are build number 190.

   * Domino or Notes 6.0.3 - 6.5 are build numbers 191 to 194.

   * Domino or Notes 7.0 Beta 2 is build number 254.

   * Domino or Notes 9.0 is build number 400.

   * Domino or Notes 9.0.1 is build number 405.

   * 
   * @return build number
   */
  int getBuildNumber();
  
}