cz.ues.core.property

Interface UESPropertyTemplate

@UESService
public interface UESPropertyTemplate

UES Property Template service.

Since:

UES8-03

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI parentNodeUri, UESPropertyTemplateCreate propertyTemplate) Creates a new property template on the specified Meta Artifact or in the specified property template group.
UESURI	createCollection(UESURI parentNodeUri, UESPropertyTemplateCollectionCreate propertyCollTemplate) Creates a new property template collection on the specified Meta Artifact or in the specified property collection template.
void	delete(UESURI propertyTemplateUri) Deletes the property template from the system.
void	deleteCollection(UESURI collTemplateUri, UESPropertyTemplateDeleteCollection options) Deletes the specified property collection template.
UESPropertyTemplateAttributes	getAttributes(UESURI propertyTemplateUri) Returns attributes representing the specified property template.
UESPropertyTemplateCollectionAttributes	getCollectionAttributes(UESURI collectionTemplateUri) Returns attributes of the specified property collection template.
UESResultList<UESPropertyTemplateEntryAttributes,UESPropertyTemplateGetEntryList>	getEntryList(UESURI parentNodeUri, UESPropertyTemplateGetEntryList criteria) Returns a list of entries (property templates or property template collections) enlisted in the specified property template collection or on the specified Meta Artifact (property template entries from the Meta Artifact root property template collection are returned in that case).
<T> T	getValue(UESURI propertyTemplateUri) Returns the value of the given property template of the corresponding type.
void	move(UESURI propertyTemplateUri, UESPropertyTemplateMove newLocation) Moves a property template to the new location (see UESPropertyTemplateMove.parentNodeUri) on the same artifact.
void	moveCollection(UESURI collectionUri, UESPropertyTemplateMoveCollection newLocation) Moves a property template collection to the new location (see UESPropertyTemplateMoveCollection.parentNodeUri) on the same Meta Artifact.
UESURI	setAttributes(UESURI propertyTemplateUri, UESPropertyTemplateSetAttributes propertyTemplate) Sets basic attributes of the specified property template.
UESURI	setCollectionAttributes(UESURI collTemplateUri, UESPropertyTemplateSetCollectionAttributes propertyCollTemplate) Modifies basic attributes of the property collection template specified in collTemplateUri.
void	setValue(UESURI propertyTemplateUri, java.lang.Object value) Sets a new value on the specified property template.

Method Detail

create

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=CREATE)

UESURI create(UESURI parentNodeUri,
UESPropertyTemplateCreate propertyTemplate)
throws UESPropertyTemplateRTException

Creates a new property template on the specified Meta Artifact or in the specified property template group. At the very least property template type and name have to be specified in this command. Value of the property template is optional.

Parameters:

parentNodeUri - UESURI of the Meta Artifact or of the property template group where the new property template is created

propertyTemplate - Object containing attributes of the new property template

Returns:

UESURI of the new property template

Throws:

UESPropertyTemplateRTException

createCollection

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=CREATE)

UESURI createCollection(UESURI parentNodeUri,
UESPropertyTemplateCollectionCreate propertyCollTemplate)
throws UESPropertyTemplateRTException

Creates a new property template collection on the specified Meta Artifact or in the specified property collection template. At the very least property template collection name has to be specified in this command.

Parameters:

parentNodeUri - UESURI of the Meta Artifact or of the property collection template where the new property collection template is created

propertyTemplateColl - Object containing attributes of a new property collection template

Returns:

UESURI of the new property collection template

Throws:

UESPropertyTemplateRTException

getAttributes

@UESCommand(stereotype=READ)

UESPropertyTemplateAttributes getAttributes(UESURI propertyTemplateUri)
throws UESPropertyTemplateRTException

Returns attributes representing the specified property template.

Parameters:

propertyTemplateUri - UESURI of the property template

Returns:

UESPropertyTemplateAttributes Object with property template attributes

Throws:

UESPropertyTemplateRTException

getValue

@UESCommand(stereotype=READ)

<T> T getValue(UESURI propertyTemplateUri)
throws UESPropertyTemplateRTException

Returns the value of the given property template of the corresponding type. Null in case the value is not set.

Parameters:

propertyTemplateUri - UESURI of the property template

Returns:

T the value of the property template

Throws:

UESPropertyTemplateRTException

getCollectionAttributes

@UESCommand(stereotype=READ)

UESPropertyTemplateCollectionAttributes getCollectionAttributes(UESURI collectionTemplateUri)
throws UESPropertyTemplateRTException

