Contents

class Landslider

	class WsSearch
		
		# @param [Hash] params
		# An optional Hash to specify first_result_position and total_results_requested
		def initialize(params={})
		    @first_result_position = params.fetch(:first_result_position) if params.key?(:first_result_position)
		    @total_results_requested = params.fetch(:total_results_requested) if params.key?(:total_results_requested)
		end
		
		# @param [Integer] value num
		# Sets the starting index of records you want to retrieve. defaults to 1
		attr_writer :first_result_position
		
		# @param [Integer] value num
		# Sets the maximum number of records to retrieve. defaults to 25
		attr_writer :total_results_requested
		
		# @param [String] value date
		# Sets a Date to search records updated on or after
		attr_writer :updated_on
		
		# @param [String] value
		# system source id search?
		attr_writer :source_id
		
		# @param [Boolean] value
		attr_writer :return_deleted_records, :allow_duplicate_criterion
		
		# @param [WsSearchCriterion] value 
		# WsSearchCriterion is only documented to work with these APIs
		# * getAccounts
		# * getOpportunities
		# * getProductFamilies
		# * GetDurationTypes
		attr_writer :search_criteria
	
		# Adds the search xml
		# @param [Handsoap::XmlMason::Node] msg
		# @return [Handsoap::XmlMason::Node]
		def soapify_for(msg)
			msg.add 'firstResultPosition', @first_result_position || DEFAULT_FIRST_RESULT_POSITION
			msg.add 'totalResultsRequested', @total_results_requested || DEFAULT_TOTAL_RESULTS_REQUESTED
			msg.add 'updatedOn', @updated_on unless @updated_on.nil?
			unless @search_criteria.nil?
				@search_criteria.soapify_for(msg)
			end
		
		end

	end

end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
landslider-0.5.11	lib/landslider/entities/ws_search.rb
landslider-0.5.9	lib/landslider/entities/ws_search.rb