FssApiVersion (anywhere-fss-sdk)

java.lang.Object
- java.lang.Enum<FssApiVersion>
- - com.hds.hcpaw.fss.api.version.FssApiVersion

All Implemented Interfaces:

com.hds.commons.version.VersionKey<FssApiVersion>, java.io.Serializable, java.lang.Comparable<FssApiVersion>
```
public enum FssApiVersion
extends java.lang.Enum<FssApiVersion>
implements com.hds.commons.version.VersionKey<FssApiVersion>
```
The latest version of the HCP Anywhere FSS API.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`UNSET`
`VERSION_211`
`VERSION_300`
`VERSION_303`
`VERSION_310`
`VERSION_400`
`VERSION_410`
`VERSION_420`
`VERSION_430`
`VERSION_432`
`VERSION_440`
`VERSION_450`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FssApiVersion`	`getLatest()` Returns the latest FssApiVersion.
`static FssApiVersion`	`getOldest()` Returns the oldest FssApiVersion
`static java.util.Set<FssApiVersion>`	`getSupportedVersionSet(FssApiVersion highestSupportedVersion)` Returns all versions except `UNSET` that are less than or equal to the specified version.
`static java.util.Set<FssApiVersion>`	`getSupportedVersionSet(FssApiVersion lowestSupportedVersion, FssApiVersion highestSupportedVersion)` Returns all versions between the specified two versions, inclusive.
`static FssApiVersion`	`getValueFromVersionString(java.lang.String versionString)` Returns the result of converting the specified versionString into a FssApiVersion.
`static java.util.Set<FssApiVersion>`	`getValuesFromStringSet(java.util.Set<java.lang.String> versionStrings)` Returns a set of FssApiVersion, each corresponding to an element in the provided set of strings.
`com.hds.commons.version.Version`	`getVersion()` Returns this object represented as a `Version`.
`java.lang.String`	`getVersionString()` Returns the String representation of this FssApiVersion version number.
`boolean`	`isGreaterThan(FssApiVersion version)` Returns true if this version is greater than the specified version; false otherwise.
`boolean`	`isGreaterThanOrEqualTo(FssApiVersion version)` Returns true if this version is greater than or equal to the specified version; false otherwise.
`boolean`	`isLessThan(FssApiVersion version)` Returns true if this version is less than the specified version; false otherwise.
`boolean`	`isLessThanOrEqualTo(FssApiVersion version)` Returns true if this version is less than or equal to the specified version; false otherwise.
`java.lang.String`	`toString()` Returns the version string for this object.
`static FssApiVersion`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static FssApiVersion[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable
compareTo

- Enum Constant Detail
  - UNSET
```
public static final FssApiVersion UNSET
```
  - VERSION_211
```
public static final FssApiVersion VERSION_211
```
  - VERSION_300
```
public static final FssApiVersion VERSION_300
```
  - VERSION_303
```
public static final FssApiVersion VERSION_303
```
  - VERSION_310
```
public static final FssApiVersion VERSION_310
```
  - VERSION_400
```
public static final FssApiVersion VERSION_400
```
  - VERSION_410
```
public static final FssApiVersion VERSION_410
```
  - VERSION_420
```
public static final FssApiVersion VERSION_420
```
  - VERSION_430
```
public static final FssApiVersion VERSION_430
```
  - VERSION_432
```
public static final FssApiVersion VERSION_432
```
  - VERSION_440
```
public static final FssApiVersion VERSION_440
```
  - VERSION_450
```
public static final FssApiVersion VERSION_450
```
- Method Detail
  - values
```
public static FssApiVersion[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (FssApiVersion c : FssApiVersion.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FssApiVersion valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getLatest
```
public static FssApiVersion getLatest()
```
    Returns the latest FssApiVersion.
    
    Returns:
    
    the latest (most recent) FssApiVersion
  - getOldest
```
public static FssApiVersion getOldest()
```
    Returns the oldest FssApiVersion
    
    Returns:
    
    the oldest FssApiVersion
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(FssApiVersion version)
```
    Returns true if this version is greater than or equal to the specified version; false otherwise.
    
    Specified by:
    
    isGreaterThanOrEqualTo in interface com.hds.commons.version.VersionKey<FssApiVersion>
  - isGreaterThan
```
public boolean isGreaterThan(FssApiVersion version)
```
    Returns true if this version is greater than the specified version; false otherwise.
    
    Specified by:
    
    isGreaterThan in interface com.hds.commons.version.VersionKey<FssApiVersion>
  - isLessThanOrEqualTo
```
public boolean isLessThanOrEqualTo(FssApiVersion version)
```
    Returns true if this version is less than or equal to the specified version; false otherwise.
    
    Specified by:
    
    isLessThanOrEqualTo in interface com.hds.commons.version.VersionKey<FssApiVersion>
  - isLessThan
```
public boolean isLessThan(FssApiVersion version)
```
    Returns true if this version is less than the specified version; false otherwise.
    
    Specified by:
    
    isLessThan in interface com.hds.commons.version.VersionKey<FssApiVersion>
  - getVersionString
```
public java.lang.String getVersionString()
```
    Returns the String representation of this FssApiVersion version number.
    
    Specified by:
    
    getVersionString in interface com.hds.commons.version.VersionKey<FssApiVersion>
    
    Returns:
    
    a dot (.) separated list of numbers that together represent this version number. The first two numbers (that is, before the first two dots) are the major and minor version numbers.
  - getVersion
```
public com.hds.commons.version.Version getVersion()
```
    Returns this object represented as a Version.
  - getValueFromVersionString
```
public static FssApiVersion getValueFromVersionString(java.lang.String versionString)
```
    Returns the result of converting the specified versionString into a FssApiVersion.
    
    Parameters:
    
    versionString - a dot (.) separated list of numbers
    
    Returns:
    
    the FssApiVersion represented by the versionString
  - getValuesFromStringSet
```
public static java.util.Set<FssApiVersion> getValuesFromStringSet(java.util.Set<java.lang.String> versionStrings)
```
    Returns a set of FssApiVersion, each corresponding to an element in the provided set of strings. Each element that cannot be parsed into a valid version will be returned as UNSET. See getValueFromVersionString(String) for how parsing of individual versions is accomplished.
    
    Parameters:
    
    versionStrings - the set of strings to convert to a set of FssApiVersions
    
    Returns:
    
    the set of FssApiVersions produced from the provided set of Strings
  - toString
```
public java.lang.String toString()
```
    Returns the version string for this object.
    
    Overrides:
    
    toString in class java.lang.Enum<FssApiVersion>
    
    Returns:
    
    the version string representation of this object.
    
    See Also:
    
    getVersionString()
  - getSupportedVersionSet
```
public static java.util.Set<FssApiVersion> getSupportedVersionSet(FssApiVersion highestSupportedVersion)
```
    Returns all versions except UNSET that are less than or equal to the specified version.
    
    Parameters:
    
    highestSupportedVersion - only versions that are less than or equal to this version are returned
    
    Returns:
    
    the Set of all FssApiVerions that are less than highestSupportedVersions except for UNSET
  - getSupportedVersionSet
```
public static java.util.Set<FssApiVersion> getSupportedVersionSet(FssApiVersion lowestSupportedVersion,
                                                                  FssApiVersion highestSupportedVersion)
```
    Returns all versions between the specified two versions, inclusive.
    
    Parameters:
    
    lowestSupportedVersion - only versions that are greater than or equal to this version are returned
    
    highestSupportedVersion - only versions that are less than or equal to this version are returned
    
    Returns:
    
    the Set of all FssApiVerions that are greater than or equal to the lowestSupportedVersion and less than highestSupportedVersion

Enum FssApiVersion

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Comparable

Enum Constant Detail

UNSET

VERSION_211

VERSION_300

VERSION_303

VERSION_310

VERSION_400

VERSION_410

VERSION_420

VERSION_430

VERSION_432

VERSION_440

VERSION_450

Method Detail

values

valueOf

getLatest

getOldest

isGreaterThanOrEqualTo

isGreaterThan

isLessThanOrEqualTo

isLessThan

getVersionString

getVersion

getValueFromVersionString

getValuesFromStringSet

toString

getSupportedVersionSet

getSupportedVersionSet