cz.ues.core.container

Interface UESOrganizationalUnit

@UESService
public interface UESOrganizationalUnit

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ORGANIZATIONALUNIT URI of organizational unit business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, UESOrganizationalUnitCreate organizationalUnit) Creates a new organizational unit.
void	delete(UESURI orgUnitUri) This command deletes the specified organizational unit from the system.
UESOrganizationalUnitAttributes	getAttributes(UESURI organizationalUnitUri) This command returns attributes representing the organizational unit specified by the organizationalUnitUri parameter.
UESResultList<UESOrganizationalUnitEntryAttributes,UESOrganizationalUnitGetEntryList>	getEntryList(UESURI organizationalUnitUri, UESOrganizationalUnitGetEntryList criteria) This command returns a list of entries (artifacts or shortcuts) enlisted in the specified organizational unit.
UESURI	setAttributes(UESURI organizationalUnitUri, UESOrganizationalUnitSetAttributes organizationalUnit) Command for setting attributes of an organizational unit.

Field Detail

BETYPE_ORGANIZATIONALUNIT

static final BETYPE_ORGANIZATIONALUNIT

URI of organizational unit business entity.

Since:

UES6-06

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESOrganizationalUnitCreate organizationalUnit)
throws UESOrganizationalUnitRTException

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

Parameters:

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

DTO - containing attributes of the new organizational unit

Returns:

UESURI of the new organizational unit

Throws:

UESOrganizationalUnitRTException

Since:

UES6-00

getAttributes

@UESCommand(stereotype=READ)

UESOrganizationalUnitAttributes getAttributes(UESURI organizationalUnitUri)
throws UESOrganizationalUnitRTException

This command returns attributes representing the organizational unit specified by the organizationalUnitUri parameter. The command does not change the state of the organizational unit in the system.

Parameters:

organizationalUnitUri - UESURI of an organizational unit whose attributes are returned

Returns:

DTO containing the organizational unit attributes

Throws:

UESOrganizationalUnitRTException

Since:

UES6-06

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI organizationalUnitUri,
UESOrganizationalUnitSetAttributes organizationalUnit)
throws UESOrganizationalUnitRTException

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

Parameters:

organizationalUnitUri - UESURI of the organizational unit whose attributes are to be changed

organizationalUnit - DTO containing new attributes the organizational unit

Returns:

UESURI of the organizational unit

Throws:

UESOrganizationalUnitRTException

Since:

UES6-06

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI orgUnitUri)
throws UESOrganizationalUnitRTException

This command deletes the specified organizational unit from the system. The organizational unit is deleted even if it contains a locked sheet or attachment. The organizational unit cannot be deleted when:

• the org. unit is not empty.
• the org. unit's workflow is not created
• a property contains a reference to this org. unit
• a time sheet exists with a reference to this org. unit

Parameters:

orgUnitUri - UESURI of the organizational unit which is about to be deleted.

Throws:

UESOrganizationalUnitRTException

Since:

UES6-10

getEntryList

@UESCommand(stereotype=READ)

UESResultList<UESOrganizationalUnitEntryAttributes,UESOrganizationalUnitGetEntryList> getEntryList(UESURI organizationalUnitUri,
UESOrganizationalUnitGetEntryList criteria)
throws UESOrganizationalUnitRTException

This command returns a list of entries (artifacts or shortcuts) enlisted in the specified organizational unit. Only entries listed exactly in the specified organizational units are considered (so subordinate organizational units are not considered). The command does not return all entries, only a sublist. The list of returned entries could be filtered by the name, code or type of an entry. 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:

organizationalUnitUri - UESURI of the organizational unit from where entries (artifacts or shortcuts) are listed.

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

Returns:

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

Throws:

UESOrganizationalUnitRTException

See Also:

UESQuery Documentation.