cz.ues.core.property

Interface UESProperty

@UESService
public interface UESProperty

UES Property service.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_PROPERTY URI of property business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI parentNodeUri, UESPropertyCreate property) This command creates a new property on the specified artifact or in the specified property collection.
UESURI	createCollection(UESURI parentNodeUri, UESPropertyCreateCollection propertyCollection) This command creates a new property collection on the specified artifact or in the specified property collection.
void	delete(UESURI propertyUri) This command deletes the property from the system.
void	deleteCollection(UESURI collectionUri, UESPropertyDeleteCollection options) This command deletes the specified property collection from the system.
UESPropertyAttributes	getAttributes(UESURI propertyUri) Returns attributes representing the artifact property specified by the propertyUri attribute.
UESPropertyCollectionAttributes	getCollectionAttributes(UESURI collectionUri) This command returns attributes representing the property collection specified by the collectionUri parameter.
UESResultList<UESPropertyEntryAttributes,UESPropertyGetEntryList>	getEntryList(UESURI parentNodeUri, UESPropertyGetEntryList criteria) This command returns a list of entries (properties or property collections) enlisted in the specified property collection or on the specified artifact (properties from the artifact root property collection are returned in that case).
UESResultList<UESPropertyAttributes,UESPropertyGetPropertyList>	getPropertyList(UESURI parentNodeUri, UESPropertyGetPropertyList criteria) Deprecated. This command is no longer supported and developed. Use alternative command - UESProperty.getEntryList.
<T> T	getValue(UESURI propertyUri) This command returns a value on the specified property.
void	move(UESURI propertyUri, UESPropertyMove newLocation) Moves the specified property to a new location in same artifact in which the property is.
void	moveCollection(UESURI collectionUri, UESPropertyMoveCollection newLocation) This command moves a property collection to the new location in the same artifact.
UESURI	setAttributes(UESURI propertyUri, UESPropertySetAttributes property) This command sets attributes of the specified property.
UESURI	setCollectionAttributes(UESURI collectionUri, UESPropertySetCollectionAttributes propertyCollection) This command sets attributes of the specified property collection.
void	setValue(UESURI propertyUri, java.lang.Object value) This command sets a new value on the specified property.

Field Detail

BETYPE_PROPERTY

static final BETYPE_PROPERTY

URI of property business entity.

Since:

UES6-06

Method Detail

getAttributes

@UESCommand(stereotype=READ)

UESPropertyAttributes getAttributes(UESURI propertyUri)
throws UESPropertyRTException

Returns attributes representing the artifact property specified by the propertyUri attribute.

Parameters:

propertyUri - UESURI of Property

Returns:

DTO with artifact property attributes

Throws:

UESPropertyRTException

Since:

UES6-00

setValue

@UESCommand(stereotype=UPDATE)

void setValue(UESURI propertyUri,
java.lang.Object value)
throws UESPropertyRTException

This command sets a new value on the specified property. The data type of value must match the data type of the specified property.

Parameters:

propertyUri - UES URI of property

value - the new value of property (null is allowed)
Possible types of property's value:

• NUMBER - Double, format: real number
• DATE - Date, only date will be used from value, information of time will be lost
• SHORT_TEXT - String, format: name
• TEXT - String, format: description
• REFERENCE - String, format: UES-URI
• INTERTERRITORIAL_REFERENCE (inter-territorial reference) - String , format: UES-URI
• URL - String, format of value: URL
• BINARY - UESStreamHandler, format of value: binary data

Throws:

UESPropertyRTException

Since:

UES6-00

getValue

@UESCommand(stereotype=READ)

<T> T getValue(UESURI propertyUri)
throws UESPropertyRTException

This command returns a value on the specified property.

Type Parameters:

T - data type of the value. (For Binary type is returned UESStreamHandler).

Parameters:

propertyUri - UES URI of the property

Returns:

a value on the specified property

Throws:

UESPropertyRTException

Since:

UES6-00

create

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

UESURI create(UESURI parentNodeUri,
UESPropertyCreate property)
throws UESPropertyRTException, UESPropertyValidationRTException

This command creates a new property on the specified artifact or in the specified property collection. At the very least property template or the property type and name have to be specified in this command. Value of the property is optional. The data are streamed in case of type BINARY property.

Parameters:

parentNodeUri - UESURI of the artifact or of the property collection where the new property is created

property - DTO containing attributes of a new property

Returns:

UESURI of the created property

Throws:

UESPropertyRTException

UESPropertyValidationRTException

Since:

UES6-00

getPropertyList

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

UESResultList<UESPropertyAttributes,UESPropertyGetPropertyList> getPropertyList(UESURI parentNodeUri,
UESPropertyGetPropertyList criteria)
throws UESPropertyRTException

Deprecated. This command is no longer supported and developed. Use alternative command - UESProperty.getEntryList.

