Package org.kuali.coeus.sys.api.vc

Interface VersionNumberService

public interface VersionNumberService

Method Summary

Modifier and Type	Method	Description
boolean	equalTo(String version)	Checks if the version is equal to the version returned from getVersion().
String	getVersion()	Retrieves the version number of the Kuali Coeus Application.
boolean	greaterThan(String version)	Checks if the version is greater than the version returned from getVersion().
boolean	lessThan(String version)	Checks if the version is less than the version returned from getVersion().

Method Details

getVersion

String getVersion()

Retrieves the version number of the Kuali Coeus Application. This method should return a String that represents a semantically versioned number and in accordance to the maven artifact versioning rules.

Returns:

a version number. Will not return null or a blank string.

Throws:

IllegalStateException - if the version number is blank. This represents a system misconfiguration

lessThan

boolean lessThan(String version)

Checks if the version is less than the version returned from getVersion().

Parameters:

version - the version to check. cannot be blank.

Throws:

IllegalArgumentException - if the version is blank

greaterThan

boolean greaterThan(String version)

Checks if the version is greater than the version returned from getVersion().

Parameters:

version - the version to check. cannot be blank.

Throws:

IllegalArgumentException - if the version is blank

equalTo

boolean equalTo(String version)

Checks if the version is equal to the version returned from getVersion().

Parameters:

version - the version to check. cannot be blank.

Throws:

IllegalArgumentException - if the version is blank