eu.erasmuswithoutpaper.registryclient

Class ApiSearchConditions

java.lang.Object

eu.erasmuswithoutpaper.registryclient.ApiSearchConditions

public class ApiSearchConditions
extends Object

A set of conditions to test against when using RegistryClient.findApi(ApiSearchConditions).

It describes a set of conditions to test against API entries found in the Registry's catalogue catalogue response (in its <apis-implemented> section). Usually you will use this class in conjunction with RegistryClient.findApi(ApiSearchConditions) and RegistryClient.findApis(ApiSearchConditions) methods.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
ApiSearchConditions() Create an empty set of conditions.

Method Summary

Modifier and Type	Method and Description
String	getRequiredHei() Get the SCHAC ID of the HEI which needs to be covered by the API, as it has been previously provided via setRequiredHei(String).
String	getRequiredLocalName() Get the required API element local name, as it has been previously provided via setApiClassRequired(String, String).
String	getRequiredMinVersion() Get the minimum required API version, as it has been previously provided via setMinVersionRequired(String).
String	getRequiredNamespaceUri() Get the required API element namespace URI, as it has been previously provided via setApiClassRequired(String, String).
ApiSearchConditions	setApiClassRequired(String namespaceUri, String localName) Require the API to be of a given class.
ApiSearchConditions	setApiClassRequired(String namespaceUri, String localName, String minVersionRequired) Require the API to be of a given class, and to have a version attribute greater or equal to the provided one.
ApiSearchConditions	setMinVersionRequired(String minVersionRequired) Require the API entry to have a version attribute greater or equal to the provided one.
ApiSearchConditions	setRequiredHei(String heiId) Require the API entry to cover a particular HEI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiSearchConditions

public ApiSearchConditions()

Create an empty set of conditions. (Use set* methods to add your conditions.)

Method Detail

getRequiredHei

public String getRequiredHei()

Get the SCHAC ID of the HEI which needs to be covered by the API, as it has been previously provided via setRequiredHei(String).

Returns:

Either String, or null if no such requirement has been set.

getRequiredLocalName

public String getRequiredLocalName()

Get the required API element local name, as it has been previously provided via setApiClassRequired(String, String).

Returns:

Either String, or null if no such requirement has been set.

getRequiredMinVersion

public String getRequiredMinVersion()

Get the minimum required API version, as it has been previously provided via setMinVersionRequired(String).

Returns:

Either String, or null if no such requirement has been set.

getRequiredNamespaceUri

public String getRequiredNamespaceUri()

Get the required API element namespace URI, as it has been previously provided via setApiClassRequired(String, String).

Returns:

Either String, or null if no such requirement has been set.

setApiClassRequired

public ApiSearchConditions setApiClassRequired(String namespaceUri,
                                               String localName)

Require the API to be of a given class.

Parameters:

namespaceUri - Required namespaceURI of the API entry element, or null if no requirements should be set.

localName - Required localName of the API entry element, or null if no requirements should be set.

Returns:

This object.

setApiClassRequired

public ApiSearchConditions setApiClassRequired(String namespaceUri,
                                               String localName,
                                               String minVersionRequired)

Require the API to be of a given class, and to have a version attribute greater or equal to the provided one.

This method is a shorthand which allows you to call setApiClassRequired(String, String) and setMinVersionRequired(String) both in one call.

Parameters:

namespaceUri - Required namespaceURI of the API entry element, or null if no requirements should be set.

localName - Required localName of the API entry element, or null if no requirements should be set.

minVersionRequired - as described in setMinVersionRequired(String).

Returns:

This object.

Since:

1.2.0

setMinVersionRequired

public ApiSearchConditions setMinVersionRequired(String minVersionRequired)

Require the API entry to have a version attribute greater or equal to the provided one.

Both versions (the one in the matched DOM attribute, and the one provided in this method's parameter) MUST be in the X.Y.Z format, where X, Y and Z are non-negative integers. If you believe that the API entry you are looking for does not follow this versioning schema, then you SHOULD NOT use this method, and verify version attribute yourself.

Note, that the major version of most EWP APIs is also included in the API's namespace URI. So, for example, if you're upgrading from "3.5.1" to "4.0.0", then you will often also be required to change the namespace URI provided in setApiClassRequired(String, String).

Parameters:

minVersionRequired - A minimum required version string, e.g. "1.3.0", or null if no requirements should be set.

Returns:

This object.

setRequiredHei

public ApiSearchConditions setRequiredHei(String heiId)

Require the API entry to cover a particular HEI.

Parameters:

heiId - SCHAC ID of the HEI, or null if no requirements should be set.

Returns:

This object.