Class: UU::OS::Sheet::SheetCreate

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb

Instance Attribute Summary (collapse)

Method Summary

Methods inherited from REST::DTO

#initialize, #to_hash, #to_json

Constructor Details

This class inherits a constructor from UU::OS::REST::DTO

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class UU::OS::REST::DTO

Instance Attribute Details

- (Object) 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.



16
17
18
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 16

def code
  @code
end

- (Object) content

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



44
45
46
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 44

def content
  @content
end

- (Object) 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.



21
22
23
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 21

def description
  @description
end

- (Object) empty_content

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 thetemplate eventually).



29
30
31
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 29

def empty_content
  @empty_content
end

- (Object) enabled_editing

Specifies if the editing of the new sheet content in visual is disabled. When false is set, the sheet content cannot be modified in editing or interactive mode (except the elements that have the attribute enabledEditing set to true). The attribute does not block modifying sheet content through API. The default value is true.



59
60
61
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 59

def enabled_editing
  @enabled_editing
end

- (Object) 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, thesheet must be visible.



33
34
35
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 33

def main
  @main
end

- (Object) 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 createcommand fails.



11
12
13
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 11

def name
  @name
end

- (Object) 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 sheetsare shifted to the right (adds one to their order).



41
42
43
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 41

def order
  @order
end

- (Object) template_uri

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



25
26
27
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 25

def template_uri
  @template_uri
end

- (Object) version_label

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



48
49
50
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 48

def version_label
  @version_label
end

- (Object) 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. Whenfalse is set, the sheet must not be set as the main of the specified artifact.



53
54
55
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 53

def visible
  @visible
end

- (Object) width

Flag of width sheet.



62
63
64
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_create.rb', line 62

def width
  @width
end