cz.ues.core.container

Interface UESShortcut

@UESService
public interface UESShortcut

Since:

UES6-02

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_SHORTCUT URI of shortcut business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, UESShortcutCreate shortcut) This command creates a new shortcut for the specified artifact.
void	delete(UESURI shortcutUri) This command deletes the shortcut from the system.
UESShortcutAttributes	getAttributes(UESURI shortcutUri) This command returns attributes representing the shortcut specified by the shortcutUri parameter.
UESResultList<UESShortcutAttributes,UESShortcutGetShortcutList>	getShortcutList(UESURI artifactUri, UESShortcutGetShortcutList criteria) This command returns a list of shortcuts to the specified artifact.
UESURI	relocate(UESURI shortcutUri, UESShortcutRelocate shortcut) This command relocates the shortcut to the new location.
UESURI	setAttributes(UESURI shortcutUri, UESShortcutSetAttributes shortcut) This command updates some basic attributes of a shortcut.

Field Detail

BETYPE_SHORTCUT

static final BETYPE_SHORTCUT

URI of shortcut business entity.

Since:

UES6-06

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESShortcutCreate shortcut)
throws UESShortcutRTException

This command creates a new shortcut for the specified artifact. At the very least, referenced artifact have to be specified in this command.

Parameters:

locationUri - UESURI of the location (folder, org. unit, territory etc.) where the new shortcut is created

shortcut - DTO containing attributes of the new shortcut

Returns:

UESURI of the created shortcut

Throws:

UESShortcutRTException

Since:

UES6-02

getAttributes

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

UESShortcutAttributes getAttributes(UESURI shortcutUri)
throws UESShortcutRTException

This command returns attributes representing the shortcut specified by the shortcutUri parameter. The command does not change the state of the shortcut in the system.

Parameters:

shortcutUri - UESURI of a shortcut whose attributes are returned

Returns:

DTO containing the shortcut attributes

Throws:

UESShortcutRTException

Since:

UES6-02

getShortcutList

@UESCommand(stereotype=READ)

UESResultList<UESShortcutAttributes,UESShortcutGetShortcutList> getShortcutList(UESURI artifactUri,
UESShortcutGetShortcutList criteria)
throws UESShortcutRTException

This command returns a list of shortcuts to the specified artifact. The command does not return all shortcuts, only a sublist. Only the shortcuts from the territory of the artifact are returned. The list of returned shortcuts could be filtered by the name or code of a shortcut. The list is sorted by the name (and codes in case are equal) of a shortcut by default, or it can be sorted arbitrarily by any of shortcut attributes usable for the filtering or these attributes combinations. See the UES query documentation for more information.

Parameters:

artifactUri - UESURI of the artifact to which the returned shortcuts point.

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

Returns:

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

Throws:

UESShortcutRTException

Since:

UES6-02

See Also:

UESQuery Documentation.

relocate

@UESCommand(stereotype=UPDATE)

UESURI relocate(UESURI shortcutUri,
UESShortcutRelocate shortcut)
throws UESShortcutRTException

This command relocates the shortcut to the new location. It means the shortcut is deleted and created again in a new location. It is recreated with the same attributes. But its UESURI is different because the shortcut is deleted and created again in another location. At the very least new location have to be specified in this command. The new location has to be in the same territory.

Parameters:

shortcutUri - UESURI of the shortcut to relocate

shortcut - DTO containing attributes for the shortcut relocation

Returns:

UESURI of the relocated shortcut. UESURI is different because the shortcut is deleted and created again in another location.

Throws:

UESShortcutRTException

Since:

UES6-02

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI shortcutUri)
throws UESShortcutRTException

This command deletes the shortcut from the system.

Parameters:

shortcutUri - UESURI of the shortcut to be deleted

Throws:

UESShortcutRTException

Since:

UES6-02

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI shortcutUri,
UESShortcutSetAttributes shortcut)
throws UESShortcutRTException

This command updates some basic attributes of a shortcut.

Parameters:

shortcutUri - UESURI of the shortcut whose attributes are to be changed

shortcut - DTO containing new attributes the shortcut

Returns:

UESURI of the shortcut. It could be changed because command could change the code

Throws:

UESShortcutRTException

Since:

UES6-02