cz.ues.platform.commons.uri

Interface UESURIConvertor

All Known Subinterfaces:

UESURIConvertor

@UESComponent
public interface UESURIConvertor

UESURIConvertor - this components support working with UESURI on platform.

Since:

UES6-00

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	getCanonicalURI(UESURI aUri) Returns canonical UESURI.
UESURI	getEvaluatedURI(UESURI aUri) Returns evaluated UESURI.
UESURI	getNormalizedURI(UESURI uri) Returns normalized UESURI.
boolean	isCanonical(UESURI aURI) Tests, whether is the UESURI in canonical form.
boolean	isEvaluated(UESURI aUri) Tests whether is the UESURI evaluated (expressions are resolved).
boolean	isNormalized(UESURI uri) Tests, whether is the UESURI in normalized form.

Method Detail

getCanonicalURI

UESURI getCanonicalURI(UESURI aUri)
throws UnsupportedOperationRTException

Returns canonical UESURI. Canonical form of UESURI is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Because UES Platform doesn't know anything about UESURI parts except territory part, these parts must already contain Id otherwise exception will be thrown.

Parameters:

aUri - UESURI for canonicalization.

Returns:

Canonical UESURI.

Throws:

UnsupportedOperationRTException - In case the UESURI contains only code in some UESURI part except territory UESURI part.

Since:

UES6-00

isCanonical

boolean isCanonical(UESURI aURI)

Tests, whether is the UESURI in canonical form. Canonical form of an UESURI is specified in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

aURI - Tested UESURI.

Returns:

True, when UESURI is in canonical form, otherwise false.

Since:

UES6-00

getEvaluatedURI

UESURI getEvaluatedURI(UESURI aUri)

Returns evaluated UESURI. Evaluation of UESURI expressions is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

aUri - UESURI for evaluation.

Returns:

Evaluated UESURI.

Since:

UES6-06

isEvaluated

boolean isEvaluated(UESURI aUri)

Tests whether is the UESURI evaluated (expressions are resolved). Evaluation of UESURI expressions is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

aUri - UESURI for evaluation.

Returns:

True when UESURI is evaluated, otherwise false.

Since:

UES6-06

getNormalizedURI

UESURI getNormalizedURI(UESURI uri)
throws InvalidFormatRTException

Returns normalized UESURI. Normalized form of UESURI is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Normalization of an UESURI requires that active territory is the same as territory specified within the normalized UESURI and there is an active transaction.

Parameters:

uri - UESURI for normalization.

Returns:

Normalized UESURI or the null reference if the UESURI cannot be normalized (e.g. the UESURI is ambiguous; there is no persistent object referenced by the UESURI,...).

Throws:

InvalidUESURIFormatRTException - If UESURI cannot be normalized due to invalid format.

InvalidFormatRTException

Since:

UES7-10

See Also:

UESTerritoryService

isNormalized

boolean isNormalized(UESURI uri)

Tests, whether is the UESURI in normalized form. Normalized form of an UESURI is specified in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

uri - Tested UESURI.

Returns:

True, when UESURI is normalized, otherwise false.

Since:

UES7-10