Class: Tataru::BaseResourceDesc

Inherits:
Object
  • Object
show all
Defined in:
lib/tataru/base_resource_desc.rb

Overview

description of a resource

Instance Method Summary collapse

Instance Method Details

#delete_at_end? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/tataru/base_resource_desc.rb', line 31

def delete_at_end?
  false # if true moves deletes to end of program
end

#immutable_fields ⇒ Object 



15
16
17
 
# File 'lib/tataru/base_resource_desc.rb', line 15

def immutable_fields
  [] # fields that cannot be passed in to update but can be passed to create
end

#mutable_fields ⇒ Object 



11
12
13
 
# File 'lib/tataru/base_resource_desc.rb', line 11

def mutable_fields
  [] # fields that can be passed in to create and update
end

#needs_remote_id? ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/tataru/base_resource_desc.rb', line 27

def needs_remote_id?
  false # true if resource requires a remote id
end

#output_fields ⇒ Object 



19
20
21
 
# File 'lib/tataru/base_resource_desc.rb', line 19

def output_fields
  [] # fields that cannot be passed in to create or update
end

#required_fields ⇒ Object 



23
24
25
 
# File 'lib/tataru/base_resource_desc.rb', line 23

def required_fields
  [] # mutable or immutable fields that cannot be omitted
end

#resource_class ⇒ Object 



6
7
8
9
 
# File 'lib/tataru/base_resource_desc.rb', line 6

def resource_class
  # returns the class of the resource
  BaseResource
end