Module: OracleOWS::Common

Included in:
Base
Defined in:
lib/oracle_ows/common.rb

Overview

common methods to include in all classes

Instance Attribute Summary collapse

Instance Attribute Details

#namespacesHash

# @return [OracleOws::Base] base class object holds connection parameters attr_accessor :base #namespaces= writer method adds more namespaces to the hash

Returns:

  • (Hash)

    XML namesspaces as hash



26
27
28
# File 'lib/oracle_ows/common.rb', line 26

def namespaces
  @namespaces
end

#passwordString, Hash

Returns:

  • (String)

    url => base URL for the API endpoint

  • (String)

    username => login to use like ENV

  • (String)

    password => password to use like ENV

  • (Hash)

    namespaces => a hash of XML namespaces for SOAP header

    Example: {

    'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
    'xmlns:cor' => 'http://webservices.micros.com/og/4.3/Core/'
    

    }



21
22
23
# File 'lib/oracle_ows/common.rb', line 21

def password
  @password
end

#urlString, Hash

Returns:

  • (String)

    url => base URL for the API endpoint

  • (String)

    username => login to use like ENV

  • (String)

    password => password to use like ENV

  • (Hash)

    namespaces => a hash of XML namespaces for SOAP header

    Example: {

    'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
    'xmlns:cor' => 'http://webservices.micros.com/og/4.3/Core/'
    

    }



21
22
23
# File 'lib/oracle_ows/common.rb', line 21

def url
  @url
end

#usernameString, Hash

Returns:

  • (String)

    url => base URL for the API endpoint

  • (String)

    username => login to use like ENV

  • (String)

    password => password to use like ENV

  • (Hash)

    namespaces => a hash of XML namespaces for SOAP header

    Example: {

    'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
    'xmlns:cor' => 'http://webservices.micros.com/og/4.3/Core/'
    

    }



21
22
23
# File 'lib/oracle_ows/common.rb', line 21

def username
  @username
end