Class: RedSnow::Parameter

Inherits:

NamedBlueprintNode

• Object
• BlueprintNode
• NamedBlueprintNode
• RedSnow::Parameter

show all

Defined in:

lib/redsnow/blueprint.rb

Overview

Instance Attribute Summary (collapse)

• - (String) default_value

  default value of the parameter or nil This is a value used when the parameter is ommited in the request.

• - (String) description inherited from NamedBlueprintNode

  description of the node.

• - (String) example_value

  example value of the parameter or nil.

• - (String) name inherited from NamedBlueprintNode

  name of the node.

• - (String) type

  an arbitrary type of the parameter or nil.

• - (Symbol) use

  parameter necessity flag, :required or :optional.

• - (Array<String>) values

  an enumeration of possible parameter values.

Instance Method Summary (collapse)

• - (Parameter) initialize(sc_parameter_handle) constructor

  A new instance of Parameter.

120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# File 'lib/redsnow/blueprint.rb', line 120

def initialize(sc_parameter_handle)
  @name = RedSnow::Binding.sc_parameter_name(sc_parameter_handle)
  @description = RedSnow::Binding.sc_parameter_description(sc_parameter_handle)
  @type = RedSnow::Binding.sc_parameter_type(sc_parameter_handle)
  @use =  RedSnow::Binding.sc_parameter_parameter_use(sc_parameter_handle)
  @default_value = RedSnow::Binding.sc_parameter_default_value(sc_parameter_handle)
  @example_value = RedSnow::Binding.sc_parameter_example_value(sc_parameter_handle)
  @values = Array.new
  sc_value_collection_handle = RedSnow::Binding.sc_value_collection_handle(sc_parameter_handle)
  sc_value_collection_size = RedSnow::Binding.sc_value_collection_size(sc_value_collection_handle)
  if sc_value_collection_size > 0
    values_size = sc_value_collection_size - 1
    for valueIndex in 0..values_size do
      sc_value_handle = RedSnow::Binding.sc_value_handle(sc_value_collection_handle, valueIndex)
      value = RedSnow::Binding.sc_value_string(sc_value_handle)
      @values << value
    end
  end
end

112
113
114

# File 'lib/redsnow/blueprint.rb', line 112

def default_value
  @default_value
end

112
113
114

# File 'lib/redsnow/blueprint.rb', line 112

def example_value
  @example_value
end

112
113
114

# File 'lib/redsnow/blueprint.rb', line 112

def type
  @type
end

112
113
114

# File 'lib/redsnow/blueprint.rb', line 112

def use
  @use
end

112
113
114

# File 'lib/redsnow/blueprint.rb', line 112

def values
  @values
end