cz.ues.core.sysc

Interface UseCase

@UESService
public interface UseCase

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_USECASE URI of UseCaseRealization business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI metaArtifactUri, UseCaseCreate useCase) The command creates a use case in a specified meta artifact.
void	delete(UESURI useCaseUri) The command deletes the specified use case from the system
UseCaseAttributes	getAttributes(UESURI useCaseUri) This command returns attributes representing the use case specified by the useCaseUri parameter.
UESStreamHandler	getOptions(UESURI useCaseUri, UseCaseGetOptions options) The command returns options of the specified use case.
UESResultList<UseCaseAttributes,UseCaseGetUseCaseList>	getUseCaseList(UESURI metaArtifactUri, UseCaseGetUseCaseList criteria) Returns list of the use cases that are defined on the specified meta artifact.
UESURI	setAttributes(UESURI useCaseUri, UseCaseSetAttributes useCase) The command sets attributes on specified use case according to useCaseUri.
void	setOptions(UESURI useCaseUri, UseCaseSetOptions options) The command sets options of the specified use case.

Field Detail

BETYPE_USECASE

static final BETYPE_USECASE

URI of UseCaseRealization business entity.

Since:

UES7-10

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI metaArtifactUri,
UseCaseCreate useCase)
throws UseCaseRTException

The command creates a use case in a specified meta artifact.

Parameters:

metaArtifactUri - URI of the meta artifact where the use case is aggregated.

useCase - DTO containing attributes of the new use case

Returns:

URI of the new use case

Throws:

UseCaseRTException

Since:

UES7-10

delete

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

void delete(UESURI useCaseUri)
throws UseCaseRTException

The command deletes the specified use case from the system

Parameters:

useCaseUri - URI of the use case which is about to be deleted

Throws:

UseCaseRTException

Since:

UES7-10

getAttributes

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

UseCaseAttributes getAttributes(UESURI useCaseUri)
throws UseCaseRTException

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

Parameters:

useCaseUri - URI of the use case

Returns:

DTO containing attributes of the use case

Throws:

UseCaseRTException

Since:

UES7-10

setAttributes

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

UESURI setAttributes(UESURI useCaseUri,
UseCaseSetAttributes useCase)
throws UseCaseRTException

The command sets attributes on specified use case according to useCaseUri.

Parameters:

useCaseUri - URI of the use case

useCase - DTO containing new attributes of the use case

Returns:

URI of the use case

Throws:

UseCaseRTException

Since:

UES7-10

setOptions

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

void setOptions(UESURI useCaseUri,
UseCaseSetOptions options)
throws UseCaseRTException

The command sets options of the specified use case.

Parameters:

useCaseUri - URI of the use case

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

Throws:

UseCaseRTException

Since:

UES7-10

getOptions

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

UESStreamHandler getOptions(UESURI useCaseUri,
UseCaseGetOptions options)
throws UseCaseRTException

The command returns options of the specified use case.

Parameters:

useCaseUri - URI of the use case

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

Returns:

DTO containing the use case options in a stream.

Throws:

UseCaseRTException

Since:

UES7-10

getUseCaseList

@UESCommand(stereotype=READ)

UESResultList<UseCaseAttributes,UseCaseGetUseCaseList> getUseCaseList(UESURI metaArtifactUri,
UseCaseGetUseCaseList criteria)
throws UseCaseRTException

Returns list of the use cases that are defined on the specified meta artifact. 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.

Parameters:

metaArtifactUri - URI of the meta artifact uri

criteria - DTO containing the criteria for listing use cases.

Returns:

List of DTO with attributes of use cases

Throws:

UseCaseRTException

Since:

UES7-10

See Also:

UESQuery Documentation.