cz.ues.platform.sysc.usecase

Interface UESUseCase

@UESComponent
public interface UESUseCase

Component for managing Use Case data.

Since:

UES7-00

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI entityTypeUri, UESUseCaseCreate useCase) Creates Use Case in System Catalog.
void	delete(UESURI useCaseUri) Deletes Use Case from System Catalog.
UESUseCaseAttributes	findUseCase(UESURI useCaseRealizationURI, UESURI entityTypeURI) Deprecated. there can be more than one use case with desired entityTypeUri and Use Case Realization URI, and in that situation is thrown exception. Use findUseCaseList instead.
UESResultList<UESUseCaseAttributes,UESUseCaseFindUseCaseList>	findUseCaseList(UESURI entityTypeURI, UESUseCaseFindUseCaseList criteria) Find use cases specified by entity type and use case realization.
UESUseCaseAttributes	getAttributes(UESURI useCaseUri) Returns Use Case's attributes.
UESURI	setAttributes(UESURI useCaseUri, UESUseCaseSetAttributes useCase) Updates Use Case attributes.

Method Detail

create

UESURI create(UESURI entityTypeUri,
UESUseCaseCreate useCase)
throws UESUseCaseRTException

Creates Use Case in System Catalog.

Parameters:

entityTypeUri - UESURI of entity type.

useCase - DTO containing attributes for newly created Use Case.

Returns:

UESURI of the newly created Use Case.

Throws:

UESUseCaseRTException - When creation of Use Case fails.

Since:

UES7-00

getAttributes

UESUseCaseAttributes getAttributes(UESURI useCaseUri)
throws UESUseCaseRTException

Returns Use Case's attributes.

Parameters:

useCaseUri - UESURI of Use Case in one of following forms:

• ues:territory:entity?use_case
• ues:territory:entity_type:use_case

Returns:

DTO with attributes of the Use Case or the value null if there is no such Use Case.

Throws:

UESUseCaseRTException - If obtaining Use Case attributes fails.

Since:

UES7-00

setAttributes

UESURI setAttributes(UESURI useCaseUri,
UESUseCaseSetAttributes useCase)
throws UESUseCaseRTException

Updates Use Case attributes.

Parameters:

useCaseUri - UESURI of Use Case in one of following forms:

• ues:territory:entity?use_case
• ues:territory:entity_type:use_case

useCase - DTO with attributes for the updated Use Case.

Returns:

UESURI of the updated Use Case.

Throws:

UESUseCaseRTException - When updating of Use Case fails.

Since:

UES7-00

delete

void delete(UESURI useCaseUri)
throws UESUseCaseRTException

Deletes Use Case from System Catalog.

Parameters:

useCaseUri - UESURI of Use Case in one of following forms:

• ues:territory:entity?use_case
• ues:territory:entity_type:use_case

Throws:

UESUseCaseRTException - When deletion of Use Case fails.

Since:

UES7-00

findUseCase

@Deprecated

UESUseCaseAttributes findUseCase(UESURI useCaseRealizationURI,
UESURI entityTypeURI)
throws UESUseCaseRTException

Deprecated. there can be more than one use case with desired entityTypeUri and Use Case Realization URI, and in that situation is thrown exception. Use findUseCaseList instead.

Finds use case specified by entity type and use case realization. When no use case for given parameters exists, null is returned.

Parameters:

entityTypeURI - UESURI of entity type.

useCaseRealizationURI - UESURI of use case realization.

Returns:

DTO with attributes of the Use Case or the value null if there is no such Use Case.

Throws:

UESUseCaseRTException - If obtaining of attributes of Use Case fails.

Since:

UES7-02

findUseCaseList

UESResultList<UESUseCaseAttributes,UESUseCaseFindUseCaseList> findUseCaseList(UESURI entityTypeURI,
UESUseCaseFindUseCaseList criteria)
throws UESUseCaseRTException

Find use cases specified by entity type and use case realization. When no use case for given parameters exists, null is returned.

Parameters:

entityTypeURI - UESURI of entity type.

useCaseRealizationUri - UESURI of use case realization.

Returns:

UESResultList with attributes of the Use Case or the value null if there is no such Use Case. Result is sorted ascending order by Use Case Code case insensitive.

Throws:

UESUseCaseRTException - If obtaining of attributes of Use Case fails.

Since:

UES7-10