cz.ues.core.content

Interface UESSheet

@UESService
public interface UESSheet

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_SHEET URI of sheet business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI artifactUri, UESSheetCreate sheet) Command creates a new sheet in the specified artifact.
void	delete(UESURI sheetUri) Deletes the sheet from the system.
void	deleteComponent(UESURI sheetUri, UESSheetDeleteComponent component) Deletes specified component from the sheet.
void	deleteVersion(UESURI sheetUri, UESSheetDeleteVersion version) Deletes the version from the system.
void	deleteVersions(UESURI sheetUri, UESSheetDeleteVersions versions) Deletes unlabeled historic versions of a given sheet, based on provided criteria.
UESSheetAttributes	getAttributes(UESURI sheetUri) Returns attributes representing the sheet specified by the sheetUri attribute.
UESSheetStreamHandler	getComponentContent(UESURI sheetUri, UESSheetGetComponentContent component) Deprecated. since UES7-04 RFP1. Use #getComponentData(UESURI, UESSheetGetComponentContent) instead.
UESSheetStreamHandler	getComponentData(UESURI sheetUri, UESSheetGetComponentData component) Returns the content of specified sheet component in the specified format.
UESFileHandler	getImageData(UESURI sheetUri, UESSheetGetImageData image) Returns streamed data of the image from the specified content.
UESSheetStreamHandler	getSheetData(UESURI sheetUri, UESSheetGetSheetData options) Returns the content of the sheet specified by sheetUri.
UESResultList<UESSheetAttributes,UESSheetGetSheetList>	getSheetList(UESURI artifactUri, UESSheetGetSheetList sheetCriteria) This command returns a list of sheets on the specified artifact.
UESSheetVersionAttributes	getVersionAttributes(UESURI sheetUri, UESSheetGetVersionAttributes versionAttributes) Returns attributes of given sheet version.
UESSheetStreamHandler	getVersionData(UESURI sheetUri, UESSheetGetVersionData version) Retrieves the specified historical version of the given sheet in xml format.
UESResultList<UESSheetVersionAttributes,UESSheetGetVersionList>	getVersionList(UESURI sheetUri, UESSheetGetVersionList versionCriteria) This command returns a list of sheet versions of the specified sheet.
void	checkIn(UESURI sheetUri, UESSheetCheckIn sheet) This command changes the content of the public sheet version and unlocks it by default.
UESSheetStreamHandler	checkOut(UESURI sheetUri, UESSheetCheckOut options) This command locks the sheet for further modification, locks the given sheet of artifact.
void	publish(UESURI sheetUri) Publishes private version and opens the lock sheet.
java.util.List<java.lang.String>	replaceComponent(UESURI sheetUri, UESSheetReplaceComponent component) Replaces specified component with given content.
UESURI	setAttributes(UESURI sheetUri, UESSheetSetAttributes sheet) This command updates basic attributes of an sheet.
void	unlock(UESURI sheetUri) Unlocks the specified sheet.

Field Detail

BETYPE_SHEET

static final BETYPE_SHEET

URI of sheet business entity.

Since:

UES6-06

Method Detail

getAttributes

@UESCommand(stereotype=READ)

UESSheetAttributes getAttributes(UESURI sheetUri)
throws UESSheetRTException

Returns attributes representing the sheet specified by the sheetUri attribute.

Parameters:

sheetUri - URI of sheet

Returns:

DTO with sheet attributes

Throws:

UESSheetRTException

Since:

UES6-00

getSheetList

@UESCommand(stereotype=READ)

UESResultList<UESSheetAttributes,UESSheetGetSheetList> getSheetList(UESURI artifactUri,
UESSheetGetSheetList sheetCriteria)
throws UESSheetRTException

This command returns a list of sheets on the specified artifact. Command does not return all sheets, only a sublist. The list of returned sheets could be filtered by the name, code, main, order of a sheet and state of the lock. The list is sorted by the name (and codes in case are equal) of a sheet by default, or it can be sorted arbitrarily by any of sheet attributes usable for the filtering or these attributes combinations.

Parameters:

artifactUri - URI of artifact.

sheetCriteria - Criteria for selecting sheets. Available parameters are: name, code, order, main, locked, lockTime, visible and width : UESSheetWidthType.

Returns:

List with sheets of artifact

Throws:

UESSheetRTException

Since:

UES6-00

See Also:

