cz.ues.core.commons.uri

Interface UESURIBuilder

All Superinterfaces:

UESURIBuilder

@UESComponent
@Prototype
public interface UESURIBuilder
extends UESURIBuilder

UESURIBuilder - Class for creating Core 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	parseURI(java.lang.String aString) Parses specified string into UESURIBuilder instance.
UESURIBuilder	setAction(java.lang.String aAction) Sets use case action for the new UESURI.
UESURIBuilder	setArtifactCode(java.lang.String aArtifactCode) Sets artifact code for the new UESURI.
UESURIBuilder	setArtifactId(java.lang.String aArtifactId) Sets artifact Id for the new 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 UESURI.
UESURIBuilder	setFragment(java.lang.String aFragment) Sets fragment for the new UESURI.
UESURIBuilder	setObjectCode(java.lang.String aObjectCode) Sets object code for the new UESURI.
UESURIBuilder	setObjectId(java.lang.String aObjectId) Sets object Id for the new UESURI.
UESURIBuilder	setParameters(java.util.Map<java.lang.String,java.lang.Object> aParameters) Sets parameters for the new UESURI.
UESURIBuilder	setRoleCode(java.lang.String aRoleCode) Sets role code for the new UESURI.
UESURIBuilder	setRoleId(java.lang.String aRoleId) Sets role Id for the new 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	setTerritoryId(java.lang.String aTerritoryId) Sets territory Id for the new UESURI.
UESURIBuilder	setUseCaseCode(java.lang.String aUseCaseCode) Sets use case code for the new UESURI.
UESURIBuilder	setUseCaseId(java.lang.String aUseCaseId) Sets use case Id for the new UESURI.
UESURI	toUESURI() Creates new instance of UESURI.

Methods inherited from interface cz.ues.platform.commons.uri.UESURIBuilder

addEntityPart, createUESURIPart, parseUESURIPart, parseURI, setEntityPartList, setTerritoryExpression

Method Detail

parseURI

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

Parses specified string into UESURIBuilder instance.

Specified by:

parseURI in interface UESURIBuilder

Parameters:

aString - Parsed string.

Returns:

Instance of UESURIBuilder.

Throws:

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

Since:

UES6-00

See Also:

UESURIBuilder.parseURI(java.lang.String)

setScheme

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.

Specified by:

setScheme in interface UESURIBuilder

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.

Specified by:

setAuthorityId in interface UESURIBuilder

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.

Specified by:

setAuthorityCode in interface UESURIBuilder

Parameters:

aAuthorityCode - Authority code.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setRoleId

UESURIBuilder setRoleId(java.lang.String aRoleId)

Sets role Id for the new UESURI.

Parameters:

aRoleId - Role Id.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setRoleCode

UESURIBuilder setRoleCode(java.lang.String aRoleCode)

Sets role code for the new UESURI.

Parameters:

aRoleCode - Role code.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setTerritoryId

UESURIBuilder setTerritoryId(java.lang.String aTerritoryId)

Sets territory Id for the new UESURI.

Specified by:

setTerritoryId in interface UESURIBuilder

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.

Specified by:

setTerritoryCode in interface UESURIBuilder

Parameters:

aTerritoryCode - Territory code.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

See Also:

UESURIBuilder.setTerritoryCode(java.lang.String)

setEntityPart

UESURIBuilder setEntityPart(java.lang.String aEntityPart)

Sets entity part for the new UESURI.

Specified by:

setEntityPart in interface UESURIBuilder

Parameters:

aEntityPart - Entity part.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setUseCaseId

UESURIBuilder setUseCaseId(java.lang.String aUseCaseId)

Sets use case Id for the new UESURI.

Specified by:

setUseCaseId in interface UESURIBuilder

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 UESURI.

Specified by:

setUseCaseCode in interface UESURIBuilder

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 UESURI.

Specified by:

setAction in interface UESURIBuilder

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 the new UESURI.

Specified by:

setParameters in interface UESURIBuilder

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 UESURI.

Specified by:

setFragment in interface UESURIBuilder

Parameters:

aFragment - Fragment.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setArtifactId

UESURIBuilder setArtifactId(java.lang.String aArtifactId)

Sets artifact Id for the new UESURI.

Parameters:

aArtifactId - Artifact Id.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setArtifactCode

UESURIBuilder setArtifactCode(java.lang.String aArtifactCode)

Sets artifact code for the new UESURI.

Parameters:

aArtifactCode - Artifact code.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setObjectId

UESURIBuilder setObjectId(java.lang.String aObjectId)

Sets object Id for the new UESURI.

Parameters:

aObjectId - Object Id.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

setObjectCode

UESURIBuilder setObjectCode(java.lang.String aObjectCode)

Sets object code for the new UESURI.

Parameters:

aObjectCode - Object code.

Returns:

Reference to this UESURIBuilder object.

Since:

UES6-00

toUESURI

UESURI toUESURI()
throws InvalidFormatRTException

Creates new instance of UESURI.

Specified by:

toUESURI in interface UESURIBuilder

Returns:

Instance of UESURI.

Throws:

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

Since:

UES6-00

See Also:

UESURIBuilder.toUESURI()