Returns attributes of the specified property collection template.

Parameters:

collectionTemplateUri - UESURI of the property collection template, which attributes are to be retrieved.

Returns:

UESPropertyCollectionTemplateAttributes Object with attributes of the property collection template.

Throws:

UESPropertyTemplateRTException

getEntryList

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=READ)

UESResultList<UESPropertyTemplateEntryAttributes,UESPropertyTemplateGetEntryList> getEntryList(UESURI parentNodeUri,
UESPropertyTemplateGetEntryList criteria)
throws UESPropertyTemplateRTException

Returns a list of entries (property templates or property template collections) enlisted in the specified property template collection or on the specified Meta Artifact (property template entries from the Meta Artifact root property template collection are returned in that case). Command does not return all entries, only a sublist. The list of returned entries could be filtered by the name, code or type of an entry. The list is sorted by the name (and code in case are equal) of an entry by default, or it can be sorted arbitrarily by any of entry attributes usable for the filtering or these attributes combinations. See the UES query documentation for more information.

Parameters:

parentNodeUri - UESURI of the Meta Artifact or of the property template collection from where entries (property templates or property template collections) are listed.

criteria - Object containing criteria for listing property template entries.

Returns:

List List of Object representing property template entries (property template or property template collections)

Throws:

UESPropertyTemplateRTException

setAttributes

UESURI setAttributes(UESURI propertyTemplateUri,
UESPropertyTemplateSetAttributes propertyTemplate)
throws UESPropertyTemplateRTException

Sets basic attributes of the specified property template.

Parameters:

propertyTemplateUri - UESURI of the property template

propertyTemplate - Object of the new attributes for the property template

Returns:

UESURI of the property template with new attributes

Throws:

UESPropertyTemplateRTException

setCollectionAttributes

UESURI setCollectionAttributes(UESURI collTemplateUri,
UESPropertyTemplateSetCollectionAttributes propertyCollTemplate)
throws UESPropertyTemplateRTException

Modifies basic attributes of the property collection template specified in collTemplateUri.

Parameters:

collTemplateUri - UESURI of the property collection template which attributes is modified

propertyCollTemplate - Object containing attributes of the property collection template

Returns:

UESURI of the property collection template

Throws:

UESPropertyTemplateRTException

setValue

@UESCommand(stereotype=UPDATE)

void setValue(UESURI propertyTemplateUri,
java.lang.Object value)
throws UESPropertyTemplateRTException

Sets a new value on the specified property template. The data type of the value must match the data type of the specified property template.

Parameters:

propertyTemplateUri - UESURI of the property template

value - the new value of the property template

Throws:

UESPropertyTemplateRTException

move

@UESCommand(stereotype=UPDATE)

void move(UESURI propertyTemplateUri,
UESPropertyTemplateMove newLocation)
throws UESPropertyTemplateRTException

Moves a property template to the new location (see UESPropertyTemplateMove.parentNodeUri) on the same artifact. New location can be property template collection or Meta Artifact.

Parameters:

propertyTemplateUri - UESURI of the property template to be moved

newLocation - Object containing the new location of the property template

Throws:

UESPropertyTemplateRTException

Since:

UES8-06

moveCollection

@UESCommand(stereotype=UPDATE)

void moveCollection(UESURI collectionUri,
UESPropertyTemplateMoveCollection newLocation)
throws UESPropertyTemplateRTException

Moves a property template collection to the new location (see UESPropertyTemplateMoveCollection.parentNodeUri) on the same Meta Artifact. This template collection can not be base template collection. New location can be property template collection or Meta Artifact, and it can not be child of or the same as property template collection which is about to be moved.

Parameters:

collectionUri - UESURI of the property template collection which is about to be moved

newLocation - Object containing the new location of the property template collection

Throws:

UESPropertyTemplateRTException

Since:

UES8-06

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI propertyTemplateUri)
throws UESPropertyTemplateRTException

Deletes the property template from the system.

Parameters:

propertyTemplateUri - UESURI of the property template which is about to be deleted

Throws:

UESPropertyTemplateRTException

deleteCollection

@UESCommand(stereotype=DELETE)

void deleteCollection(UESURI collTemplateUri,
UESPropertyTemplateDeleteCollection options)
throws UESPropertyTemplateRTException

Deletes the specified property collection template. When recursive is set in options, all nested objects in property collection template are also removed.

Parameters:

collTemplateUri - UESURI of the property collection template which is about to be deleted

options - Object containing options for deletion

Throws:

UESPropertyTemplateRTException