This command returns a list of properties in the specified property collection or on the specified artifact (properties from the artifact root property collection are returned in that case). Command does not return all properties, only a sublist. The list of returned properties could be filtered by the name or code of a property and it is sorted by names (and codes in case two names are equal).
Since UES7-04 - if the input parameter parentNodeUri is artifact (not property collection), all properties of the specified artifact are returned.

Parameters:

parentNodeUri - UESURI of the artifact or of the property collection from where properties are listed.

criteria - DTO containing criteria for listing properties. Available parameters are: name and code.

Returns:

List of DTO representing properties. The same DTO as in the command getAttributes

Throws:

UESPropertyRTException

Since:

UES6-00

See Also:

UESQuery Documentation.

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI propertyUri)
throws UESPropertyRTException

This command deletes the property from the system.

Parameters:

propertyUri - UESURI of the property which is about to be deleted.

Throws:

UESPropertyRTException

Since:

UES6-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI propertyUri,
UESPropertySetAttributes property)
throws UESPropertyRTException

This command sets attributes of the specified property.

Parameters:

propertyUri - UESURI of the property whose attributes are about to be changed.

property - DTO containing the attributes of the property to be set.

Returns:

UESURI of the modified property.

Throws:

UESPropertyRTException

Since:

UES7-04

createCollection

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

UESURI createCollection(UESURI parentNodeUri,
UESPropertyCreateCollection propertyCollection)
throws UESPropertyRTException

This command creates a new property collection on the specified artifact or in the specified property collection. At the very least property collection name has to be specified in this command.

Parameters:

parentNodeUri - UESURI of the artifact or of the property collection where the new property collection is created.

propertyCollection - DTO containing attributes of the new property collection.

Returns:

UESURI of the new property collection.

Throws:

UESPropertyRTException

Since:

UES7-04

getCollectionAttributes

@UESCommand(stereotype=READ)

UESPropertyCollectionAttributes getCollectionAttributes(UESURI collectionUri)
throws UESPropertyRTException

This command returns attributes representing the property collection specified by the collectionUri parameter. The command does not change the state of the property collection in the system.

Parameters:

collectionUri - UESURI of the property collection which attributes are returned.

Returns:

UESPropertyCollectionAttributes DTO containing the property collection attributes

Throws:

UESPropertyRTException

Since:

UES7-04

setCollectionAttributes

@UESCommand(stereotype=UPDATE)

UESURI setCollectionAttributes(UESURI collectionUri,
UESPropertySetCollectionAttributes propertyCollection)
throws UESPropertyRTException

This command sets attributes of the specified property collection.

Parameters:

collectionUri - UESURI of the property collection whose attributes are about to be changed.

propertyCollection - DTO containing the attributes of the property collection to be set.

Returns:

UESURI of the property collection whose attributes are to be changed.

Throws:

UESPropertyRTException

Since:

UES7-04

deleteCollection

@UESCommand(stereotype=DELETE)

void deleteCollection(UESURI collectionUri,
UESPropertyDeleteCollection options)
throws UESPropertyRTException

This command deletes the specified property collection from the system. When the collection is not empty, it's need explicite to allow deletion of the collection with its all nested objects.

Parameters:

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

option - DTO containing settings for deletion

Throws:

UESPropertyRTException

Since:

UES7-04

getEntryList

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

UESResultList<UESPropertyEntryAttributes,UESPropertyGetEntryList> getEntryList(UESURI parentNodeUri,
UESPropertyGetEntryList criteria)
throws UESPropertyRTException

This command returns a list of entries (properties or property collections) enlisted in the specified property collection or on the specified artifact (properties from the artifact root property 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 codes in case are equal) of a 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 artifact or of the property collection from where entries (properties or property collections) are listed.

criteria - DTO containing criteria for listing entries.

Returns:

List of DTO representing property entries (properties or property collections)

Throws:

UESPropertyRTException

Since:

UES7-04

moveCollection

@UESCommand(stereotype=UPDATE)

void moveCollection(UESURI collectionUri,
UESPropertyMoveCollection newLocation)
throws UESPropertyRTException

This command moves a property collection to the new location in the same artifact. This collection can not be base collection. New location can be property collection or artifact, and it can not be child of property collection which is about to move. New location can not be child of the moved collection. User must have access rights to modify property collection on artifact to which is collection related.

Parameters:

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

newLocation - DTO contains parameters that specify the move

Throws:

UESPropertyRTException

Since:

UES7-04

move

@UESCommand(stereotype=UPDATE)

void move(UESURI propertyUri,
UESPropertyMove newLocation)
throws UESPropertyRTException

Moves the specified property to a new location in same artifact in which the property is.

For the property move - the logged user, which invokes this command, must have access rights to modify target property collection.

Parameters:

propertyUri - UESURI of the property which is about to be moved.

newLocation - DTO containing attributes specifying a location to where the property is about to be moved.

Throws:

UESPropertyRTException

Since:

UES7-04