cz.ues.platform.commons.uri

Interface UESURIBuilder

All Known Subinterfaces:

UESURIBuilder

@UESComponent
@Prototype
public interface UESURIBuilder

UESURIBuilder - Class for creating Platform UESURI. This is an example, how can be an UESURI created:

 UESURI uri = new UESURIBuilder().setScheme("scheme").setArtifactCode("artCode").setObjectId("123").toUESURI();
 

Since:

UES6-00

Method Summary

Methods

Modifier and Type	Method and Description
UESURIBuilder	addEntityPart(java.lang.String id, java.lang.String code) Adds entity part created from passed id and code value.
UESURIPart	createUESURIPart(java.lang.String aId, java.lang.String aCode) Creates new instance of UESURI part from specified Id and Code.
UESURIPart	parseUESURIPart(java.lang.String aUESURIPart) Creates instance of UESURIPart from specified string.
UESURIBuilder	parseURI(java.lang.String aString) Parses specified string into UESURIBuilder instance.
UESURIBuilder	parseURI(UESURI uri) Initializes UESURIBuilder instance with values from passed UESURI.
UESURIBuilder	setAction(java.lang.String aAction) Sets use case action for the new created UESURI.
UESURIBuilder	setAuthorityCode(java.lang.String aAuthorityCode) Sets authority code for the new UESURI.
UESURIBuilder	setAuthorityId(java.lang.String aAuthorityId) Sets authority Id for the new UESURI.
UESURIBuilder	setEntityPart(java.lang.String aEntityPart) Sets entity part for the new created UESURI.
UESURIBuilder	setEntityPartList(java.util.List<UESURIPart> aPartList) Sets entity part as list of UESURIPart.
UESURIBuilder	setFragment(java.lang.String aFragment) Sets fragment for the new created UESURI.
UESURIBuilder	setParameters(java.util.Map<java.lang.String,java.lang.Object> aParameters) Sets parameters for new created UESURI.
UESURIBuilder	setScheme(java.lang.String aScheme) Deprecated. UESURIBuilder creates an instance of UESURI which has scheme "ues". Calling this method has no effect.
UESURIBuilder	setTerritoryCode(java.lang.String aTerritoryCode) Sets territory code for new created UESURI.
UESURIBuilder	setTerritoryExpression(java.lang.String expression) Set expression for territory part.
UESURIBuilder	setTerritoryId(java.lang.String aTerritoryId) Sets territory Id for new created UESURI.
UESURIBuilder	setUseCaseCode(java.lang.String aUseCaseCode) Sets use case code for the new created UESURI.
UESURIBuilder	setUseCaseId(java.lang.String aUseCaseId) Sets use case Id for the new created UESURI.
UESURI	toUESURI() Creates new instance of UESURI.

Method Detail

parseURI

UESURIBuilder parseURI(java.lang.String aString)
throws InvalidFormatRTException

Parses specified string into UESURIBuilder instance.

Parameters:

aString - Parsed string.

Returns:

Instance of UESURIBuilder.

Throws:

InvalidFormatRTException - When resolved String contains invalid or unsupported format of UESURI.

Since:

UES6-00

parseURI

UESURIBuilder parseURI(UESURI uri)

Initializes UESURIBuilder instance with values from passed UESURI.

Parameters:

uri - UESURI.

Returns:

Instance of UESURIBuilder.

Since:

UES7-00

setScheme

@Deprecated

UESURIBuilder setScheme(java.lang.String aScheme)

Deprecated. UESURIBuilder creates an instance of UESURI which has scheme "ues". Calling this method has no effect.

Sets scheme for the new UESURI.

Parameters:

aScheme - Scheme.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setAuthorityId

UESURIBuilder setAuthorityId(java.lang.String aAuthorityId)

Sets authority Id for the new UESURI.

Parameters:

aAuthorityId - Authority Id.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setAuthorityCode

UESURIBuilder setAuthorityCode(java.lang.String aAuthorityCode)

Sets authority code for the new UESURI.

Parameters:

aAuthorityCode - Authority code.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setTerritoryId

UESURIBuilder setTerritoryId(java.lang.String aTerritoryId)

Sets territory Id for new created UESURI.

Parameters:

aTerritoryId - Territory Id.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setTerritoryCode

UESURIBuilder setTerritoryCode(java.lang.String aTerritoryCode)

Sets territory code for new created UESURI.

Parameters:

aTerritoryCode - Territory code.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setTerritoryExpression

UESURIBuilder setTerritoryExpression(java.lang.String expression)

Set expression for territory part.

Parameters:

expression - Expression to set.

Returns:

Reference to this UESURIBuilder.

Since:

UES7-00

setEntityPart

UESURIBuilder setEntityPart(java.lang.String aEntityPart)

Sets entity part for the new created UESURI.

Parameters:

aEntityPart - Entity part.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setEntityPartList

UESURIBuilder setEntityPartList(java.util.List<UESURIPart> aPartList)

Sets entity part as list of UESURIPart.

Parameters:

aPartList - List of UESURI parts, which forms entity part.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-04

addEntityPart

UESURIBuilder addEntityPart(java.lang.String id,
java.lang.String code)

Adds entity part created from passed id and code value.

Parameters:

id - Id.

code - Code.

Returns:

Reference to this UESURIBuilder instance.

Since:

UES7-00

setUseCaseId

UESURIBuilder setUseCaseId(java.lang.String aUseCaseId)

Sets use case Id for the new created UESURI.

Parameters:

aUseCaseId - Use case Id.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setUseCaseCode

UESURIBuilder setUseCaseCode(java.lang.String aUseCaseCode)

Sets use case code for the new created UESURI.

Parameters:

aUseCaseCode - Use case code.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setAction

UESURIBuilder setAction(java.lang.String aAction)

Sets use case action for the new created UESURI.

Parameters:

aAction - Use case action.

Returns:

Reference to this UESURIBuilder object.

Since:

UES8-08

setParameters

UESURIBuilder setParameters(java.util.Map<java.lang.String,java.lang.Object> aParameters)

Sets parameters for new created UESURI.

Parameters:

aParameters - UESURI parameters.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setFragment

UESURIBuilder setFragment(java.lang.String aFragment)

Sets fragment for the new created UESURI.

Parameters:

aFragment - Fragment part.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

toUESURI

UESURI toUESURI()
throws InvalidFormatRTException

Creates new instance of UESURI.

Returns:

Instance of UESURI.

Throws:

InvalidFormatRTException - When created UESURI has no scheme or no artifact part specified.

Since:

UES6-00

parseUESURIPart

UESURIPart parseUESURIPart(java.lang.String aUESURIPart)

Creates instance of UESURIPart from specified string.

Parameters:

aUESURIPart - UESURIPart in string form.

Returns:

UESURIPart in string form.

Since:

UES6-04

createUESURIPart

UESURIPart createUESURIPart(java.lang.String aId,
java.lang.String aCode)

Creates new instance of UESURI part from specified Id and Code.

Parameters:

aId - Id.

aCode - Code.

Returns:

New instance of UESURIPart.

Since:

UES6-04