cz.ues.core.content

Interface UESSheetTemplate

@UESService
public interface UESSheetTemplate

Sheet template service.

Since:

UES8-03

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI marUri, UESSheetTemplateCreate sheetTemplate) Creates a new sheet template on the specified Meta Artifact.
void	delete(UESURI sheetTemplateUri) Deletes the sheet template from the system.
UESSheetTemplateAttributes	getAttributes(UESURI sheetTemplateUri) Returns attributes representing specified sheet template.
UESSheetStreamHandler	getData(UESURI sheetTemplateUri, UESSheetTemplateGetData options) Returns the content of the sheet template.
UESResultList<UESSheetTemplateAttributes,UESSheetTemplateGetSheetTemplateList>	getSheetTemplateList(UESURI marUri, UESSheetTemplateGetSheetTemplateList criteria) Returns a list of sheet templates on the specified Meta Artifact.
void	checkIn(UESURI sheetTemplateUri, UESSheetTemplateCheckIn sheetTemplate) Replaces the content of the specified sheet template and unlock it by default.
UESURI	setAttributes(UESURI sheetTemplateUri, UESSheetTemplateSetAttributes sheetTemplate) Updates basic attributes of the sheet template.

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI marUri,
UESSheetTemplateCreate sheetTemplate)
throws UESSheetTemplateRTException, UESSheetRTException

Creates a new sheet template on the specified Meta Artifact. Initial sheet template content can be specified.

Parameters:

marUri - UESURI of the Meta Artifact where the new sheet template is created

sheetTemplate - Object containing attributes of the sheet template

Returns:

UESURI of the created sheet template

Throws:

UESSheetTemplateRTException

UESSheetRTException

getAttributes

@UESCommand(stereotype=READ)

UESSheetTemplateAttributes getAttributes(UESURI sheetTemplateUri)
throws UESSheetTemplateRTException

Returns attributes representing specified sheet template.

Parameters:

sheetTemplateUri - UESURI of a sheet template which attributes will be retrieved

Returns:

UESSheetTemplateAttributes Object containing the sheet template attributes

Throws:

UESSheetTemplateRTException

getData

@UESCommand(stereotype=READ)

UESSheetStreamHandler getData(UESURI sheetTemplateUri,
UESSheetTemplateGetData options)
throws UESSheetTemplateRTException, UESSheetRTException

Returns the content of the sheet template. The content may be returned as structured UXML or full content including images in a compressed UDF format. The type of the returned stream is determined by options (see UESSheetTemplateGetData.requestedMimeType), UXML is returned by default.

Parameters:

sheetTemplateUri - UESURI of the sheet template, which content is being retrieved

options - Object containing options for content retrieving

Returns:

UESSheetStreamHandler with the sheet template data

Throws:

UESSheetTemplateRTException

UESSheetRTException

getSheetTemplateList

@UESCommand(stereotype=READ)

UESResultList<UESSheetTemplateAttributes,UESSheetTemplateGetSheetTemplateList> getSheetTemplateList(UESURI marUri,
UESSheetTemplateGetSheetTemplateList criteria)
throws UESSheetTemplateRTException

Returns a list of sheet templates on the specified Meta Artifact. Command does not return all sheet templates, only a sublist. The list of returned sheet templates could be filtered by the name, code, main, visible, order of a sheet template, state of the lock and width. The list is sorted by the name (and code in case are equal) of a sheet template by default, or it can be sorted arbitrarily by any of sheet template attributes usable for the filtering or these attributes combinations. See the UES query documentation for more information.

Parameters:

marUri - UESURI of the Meta Artifact from where sheet templates are listed.

criteria - Object containing criteria for listing sheet templates.

Returns:

List of Object representing sheet templates. The same object as in the command getAttributes.

Throws:

UESSheetTemplateRTException

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI sheetTemplateUri,
UESSheetTemplateSetAttributes sheetTemplate)
throws UESSheetTemplateRTException

Updates basic attributes of the sheet template.

Parameters:

sheetTemplateUri - UESURI of the sheet template which attributes are to be changed

sheetTemplate - Object containing the sheet template attributes

Returns:

UESURI of the changed sheet template

Throws:

UESSheetTemplateRTException

checkIn

@UESCommand(stereotype=UPDATE)

void checkIn(UESURI sheetTemplateUri,
UESSheetTemplateCheckIn sheetTemplate)
throws UESSheetTemplateRTException, UESSheetRTException

Replaces the content of the specified sheet template and unlock it by default. Sheet template content must be in UXML or UDF format. Sheet template must be locked by the current user or must be unlocked.

Parameters:

sheetTemplateUri - UESURI of the sheet template which content is to be replaced

sheetTemplate - Object containing attributes of the sheet template

Throws:

UESSheetTemplateRTException

UESSheetRTException

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI sheetTemplateUri)
throws UESSheetTemplateRTException

Deletes the sheet template from the system. The sheet template is deleted even if it is locked. If the sheet temp,late is main, the next sheet template will be set as main.

Parameters:

sheetTemplateUri - UESURI of the sheet template which is about to be deleted

Throws:

UESSheetTemplateRTException