cz.ues.core.sysc

Interface AppBox

@UESService
public interface AppBox

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_APPBOX URI of AppBox business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, AppBoxCreate appBox) Creates a new application box.
AppBoxAttributes	getAttributes(UESURI appBoxUri) This command returns attributes representing the application box specified by the appBoxUri parameter.
UESResultList<AppBoxEntryAttributes,AppBoxGetEntryList>	getEntryList(UESURI appBoxUri, AppBoxGetEntryList criteria) This command returns a list of entries (artifacts or shortcuts) enlisted in the specified application box.
UESURI	setAttributes(UESURI appBoxUri, AppBoxSetAttributes appBox) Command for setting attributes of an application box.

Field Detail

BETYPE_APPBOX

static final BETYPE_APPBOX

URI of AppBox business entity.

Since:

UES7-10

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
AppBoxCreate appBox)
throws AppBoxRTException

Creates a new application box. The command creates a new application box in a specified location. At the very least meta artifact must be specified in AppBoxCreate DTO. Competent role for the application box 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 AppBoxCreate DTO.

Parameters:

locationUri - UESURI of the folder/org. unit/meta model where application box will be created.

DTO - containing attributes of the new application box

Returns:

UESURI of the new application box

Throws:

AppBoxRTException

Since:

UES7-10

getAttributes

@UESCommand(stereotype=READ)

AppBoxAttributes getAttributes(UESURI appBoxUri)
throws AppBoxRTException

This command returns attributes representing the application box specified by the appBoxUri parameter. The command does not change the state of the application box in the system.

Parameters:

appBoxUri - UESURI of an application box whose attributes are returned

Returns:

DTO containing the application box attributes

Throws:

AppBoxRTException

Since:

UES7-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI appBoxUri,
AppBoxSetAttributes appBox)
throws AppBoxRTException

Command for setting attributes of an application box. The command can't modify references to objects like location, competent role and so on.

Parameters:

appBoxUri - UESURI of the application box whose attributes are to be changed

appBox - DTO containing new attributes the application box

Returns:

UESURI of the application box

Throws:

AppBoxRTException

Since:

UES7-10

getEntryList

@UESCommand(stereotype=READ)

UESResultList<AppBoxEntryAttributes,AppBoxGetEntryList> getEntryList(UESURI appBoxUri,
AppBoxGetEntryList criteria)
throws AppBoxRTException

This command returns a list of entries (artifacts or shortcuts) enlisted in the specified application box. Only entries listed exactly in the specified application boxes are considered (so subordinate application boxes are not considered). The command does not return all entries, only a sublist. The list of returned entries could be filtered by the name or code. The list is sorted by the name (and codes in case are equal) of a entry by default, or it can be sorted arbitrarily by any of entry attributes usable for the filtering or these attributes combinations. See the UES query documentation for more information.

Parameters:

appBoxUri - UESURI of the application box from where entries (artifacts or shortcuts) are listed.

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

Returns:

List of DTO representing entries of the appBoxUri (artifacts or shortcuts).

Throws:

AppBoxRTException

See Also:

UESQuery Documentation.