Class: UU::OS::Attachment::AttachmentCreate

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os_client-0.10.6/lib/uu/os/attachment/attachment_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 attachment. When nil 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.



13
14
15
 
# File 'uu_os_client-0.10.6/lib/uu/os/attachment/attachment_create.rb', line 13

def code
  @code
end

- (Object) data

Attachment data. When nil is set, the create command fails. Accepted values are String, IO, File or instance of BinaryValue. If use BinaryValue attachment file name can be set by attribute :name of it.



29
30
31
 
# File 'uu_os_client-0.10.6/lib/uu/os/attachment/attachment_create.rb', line 29

def data
  @data
end

- (Object) description

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



24
25
26
 
# File 'uu_os_client-0.10.6/lib/uu/os/attachment/attachment_create.rb', line 24

def description
  @description
end

- (Object) name

Name of the new attachment. When nil is set, the file name from data is used (and a suffix is added to the name from data if needed to ensure the name uniqueness.) The name must be unique in a given artifact, otherwise the create command fails.



19
20
21
 
# File 'uu_os_client-0.10.6/lib/uu/os/attachment/attachment_create.rb', line 19

def name
  @name
end

- (Object) version_label

Version label of the created attachment version. When nil is set, versionLabel is left empty.



33
34
35
 
# File 'uu_os_client-0.10.6/lib/uu/os/attachment/attachment_create.rb', line 33

def version_label
  @version_label
end