Class: OLE_QA::Framework::Subline_Object

Inherits:

Data_Object

• Object
• Common_Object
• Data_Object
• OLE_QA::Framework::Subline_Object

Defined in:

lib/common/subline_object.rb

Overview

A Data Object in OLE that represents a line nested under another line. A subline can usually be added or deleted, and has element identifiers which vary dependent upon the line below which they are nested.

Direct Known Subclasses

OLEFS::Accounting_Line, OLEFS::Copies_Line, OLEFS::Exception_Notes_Line, OLEFS::Invoice_Notes_Line, OLEFS::New_Accounting_Line, OLEFS::New_Copies_Line, OLEFS::New_Exception_Notes_Line, OLEFS::New_Invoice_Notes_Line, OLEFS::New_Notes_Line, OLEFS::New_Receipt_Notes_Line, OLEFS::Notes_Line, OLEFS::Processing_Line, OLEFS::Receipt_Notes_Line, OLELS::Ownership_Note

Instance Attribute Summary

• #line_id ⇒ Object readonly

  Returns the value of attribute line_id.

• #line_number ⇒ Object readonly

  The line number that this object will have on the screen.

• #subline_id ⇒ Object readonly

  Returns the value of attribute subline_id.

• #subline_number ⇒ Object readonly

  The line number that this subline object will have on the screen.

Attributes inherited from Common_Object

#elements, #functions, #ole

Instance Method Summary

• #initialize(ole_session, line_number = 1, subline_number = 1) ⇒ Subline_Object constructor

  A new instance of Subline_Object.

• #set_elements ⇒ Object

  Set elements on the subline object.

Methods inherited from Common_Object

#set_functions

Methods included from Helpers

#browser, #load_yml, #set_element, #set_function

Constructor Details

#initialize(ole_session, line_number = 1, subline_number = 1) ⇒ Subline_Object

Returns a new instance of Subline_Object.

Parameters:

• ole_session (Object) —

  The OLE_QA::Framework::Session session to pass to the Data Object.

• line_number (Fixnum) (defaults to: 1) —

  The line number this subline object will use for element definitions.

• subline_number (Fixnum) (defaults to: 1) —

  The subline number this subline object will use for element definitions.

# File 'lib/common/subline_object.rb', line 34

def initialize(ole_session, line_number = 1, subline_number = 1)
  @line_number, @subline_number = line_number, subline_number
  @line_id = line_number -1
  @subline_id = subline_number -1
  super(ole_session)
end

Instance Attribute Details

#line_id ⇒ Object (readonly)

Returns the value of attribute line_id.

# File 'lib/common/subline_object.rb', line 24

def line_id
  @line_id
end

#line_number ⇒ Object (readonly)

The line number that this object will have on the screen.

• Used for line identifier replacement.

# File 'lib/common/subline_object.rb', line 23

def line_number
  @line_number
end

#subline_id ⇒ Object (readonly)

Returns the value of attribute subline_id.

# File 'lib/common/subline_object.rb', line 29

def subline_id
  @subline_id
end

#subline_number ⇒ Object (readonly)

The line number that this subline object will have on the screen.

• Used for subline identifier replacement.

# File 'lib/common/subline_object.rb', line 28

def subline_number
  @subline_number
end

Instance Method Details

#set_elements ⇒ Object

Note:

Use line_number, line_id, subline_number, and subline_id to replace dynamic identifier numbers. (See Line_Object#set_elements for more on line number substitution.)

Set elements on the subline object.

# File 'lib/common/subline_object.rb', line 44

def set_elements
end