cz.ues.core.content.dto

Class UESSheetSetAttributes

java.lang.Object

cz.ues.core.content.dto.UESSheetSetAttributes

@DTO
public class UESSheetSetAttributes
extends java.lang.Object

DTO containing attributes for setting sheet attributes.

Since:

UES7-01

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	code The new code of the sheet.
(package private) java.lang.String	description The new description of the sheet.
(package private) java.lang.Boolean	main Specifies if the sheet is set as the main sheet of the specified artifact.
(package private) java.lang.String	name The new name of the sheet.
(package private) java.lang.Integer	order Specifies the order (or index) of the sheet in the specified artifact.
(package private) java.lang.Boolean	visible Specifies if the sheet is set as visible sheet of the specified artifact.
(package private) UESSheetWidthType	width The new width of the sheet.

Constructor Summary

Constructors

Constructor and Description
UESSheetSetAttributes()
UESSheetSetAttributes(java.lang.String name, java.lang.String code, java.lang.Boolean main, java.lang.Boolean visible, java.lang.Integer order, java.lang.String description)
UESSheetSetAttributes(java.lang.String name, java.lang.String code, java.lang.Boolean main, java.lang.Boolean visible, java.lang.Integer order, java.lang.String description, 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

name

The new name of the sheet. When null is set, the name is not modified. The name must be unique in a given artifact, otherwise the setAttributes command fails.

Since:

UES7-01

code

code

The new code of the sheet. When null is set, the code is not modified. The code must be unique in a given artifact, otherwise the setAttributes command fails.

Since:

UES7-01

main

main

Specifies if the sheet is set as the main sheet of the specified artifact. When null is set, the main is not modified. When true is set, the sheet must be visible. When false is set and the sheet is set as the main sheet of the specified artifact, system sets first one the visible sheet as the main sheet of the specified artifact. If the main sheet of the specified artifact is simultaneously the first visible sheet, nothing happens.

Since:

UES7-01

visible

visible

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

Since:

UES7-01

order

order

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

Since:

UES7-01

description

description

The new description of the sheet. When null is set, the description is not modified.

Since:

UES7-01

width

width

The new width of the sheet. When null is set, the width is not modified.

Since:

UES7-01

Constructor Detail

UESSheetSetAttributes

public UESSheetSetAttributes()

Since:

UES7-01

UESSheetSetAttributes

public UESSheetSetAttributes(java.lang.String name,
java.lang.String code,
java.lang.Boolean main,
java.lang.Boolean visible,
java.lang.Integer order,
java.lang.String description)

Since:

UES7-01

UESSheetSetAttributes

public UESSheetSetAttributes(java.lang.String name,
java.lang.String code,
java.lang.Boolean main,
java.lang.Boolean visible,
java.lang.Integer order,
java.lang.String description,
UESSheetWidthType width)

Since:

UES7-01