cz.ues.core.sysc

Interface VisualUseCase

@UESService
public interface VisualUseCase

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_VISUAL_USE_CASE URI of VisualUseCase business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, VisualUseCaseCreate visualUseCase) The command creates a visual use case in a specified meta model.
void	delete(UESURI visualUseCaseUri) The command deletes the specified visual use case from the system.
UESURI	export(UESURI visualUseCaseUri, VisualUseCaseExport visualUseCase) The command exports a visual use case to a DataFile, which is saved to the Export Storage.
VisualUseCaseAttributes	getAttributes(UESURI visualUseCaseUri) This command returns attributes representing the visual use case specified by the visualUseCaseUri parameter.
UESStreamHandler	getData(UESURI visualUseCaseUri) The command returns content of first attachment which is used as data for visual use case.
UESStreamHandler	getExportData(UESURI visualUseCaseUri, VisualUseCaseGetExportData visualUseCase) The command returns a data file generated by the export command.
UESStreamHandler	getOptions(UESURI visualUseCaseUri, VisualUseCaseGetOptions options) The command returns options of the specified use case.
UESResultList<VisualUseCaseGetUseCaseListItem,VisualUseCaseGetUseCaseList>	getUseCaseList(UESURI visualUseCaseUri, VisualUseCaseGetUseCaseList criteria) Returns list of the use cases that are connected to the specified visual use case.
UESURI	setAttributes(UESURI visualUseCaseUri, VisualUseCaseSetAttributes visualUseCase) The command for setting attributes of a specified visual use case.
void	setOptions(UESURI visualUseCaseUri, VisualUseCaseSetOptions options) The command sets options of the specified visual use case.

Field Detail

BETYPE_VISUAL_USE_CASE

static final BETYPE_VISUAL_USE_CASE

URI of VisualUseCase business entity.

Since:

UES8-04

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
VisualUseCaseCreate visualUseCase)
throws VisualUseCaseRTException

The command creates a visual use case in a specified meta model. At the very least meta artifact must be specified in VisualUseCaseCreate DTO. Competent role for the new visual use case will be selected as the most suitable according to specified container and meta artifact (executive/authorized role with connected interface), or can be also specified in VisualUseCaseCreate DTO.

Parameters:

locationUri - UESURI of the meta model where the visual use case will be created.

visualUseCase - DTO containing attributes of the new visual use case.

Returns:

UESURI of the new visual use case.

Throws:

VisualUseCaseRTException

Since:

UES8-04

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI visualUseCaseUri)
throws VisualUseCaseRTException

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

Parameters:

visualUseCaseUri - UESURI of the visual use case which is about to be deleted.

Throws:

VisualUseCaseRTException

Since:

UES8-04

getAttributes

@UESCommand(stereotype=READ)

VisualUseCaseAttributes getAttributes(UESURI visualUseCaseUri)
throws VisualUseCaseRTException

This command returns attributes representing the visual use case specified by the visualUseCaseUri parameter.

Parameters:

visualUseCaseUri - UESURI of the visual use case.

Returns:

DTO containing attributes of the visual use case.

Throws:

VisualUseCaseRTException

Since:

UES8-04

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI visualUseCaseUri,
VisualUseCaseSetAttributes visualUseCase)
throws VisualUseCaseRTException

The command for setting attributes of a specified visual use case. The command can't modify references to object like storage, competent role and so on.

Parameters:

visualUseCaseUri - UESURI of the visual use case.

visualUseCase - DTO containing new attributes of the use case.

Returns:

UESURI of the visual use case.

Throws:

VisualUseCaseRTException

Since:

UES8-04

getOptions

@UESCommand(stereotype=READ)

UESStreamHandler getOptions(UESURI visualUseCaseUri,
VisualUseCaseGetOptions options)
throws VisualUseCaseRTException

The command returns options of the specified use case.

Parameters:

visualUseCaseUri - UESURI of the visual use case.

options - DTO containing an options for getting visual use case options.

Returns:

UESStreamHandler containing the visual use case options in a stream.

Throws:

VisualUseCaseRTException

Since:

UES8-04

setOptions

@UESCommand(stereotype=UPDATE)

void setOptions(UESURI visualUseCaseUri,
VisualUseCaseSetOptions options)
throws VisualUseCaseRTException

The command sets options of the specified visual use case.

Parameters:

visualUseCaseUri - UESURI of the visual use case.

options - DTO containing the options data for setting visual use case options.

Throws:

VisualUseCaseRTException

Since:

UES8-04

getUseCaseList

@UESCommand(stereotype=READ)

UESResultList<VisualUseCaseGetUseCaseListItem,VisualUseCaseGetUseCaseList> getUseCaseList(UESURI visualUseCaseUri,
VisualUseCaseGetUseCaseList criteria)
throws VisualUseCaseRTException

Returns list of the use cases that are connected to the specified visual use case. The list of returned use cases could 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 use case by default. See Also: UES Query Documentation.

Parameters:

visualUseCaseUri - UESURI of the visual use case for which the connected use cases are to be listed.

criteria - DTO containing criteria for listing connected use cases.

Returns:

List of DTO representing use cases which are connected to the specified visual use case.

Throws:

VisualUseCaseRTException

Since:

UES8-04

See Also:

UESQuery Documentation.

getData

@UESCommand(stereotype=READ)

UESStreamHandler getData(UESURI visualUseCaseUri)
throws VisualUseCaseRTException

The command returns content of first attachment which is used as data for visual use case.

Parameters:

visualUseCaseUri - UESURI of the visual use case.

Returns:

UESStreamHandler containing the first attachment content in a stream.

Throws:

VisualUseCaseRTException

Since:

UES8-04

export

UESURI export(UESURI visualUseCaseUri,
VisualUseCaseExport visualUseCase)
throws VisualUseCaseRTException

The command exports a visual use case 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:

visualUseCaseUri - UESURI of the visual use case to export

visualUseCase - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

VisualUseCaseRTException

Since:

UES8-03

getExportData

UESStreamHandler getExportData(UESURI visualUseCaseUri,
VisualUseCaseGetExportData visualUseCase)
throws VisualUseCaseRTException

The command returns a data file generated by the export command. The file contains an exported visual use case.

Parameters:

visualUseCaseUri - UESURI of the visual use case we want to get the exported file from.

visualUseCase - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported visual use case.

Throws:

VisualUseCaseRTException

Since:

UES8-04