UESQuery Documentation.

checkOut

@UESCommand(stereotype=UPDATE)

UESSheetStreamHandler checkOut(UESURI sheetUri,
UESSheetCheckOut options)
throws UESSheetRTException

This command locks the sheet for further modification, locks the given sheet of artifact. When lock succeed or sheet is currently locked by the user, sheet data can be returned. Sheet lock failure throws UESSheetRTException.

Parameters:

sheetUri - URI of sheet to be locked.

options - Specify when stream will be returned and which type of data

Returns:

DTO contains content of sheet

Throws:

UESSheetRTException

Since:

UES6-00

checkIn

@UESCommand(stereotype=UPDATE)

void checkIn(UESURI sheetUri,
UESSheetCheckIn sheet)
throws UESSheetRTException

This command changes the content of the public sheet version and unlocks it by default. Sheet content is in UXML or UDF format, data are streamed. Sheet must be unlocked or the user must be the lock owner. If using XML format document cannot contain links to property of object from other territory.

Parameters:

sheetUri - URI of the sheet.

sheet - Attributes of importing sheet

Throws:

UESSheetRTException

Since:

UES6-00

getSheetData

@UESCommand(stereotype=READ)

UESSheetStreamHandler getSheetData(UESURI sheetUri,
UESSheetGetSheetData options)
throws UESSheetRTException

Returns the content of the sheet specified by sheetUri. Data are streamed. Available output data formats are UXML file, UDF archive, and a zip archive with the sheet content exported as HTML document (see UESSheetGetSheetData for more details).

Parameters:

sheetUri - URI of the sheet.

options - Specify when stream will be returned and which type of data

Returns:

DTO with sheet content.

Throws:

UESSheetRTException

Since:

UES6-00

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI artifactUri,
UESSheetCreate sheet)
throws UESSheetRTException

Command creates a new sheet in the specified artifact. Initial sheet content could be specified. Content is streamed.

Parameters:

artifactUri - URI of artifact

sheet - DTO with sheet content

Returns:

UES URI of created sheet

Throws:

UESSheetRTException

Since:

UES6-00

getComponentContent

@Deprecated @UESCommand(stereotype=READ)

UESSheetStreamHandler getComponentContent(UESURI sheetUri,
UESSheetGetComponentContent component)
throws UESSheetRTException

Deprecated. since UES7-04 RFP1. Use #getComponentData(UESURI, UESSheetGetComponentContent) instead.

Returns the content of specified sheet component in the specified format. The result is streamed.

Parameters:

sheetUri - UESURI of the sheet

component - Specifies component id

Returns:

DTO containing the component content in a stream

Throws:

UESSheetRTException

Since:

UES6-06

getComponentData

@UESCommand(stereotype=READ)

UESSheetStreamHandler getComponentData(UESURI sheetUri,
UESSheetGetComponentData component)
throws UESSheetRTException

Returns the content of specified sheet component in the specified format. Available output data formats are UXML file or BB code. If not specified, BB code is used by default. The result is streamed.

Parameters:

sheetUri - UESURI of the sheet

component - Specifies component id and type of returned data

Returns:

DTO containing the component content in a stream

Throws:

UESSheetRTException

Since:

UES7-04

replaceComponent

@UESCommand(stereotype=UPDATE)

java.util.List<java.lang.String> replaceComponent(UESURI sheetUri,
UESSheetReplaceComponent component)
throws UESSheetRTException

Replaces specified component with given content. Content is in the BB code format and it is streamed. Replace returns list of componentIds of inserted components. Leaves the sheet locked if preserveLock not specified.

Parameters:

sheetUri - UESURI of the sheet.

component - Specifies component id and content in BB code format

Returns:

list of componentIds of inserted components

Throws:

UESSheetRTException

Since:

UES6-06

publish

@UESCommand(stereotype=UPDATE)

void publish(UESURI sheetUri)
throws UESSheetRTException

Publishes private version and opens the lock sheet. All changes made in private version are published.

Parameters:

sheetUri - UESURI of the sheet.

Throws:

UESSheetRTException

Since:

UES6-06

unlock

@UESCommand(stereotype=UPDATE)

void unlock(UESURI sheetUri)
throws UESSheetRTException

Unlocks the specified sheet. Allows to unlock the sheet locked by another user

Parameters:

sheetUri - UESURI of the sheet

Throws:

