cz.ues.core.container

Interface UESFolder

@UESService
public interface UESFolder

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_FOLDER URI of folder business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, UESFolderCreate folder) Creates a folder of class Folder.
void	delete(UESURI folderUri) This command deletes the specified folder from the system.
UESURI	export(UESURI folderUri, UESFolderExport folder) The command exports a folder to a DataFile, which is saved to the Export Storage.
UESFolderAttributes	getAttributes(UESURI folderUri) Reads folder specified by the folderUri attribute and returns its attributes.
UESResultList<UESFolderEntryAttributes,UESFolderGetEntryList>	getEntryList(UESURI folderUri, UESFolderGetEntryList criteria) This command returns a list of entries (artifacts or shortcuts) enlisted in the specified folder (entity type of main entity of the command could be a Folder, Organizational Unit, Territory or Meta Model Dictionary).
UESStreamHandler	getExportData(UESURI folderUri, UESFolderGetExportData folder) The command returns a data file generated by the export command.
UESResultList<UESFolderEntryAttributes,UESFolderGetFolderEntryList>	getFolderEntryList(UESURI folderUri, UESFolderGetFolderEntryList criteria) Deprecated.
UESURI	setAttributes(UESURI folderUri, UESFolderSetAttributes folder) Command for setting attributes of a folder.

Field Detail

BETYPE_FOLDER

static final BETYPE_FOLDER

URI of folder business entity.

Since:

UES6-06

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESFolderCreate folder)
throws UESFolderRTException

Creates a folder of class Folder. Command creates new folder in specified container. At the very least meta artifact must be specified in UESArtifactCreate DTO. Competent role for artifact 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 UESArtifactCreate DTO.

Parameters:

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

folder - DTO containing attributes of the new folder

Returns:

UESURI of the created folder

Throws:

UESFolderRTException

Since:

UES6-00

getAttributes

@UESCommand(stereotype=READ)

UESFolderAttributes getAttributes(UESURI folderUri)
throws UESFolderRTException

Reads folder specified by the folderUri attribute and returns its attributes.

Parameters:

folderUri - UESURI of the folder

Returns:

DTO with folder attributes

Throws:

UESFolderRTException

Since:

UES6-00

getFolderEntryList

@Deprecated @UESCommand(stereotype=READ)

UESResultList<UESFolderEntryAttributes,UESFolderGetFolderEntryList> getFolderEntryList(UESURI folderUri,
UESFolderGetFolderEntryList criteria)
throws UESFolderRTException

Deprecated.

This command returns a list of entries (artifacts or shortcuts) enlisted in the specified folder (entity type of main entity of the command could be a Folder, Organizational Unit, Territory or Meta Model Dictionary). 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:

folderUri - UESURI of the folder from where entries (artifacts or shortcuts) are listed. It could be a Folder, Organizational Unit, Territory or Meta Model Dictionary.

criteria - DTO containing criteria for listing shortcuts

Returns:

List of DTO representing folder entries (artifacts or shortcuts).

Throws:

UESFolderRTException

Since:

UES6-02

getEntryList

@UESCommand(stereotype=READ)

UESResultList<UESFolderEntryAttributes,UESFolderGetEntryList> getEntryList(UESURI folderUri,
UESFolderGetEntryList criteria)
throws UESFolderRTException

This command returns a list of entries (artifacts or shortcuts) enlisted in the specified folder (entity type of main entity of the command could be a Folder, Organizational Unit, Territory or Meta Model Dictionary). 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.

Parameters:

folderUri - UESURI of the folder from where entries (artifacts or shortcuts) are listed. It could be a Folder, Organizational Unit, Territory or Meta Model Dictionary.

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

Returns:

List of DTO representing folder entries (artifacts or shortcuts).

Throws:

UESFolderRTException

Since:

UES7-01

See Also:

UESQuery Documentation.

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI folderUri)
throws UESFolderRTException

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

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

Parameters:

folderUri - UESURI of the folder which is about to be deleted.

Throws:

UESArtifactRTException

UESFolderRTException

Since:

UES6-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI folderUri,
UESFolderSetAttributes folder)
throws UESFolderRTException

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

Parameters:

folderUri - UESURI of the folder whose attributes are to be changed.

folder - DTO containing new attributes the folder.

Returns:

UESURI of the folder whose attributes are to be changed.

Throws:

UESFolderRTException

Since:

UES7-01

export

UESURI export(UESURI folderUri,
UESFolderExport folder)
throws UESFolderRTException

The command exports a folder to a DataFile, which is saved to the Export Storage. The export is an asynchronous event. That is why it returns a process URI to enable the user to wait for the process to finish.

Parameters:

folderUri - UESURI of the folder to export

folder - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

UESFolderRTException

Since:

UES8-04

getExportData

UESStreamHandler getExportData(UESURI folderUri,
UESFolderGetExportData folder)
throws UESFolderRTException

The command returns a data file generated by the export command. The file contains an exported folder.

Parameters:

folderUri - UESURI of the folder we want to get the exported file from.

folder - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported folder.

Throws:

UESFolderRTException

Since:

UES8-04