Class: Crm::Collection

Inherits:
Crm::Core::BasicResource show all
Extended by:
Crm::Core::Mixins::Findable::ClassMethods, Crm::Core::Mixins::Modifiable::ClassMethods, Crm::Core::Mixins::Searchable::ClassMethods
Includes:
Crm::Core::Mixins::ChangeLoggable, Crm::Core::Mixins::Findable, Crm::Core::Mixins::Inspectable, Crm::Core::Mixins::Modifiable, Crm::Core::Mixins::Searchable
Defined in:
lib/crm/collection.rb

Overview

A JustRelate WebCRM collection is a saved search. To execute such a saved search, call #compute. The results are persisted and can be accessed by means of #output_items. Output items can be accounts, contacts, activities, and events.

Instance Method Summary collapse

Methods included from Crm::Core::Mixins::Findable::ClassMethods

find

Methods included from Crm::Core::Mixins::Modifiable::ClassMethods

create

Methods included from Crm::Core::Mixins::Searchable::ClassMethods

all, first, query, search_configurator, where, where_not

Methods included from Crm::Core::Mixins::Inspectable

#inspect

Methods included from Crm::Core::Mixins::ChangeLoggable

#changes

Methods included from Crm::Core::Mixins::Modifiable

#delete, #update

Methods inherited from Crm::Core::BasicResource

base_type, #eql?, #id, path, #path, #reload, resource_name, #type

Methods included from Crm::Core::Mixins::AttributeProvider

#[], #attributes, #initialize, #method_missing, #methods, #raw, #respond_to_missing?

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Crm::Core::Mixins::AttributeProvider

Instance Method Details

#compute ⇒ self

Computes this collection.

Returns:

  • (self) 


22
23
24
 
# File 'lib/crm/collection.rb', line 22

def compute
  load_attributes(Core::RestApi.instance.put("#{path}/compute", {}))
end

#output_ids ⇒ Array<String>

Returns the IDs resulting from the computation.

Returns:

  • (Array<String>) 


29
30
31
 
# File 'lib/crm/collection.rb', line 29

def output_ids
  Core::RestApi.instance.get("#{path}/output_ids")
end

#output_items ⇒ Core::ItemEnumerator

Returns an ItemEnumerator that provides access to the items of #output_ids.

Returns:



37
38
39
 
# File 'lib/crm/collection.rb', line 37

def output_items
  Core::ItemEnumerator.new(output_ids)
end