cz.ues.core.attachment

Interface UESAttachment

@UESService
public interface UESAttachment

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ATTACHMENT URI of attachment business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI artifactUri, UESAttachmentCreate attachment) This command creates a new attachment to the specified artifact.
void	delete(UESURI attachmentUri) This command deletes the attachment from the system.
void	deleteVersion(UESURI attachmentUri, UESAttachmentDeleteVersion version) Deletes an attachment version by provided ID.
UESAttachmentStreamHandler	getAttachmentData(UESURI attachmentUri) Command returns stream handler containing data content of the attachment.
UESResultList<UESAttachmentAttributes,UESAttachmentGetAttachmentList>	getAttachmentList(UESURI artifactUri, UESAttachmentGetAttachmentList criteria) Retrieves a UESResult list of attachments for the artifact specified by the artifactUri parameter.
UESAttachmentAttributes	getAttributes(UESURI attachmentUri) Returns attributes representing the attachment specified by the attachmentUri attribute.
UESAttachmentVersionAttributes	getVersionAttributes(UESURI attachmentUri, UESAttachmentGetVersionAttributes versionAttributes) Returns attributes an attachment version by provided ID.
UESAttachmentStreamHandler	getVersionData(UESURI attachmentUri, UESAttachmentGetVersionData version) Retreives the data of the specified attachment version.
UESResultList<UESAttachmentVersionAttributes,UESAttachmentGetVersionList>	getVersionList(UESURI attachmentUri, UESAttachmentGetVersionList versionCriteria) Returns a list of version for the specified attachment.
void	checkIn(UESURI attachmentUri, UESAttachmentCheckIn attachment) This command updates the attached file in the system and unlocks it by default.
UESAttachmentStreamHandler	checkOut(UESURI attachmentUri, UESAttachmentCheckOut options) Command locks the attachment specified by the attachmentUri attribute.
UESURI	setAttributes(UESURI attachmentUri, UESAttachmentSetAttributes attachment) This command updates basic attributes of an attachment.

Field Detail

BETYPE_ATTACHMENT

static final BETYPE_ATTACHMENT

URI of attachment business entity.

Since:

UES6-06

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI artifactUri,
UESAttachmentCreate attachment)
throws UESAttachmentRTException

This command creates a new attachment to the specified artifact. At the very least attachment data and filename have to be specified in this command. The data are streamed.

Parameters:

artifactUri - UESURI of the artifact where the new attachment is created

attachment - DTO containing attributes of a new attachment

Returns:

UESURI of the new attachment

Throws:

UESAttachmentRTException

Since:

UES6-00

getAttributes

@UESCommand(stereotype=READ)

UESAttachmentAttributes getAttributes(UESURI attachmentUri)
throws UESAttachmentRTException

Returns attributes representing the attachment specified by the attachmentUri attribute. If the attachment is locked by the current user, this command returns attributes of the private version. If the attachment is locked by another user (or if the attachment is unlocked), the command returns attributes of the public version. The command does not change the state of the attachment or its lock in the system.

Parameters:

attachmentUri - UESURI of the attachment

Returns:

DTO with attachment attributes

Throws:

UESAttachmentRTException

Since:

UES6-00

getAttachmentList

@UESCommand(stereotype=READ)

UESResultList<UESAttachmentAttributes,UESAttachmentGetAttachmentList> getAttachmentList(UESURI artifactUri,
UESAttachmentGetAttachmentList criteria)
throws UESAttachmentRTException

Retrieves a UESResult list of attachments for the artifact specified by the artifactUri parameter. The resulting attachment list is filtered according to the criteria provided by the criteria attribute. These criteria specify the page to return and name and code filters. The list is sorted (ascending) according to the attachment name and code.

Parameters:

artifactUri - UESURI of the artifact to get the list of attachments from.

criteria - DTO containing paging and filtering criteria. Available parameters are: name, code, locked and lockTime.

Returns:

list of attachments.

Throws:

UESAttachmentRTException

Since:

UES6-00

See Also:

UESQuery Documentation.

checkOut

@UESCommand(stereotype=UPDATE)

UESAttachmentStreamHandler checkOut(UESURI attachmentUri,
UESAttachmentCheckOut options)
throws UESAttachmentRTException

Command locks the attachment specified by the attachmentUri attribute. If the operation is successful or if the attachment is already locked by the current user, attachment stream handler or null is returned depending on the options set in the attribute options. If the attachment cannot be locked because the attachment is locked by another user, the command will fail.

Parameters:

