cz.ues.core.content.dto

Class UESSheetCreate

java.lang.Object

cz.ues.core.content.dto.UESSheetCreate

@DTO
public class UESSheetCreate
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	code Code of the new sheet.
private UESSheetStreamHandler	content Sheet data.
private java.lang.String	description Description of the new sheet.
private java.lang.Boolean	emptyContent Specifies if the new sheet is created with empty content.
private java.lang.Boolean	main Specifies if the new sheet is set as the main sheet of the specified artifact.
private java.lang.String	name Name of the new sheet.
private java.lang.Integer	order Specifies the order (or index) of the new sheet in the specified artifact.
private UESURI	templateUri UESURI of the new sheet template.
private java.lang.String	versionLabel Version label of the created sheet version.
private java.lang.Boolean	visible Specifies if the new sheet is set as visible sheet of the specified artifact.
private UESSheetWidthType	width Flag of width sheet.

Constructor Summary

Constructors

Constructor and Description
UESSheetCreate()
UESSheetCreate(UESURI templateUri, java.lang.String name, java.lang.String code, java.lang.String description, UESSheetStreamHandler content, java.lang.Boolean emptyContent, java.lang.Boolean main, java.lang.Integer order, java.lang.String versionLabel)
UESSheetCreate(UESURI templateUri, java.lang.String name, java.lang.String code, java.lang.String description, UESSheetStreamHandler content, java.lang.Boolean emptyContent, java.lang.Boolean main, java.lang.Integer order, java.lang.String versionLabel, java.lang.Boolean visible)
UESSheetCreate(UESURI templateUri, java.lang.String name, java.lang.String code, java.lang.String description, UESSheetStreamHandler content, java.lang.Boolean emptyContent, java.lang.Boolean main, java.lang.Integer order, java.lang.String versionLabel, java.lang.Boolean visible, UESSheetWidthType width)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

private name

Name of the new sheet. When null is set, the name is generated automatically. The name must be unique in a given artifact, otherwise the create command fails.

Since:

UES6-00

code

private code

Code of the new sheet. When null is set, the code is generated automatically using the system sequence. The code must be unique in a given artifact, otherwise the create command fails.

Since:

UES6-00

description

private description

Description of the new sheet. When null is set, the description is taken from the template tDescription. When the template does not define a tDescription, it is left empty.

Since:

UES6-00

templateUri

private templateUri

UESURI of the new sheet template. When null is set, template of the default sheet of the given artifact is used.

Since:

UES6-00

emptyContent

private emptyContent

Specifies if the new sheet is created with empty content. When null is set, content is left intact (it is determined by the content attribute and by the template eventually).

Since:

UES6-00

main

private main

Specifies if the new sheet is set as the main sheet of the specified artifact. When null is set, the new sheet is not set as main. When true is set, the sheet must be visible.

Since:

UES6-00

order

private order

Specifies the order (or index) of the new sheet in the specified artifact. All sheets in an artifact are ordered sequentially. The first sheet has index 0. When null is set or when the order exceeds the number of sheets in the artifact, the sheet is inserted at the end of the sheet list. When 0 or less is set, the sheet is inserted at the beginning of the sheet list. Sheet currently at that position (if any) and any subsequent sheets are shifted to the right (adds one to their order).

Since:

UES6-00

content

private content

Sheet data. When null is set, the data from template is used.

Since:

UES6-00

versionLabel

private versionLabel

Version label of the created sheet version. When null is set, versionLabel is left empty.

Since:

UES6-00

visible

private visible

Specifies if the new sheet is set as visible sheet of the specified artifact. When null is set, the visible is taken from the template tVisible. When false is set, the sheet must not be set as the main of the specified artifact.

Since:

UES7-01

width

private width

Flag of width sheet.

Since:

UES7-01

Constructor Detail

UESSheetCreate

public UESSheetCreate()

Since:

UES6-00

UESSheetCreate

public UESSheetCreate(UESURI templateUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESSheetStreamHandler content,
java.lang.Boolean emptyContent,
java.lang.Boolean main,
java.lang.Integer order,
java.lang.String versionLabel)

Since:

UES6-00

UESSheetCreate

public UESSheetCreate(UESURI templateUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESSheetStreamHandler content,
java.lang.Boolean emptyContent,
java.lang.Boolean main,
java.lang.Integer order,
java.lang.String versionLabel,
java.lang.Boolean visible,
UESSheetWidthType width)

Since:

UES7-01

UESSheetCreate

public UESSheetCreate(UESURI templateUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
UESSheetStreamHandler content,
java.lang.Boolean emptyContent,
java.lang.Boolean main,
java.lang.Integer order,
java.lang.String versionLabel,
java.lang.Boolean visible)

Since:

UES7-01