Class: UU::OS::Sheet::SheetSetAttributes

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os-0.29.16/lib/uu/os/sheet/sheet_set_attributes.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

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 setAttributescommand fails.



14
15
16
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_set_attributes.rb', line 14

def code
  @code
end

- (Object) description

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



37
38
39
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_set_attributes.rb', line 37

def description
  @description
end

- (Object) enabled_editing

Flag indicating if sheet can be edited in visual. Attribute is not modified when null is set.



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

def enabled_editing
  @enabled_editing
end

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



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

def main
  @main
end

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



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

def name
  @name
end

- (Object) 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 atthat position (if any) and any subsequent sheets are shifted to the right (adds one to their order).



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

def order
  @order
end

- (Object) 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 sheetmust not be set as the main of the specified artifact.



27
28
29
 
# File 'uu_os-0.29.16/lib/uu/os/sheet/sheet_set_attributes.rb', line 27

def visible
  @visible
end

- (Object) width

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



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

def width
  @width
end