attachmentUri - UESURI of the attachment

options - DTO with options containing a flag whether to return the stream with attachment data

Returns:

data content of the attachment or null depending on the options set in options attribute

Throws:

UESAttachmentRTException

Since:

UES6-00

checkIn

@UESCommand(stereotype=UPDATE)

void checkIn(UESURI attachmentUri,
UESAttachmentCheckIn attachment)
throws UESAttachmentRTException

This command updates the attached file in the system and unlocks it by default. The command succeeds if the attachment is unlocked or if it is locked by the current user. Otherwise, the command fails. At the very least attachment data and the filename have to be specified in this command. The data are streamed.

Parameters:

attachmentUri - UESURI of the attachment

attachment - DTO containing attributes of the checked-in attachment

Throws:

UESAttachmentRTException

Since:

UES6-00

getAttachmentData

@UESCommand(stereotype=READ)

UESAttachmentStreamHandler getAttachmentData(UESURI attachmentUri)
throws UESAttachmentRTException

Command returns stream handler containing data content of the attachment. If the attachment is locked by the same user, command returns data of the private version. If the attachment is locked by another user (or if the attachment is unlocked), command returns data of the public version. Command does not change the state of the attachment or its lock in the system.

Parameters:

attachmentUri - UESURI of the attachment

Returns:

DTO with attachment data content

Throws:

UESAttachmentRTException

Since:

UES6-00

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI attachmentUri)
throws UESAttachmentRTException

This command deletes the attachment from the system.

Parameters:

attachmentUri - UESURI of the attachment which is about to be deleted.

Throws:

UESAttachmentRTException

Since:

UES6-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI attachmentUri,
UESAttachmentSetAttributes attachment)
throws UESAttachmentRTException

This command updates basic attributes of an attachment.

Parameters:

attachmentUri - UESURI of the attachment whose attributes are to be changed.

attachment - DTO containing the attachment attributes.

Returns:

UESURI of the attachment

Throws:

UESAttachmentRTException

Since:

UES7-12

getVersionAttributes

@UESCommand(stereotype=READ)

UESAttachmentVersionAttributes getVersionAttributes(UESURI attachmentUri,
UESAttachmentGetVersionAttributes versionAttributes)
throws UESAttachmentRTException

Returns attributes an attachment version by provided ID.

Parameters:

attachmentUri - UESURI of the attachment whose version's attributes are going to be retrieved.

versionAttributes - Object containing id of the attachment version, whose attributes are going to be retrieved.

Returns:

Object containing the attributes of the attachment version.

Throws:

UESAttachmentRTException

Since:

UES8-17

getVersionList

@UESCommand(stereotype=READ)

UESResultList<UESAttachmentVersionAttributes,UESAttachmentGetVersionList> getVersionList(UESURI attachmentUri,
UESAttachmentGetVersionList versionCriteria)
throws UESAttachmentRTException

Returns a list of version for the specified attachment. Does not return all versions, only a sublist. The list of returned versions can be filtered by the attributes: name, code, label, creationTime, creationStamp and version. The list is sorted by the creation time of a version by default, or it can be sorted arbitrarily by any of the version attributes for the filtering or their combinations.

Parameters:

attachmentUri - UESURI of the attachment whose versions are going to be listed.

versionCriteria - Object containing criteria for listing attachment versions.

Returns:

List of objects containing versions' attributes. The same object is returned by the command getVersionAttributes.

Throws:

UESAttachmentRTException

Since:

UES8-17

See Also:

UESQuery Documentation.

deleteVersion

@UESCommand(stereotype=DELETE)

void deleteVersion(UESURI attachmentUri,
UESAttachmentDeleteVersion version)
throws UESAttachmentRTException

Deletes an attachment version by provided ID.

Parameters:

attachmentUri - UESURI of the attachment whose version is going to be deleted.

version - DTO containing ID of the version which is to be deleted.

Throws:

UESAttachmentRTException

Since:

UES8-17

getVersionData

@UESCommand(stereotype=READ)

UESAttachmentStreamHandler getVersionData(UESURI attachmentUri,
UESAttachmentGetVersionData version)
throws UESAttachmentRTException

Retreives the data of the specified attachment version.

Parameters:

attachmentUri - UESURI of the attachment whose version is going to be retrieved.

version - Id of the attachment version, which data are going to be retrieved. Not null.

Returns:

UESAttachmentStreamHandler, containing XML of the attachment content structure of the given version.

Throws:

UESAttachmentRTException

Since:

UES8-17