UESSheetRTException

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI sheetUri)
throws UESSheetRTException

Deletes the sheet from the system.

Parameters:

sheetUri - UESURI of the sheet which is about to be deleted.

Throws:

UESSheetRTException

Since:

UES6-10

deleteComponent

@UESCommand(stereotype=UPDATE)

void deleteComponent(UESURI sheetUri,
UESSheetDeleteComponent component)
throws UESSheetRTException

Deletes specified component from the sheet.

Parameters:

sheetUri - UESURI of the sheet.

UESSheetDeleteComponent - DTO containing attributes for deleting component.

Throws:

UESSheetRTException

Since:

UES6-06

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI sheetUri,
UESSheetSetAttributes sheet)
throws UESSheetRTException

This command updates basic attributes of an sheet.

Parameters:

sheetUri - UESURI of the sheet whose attributes are to be changed.

sheet - DTO containing the sheet attributes.

Returns:

UESURI of the changed sheet.

Throws:

UESSheetRTException

Since:

UES7-01

getVersionAttributes

@UESCommand(stereotype=READ)

UESSheetVersionAttributes getVersionAttributes(UESURI sheetUri,
UESSheetGetVersionAttributes versionAttributes)
throws UESSheetRTException

Returns attributes of given sheet version.

Parameters:

sheetUri - UESURI of the sheet whose version is being searched.

versionAttributes - DTO containing ID of the searched version.

Returns:

DTO with attributes of the searched version.

Throws:

UESSheetRTException

Since:

UES8-02

getVersionList

@UESCommand(stereotype=READ)

UESResultList<UESSheetVersionAttributes,UESSheetGetVersionList> getVersionList(UESURI sheetUri,
UESSheetGetVersionList versionCriteria)
throws UESSheetRTException

This command returns a list of sheet versions of the specified sheet. Command does not return all sheets, only a sublist. The list of returned sheets could be filtered by the label, time of creation, creation stamp and version number. The list is sorted by the creation time in descending order by default, but it can be sorted arbitrarily by any of sheet attributes usable for the filtering or by combination of these attributes.

Parameters:

sheetUri - URI of sheet.

versionCriteria - Criteria for selecting sheets. Available parameters are: label, creationTime, creationStamp, and version.

Returns:

List with versions of sheet

Throws:

UESSheetRTException

Since:

UES8-02

See Also:

UESQuery Documentation.

deleteVersion

@UESCommand(stereotype=DELETE)

void deleteVersion(UESURI sheetUri,
UESSheetDeleteVersion version)
throws UESSheetRTException

Deletes the version from the system.

Parameters:

sheetUri - UESURI of the sheet whose version is about to be deleted.

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

Throws:

UESSheetRTException

Since:

UES8-02

deleteVersions

@UESCommand(stereotype=DELETE)

void deleteVersions(UESURI sheetUri,
UESSheetDeleteVersions versions)
throws UESSheetRTException

Deletes unlabeled historic versions of a given sheet, based on provided criteria. If olderThanTs timestamp is specified, only versions older than given timestamp will be deleted, otherwise will be deleted a year or more old versions. If olderThanTs is set as a date in the future, all unlabeled historic version will be deleted. Historic versions are deleted asynchronously, together with all the image mappings and images.

Parameters:

sheetUri - UESURI of the sheet, which historic versions will be deleted.

versions - DTO containing optional timestamp

Throws:

UESSheetRTException

Since:

UES8-25

getImageData

@UESCommand(stereotype=READ)

UESFileHandler getImageData(UESURI sheetUri,
UESSheetGetImageData image)
throws UESSheetRTException

Returns streamed data of the image from the specified content.

Parameters:

sheetUri - Not null. UESURI of the sheet containing the image which should be returned.

image - Object with specific attributes.

Returns:

Object containing streamed image data.

Throws:

UESSheetRTException

getVersionData

@UESCommand(stereotype=READ)

UESSheetStreamHandler getVersionData(UESURI sheetUri,
UESSheetGetVersionData version)
throws UESSheetRTException

Retrieves the specified historical version of the given sheet in xml format.

Parameters:

sheetUri - UESURI of the sheet, which content will be retrieved.

version - Object containing which version of sheet will be retrieved and in which format.

Returns:

UESSheetStreamHandler, containing XML of the sheet content structure of the given version.

Throws:

UESSheetRTException