cz.ues.core.container

Interface UESCompany

@UESService
public interface UESCompany

Since:

UES7-10

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_COMPANY URI of company business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, UESCompanyCreate company) Creates a new company.
void	delete(UESURI companyUri) This command deletes the specified company from the system.
UESCompanyAttributes	getAttributes(UESURI companyUri) This command returns attributes representing the company specified by the companyUri parameter.
UESResultList<UESCompanyEntryAttributes,UESCompanyGetEntryList>	getEntryList(UESURI companyUri, UESCompanyGetEntryList criteria) This command returns a list of entries (artifacts or shortcuts) enlisted in the specified company.
UESURI	setAttributes(UESURI companyUri, UESCompanySetAttributes company) Command for setting attributes of a company.

Field Detail

BETYPE_COMPANY

static final BETYPE_COMPANY

URI of company business entity.

Since:

UES7-10

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESCompanyCreate company)
throws UESCompanyRTException

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

Parameters:

locationUri - UESURI of the container except meta model where the company is going to be created

company - DTO containing attributes of new company

Returns:

UESURI of the new company

Throws:

UESCompanyRTException

Since:

UES7-10

getAttributes

@UESCommand(stereotype=READ)

UESCompanyAttributes getAttributes(UESURI companyUri)
throws UESCompanyRTException

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

Parameters:

companyUri - UESURI of the company whose attributes are returned

Returns:

Filled DTO with attributes of the company

Throws:

UESCompanyRTException

Since:

UES7-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI companyUri,
UESCompanySetAttributes company)
throws UESCompanyRTException

Command for setting attributes of a company. The command cannot modify references to objects like location, competent role and so on.

Parameters:

companyUri - UESURI of the company whose attributes are to be changed.

company - DTO containing new attributes for company

Returns:

UESURI of the company

Throws:

UESCompanyRTException

Since:

UES7-10

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI companyUri)
throws UESCompanyRTException

This command deletes the specified company from the system. The company is deleted even if constains locked sheet or attachment. The company cannot be deleted when:

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

Parameters:

companyUri - UESURI of the company which is going to be deleted

Throws:

UESCompanyRTException

Since:

UES7-10

getEntryList

@UESCommand(stereotype=READ)

UESResultList<UESCompanyEntryAttributes,UESCompanyGetEntryList> getEntryList(UESURI companyUri,
UESCompanyGetEntryList criteria)
throws UESCompanyRTException

This command returns a list of entries (artifacts or shortcuts) enlisted in the specified company. Only entries listed exactly in the specified company 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 entityType 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:

companyUri - UESURI of the company from where entries are listed

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

Returns:

List of DTO representing company entries

Throws:

UESCompanyRTException

Since:

UES7-10

See Also:

UESQuery Documentation.