cz.ues.core.sysc

Interface Widget

@UESService
public interface Widget

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_WIDGET URI of Widget business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, WidgetCreate widget) Creates a widget in specified location.
void	delete(UESURI widgetUri) The command deletes the specified widget from the system.
UESURI	export(UESURI widgetUri, WidgetExport widget) The command exports a widget to a DataFile, which is saved to the Export Storage.
WidgetAttributes	getAttributes(UESURI widgetUri) This command returns attributes representing the widget specified by the widgetUri parameter.
UESStreamHandler	getExportData(UESURI widgetUri, WidgetGetExportData widget) The command returns a data file generated by the export command.
UESResultList<WidgetGetWidgetListItem,WidgetGetWidgetList>	getRegisteredWidgetList(UESURI containerUri, WidgetGetWidgetList citeria) Returns list of the widgets that are registered within the application or within the territory .
UESResultList<WidgetGetWidgetListItem,WidgetGetWidgetList>	getWidgetList(UESURI entityUri, WidgetGetWidgetList citeria) Returns the list of widgets whose instances can be inserted into the content of selected sheet or into the content of a sheet on a given Artifact.
UESURI	setAttributes(UESURI widgetUri, WidgetSetAttributes widget) Sets attributes of widget.

Field Detail

BETYPE_WIDGET

static final BETYPE_WIDGET

URI of Widget business entity.

Since:

UES8-15

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
WidgetCreate widget)
throws WidgetRTException

Creates a widget in specified location. At the very least meta artifact must be specified in WidgetCreate object. Competent role for the new widget will be selected as the most suitable according to specified package and meta artifact (executive/authorized role with connected interface), or can be also specified in WidgetCreate Object.

Parameters:

locationUri - UESURI of the meta model where the widget will be created.

widget - DTO containing attributes of the new widget.

Returns:

UESURI of the new widget.

Throws:

WidgetRTException

Since:

UES8-15

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI widgetUri)
throws WidgetRTException

The command deletes the specified widget from the system. The command fails when the specified widget is referenced by some use case. The widget is deleted even if it contains a locked sheet or attachment.

Parameters:

widgetUri - UESURI of the widget which is about to be deleted.

Throws:

WidgetRTException

Since:

UES8-15

getAttributes

@UESCommand(stereotype=READ)

WidgetAttributes getAttributes(UESURI widgetUri)
throws WidgetRTException

This command returns attributes representing the widget specified by the widgetUri parameter.

Parameters:

widgetUri - UESURI of the widget.

Returns:

DTO containing attributes of the widget.

Throws:

WidgetRTException

Since:

UES8-15

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI widgetUri,
WidgetSetAttributes widget)
throws WidgetRTException

Sets attributes of widget. Command cannot modify references to objects like location, competent role and so on. Changing the code of the widget will cause malfunction of widget instances.

Parameters:

widgetUri - UESURI of the widget.

widget - DTO containing new attributes of the widget.

Returns:

UESURI of the widget.

Throws:

WidgetRTException

Since:

UES8-15

getWidgetList

@UESCommand(stereotype=READ)

UESResultList<WidgetGetWidgetListItem,WidgetGetWidgetList> getWidgetList(UESURI entityUri,
WidgetGetWidgetList citeria)
throws WidgetRTException

Returns the list of widgets whose instances can be inserted into the content of selected sheet or into the content of a sheet on a given Artifact. Returned list does not contain any objects filtered out by executed UESQuery. The list is sorted by the name (and codes in case are equal) of an widget by default. See Also: UES Query Documentation.

Parameters:

entityUri - UESURI of the sheet or artifact for which the available widgets are to be listed.

citeria - DTO containing criteria for listing widgets.

Returns:

List of DTO representing widgets available to the sheet.

Throws:

WidgetRTException

Since:

UES8-15

See Also:

UESQuery Documentation.

getRegisteredWidgetList

@UESCommand(stereotype=READ)

UESResultList<WidgetGetWidgetListItem,WidgetGetWidgetList> getRegisteredWidgetList(UESURI containerUri,
WidgetGetWidgetList citeria)
throws WidgetRTException

Returns list of the widgets that are registered within the application or within the territory . The list of returned widgets can be filtered by the name or code. Returned list does not contain any objects filtered out by executed UESQuery. The list is sorted by the name (and codes in case are equal) of an widget by default. See Also: UES Query Documentation.

Parameters:

containerUri - UESURI of the territory or the application for which the widgets are to be listed.

citeria - DTO containing criteria for listing widgets.

Returns:

List of DTO representing widgets.

Throws:

WidgetRTException

Since:

UES8-15

See Also:

UESQuery Documentation.

export

UESURI export(UESURI widgetUri,
WidgetExport widget)
throws WidgetRTException

The command exports a widget to a DataFile, which is saved to the Export Storage. The export is an asynchronous event. That is why it returns a process URI to enable the user to wait for the process to finish.

Parameters:

widgetUri - UESURI of the widget to export

widget - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

WidgetRTException

Since:

UES8-15

getExportData

UESStreamHandler getExportData(UESURI widgetUri,
WidgetGetExportData widget)
throws WidgetRTException

The command returns a data file generated by the export command. The file contains an exported widget.

Parameters:

widgetUri - UESURI of the widget we want to get the exported file from.

widget - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported widget.

Throws:

WidgetRTException

Since:

UES8-15