Class: Notesgrip::NotesDocumentCollection

Inherits:
GripWrapper
  • Object
show all
Includes:
DocCollection
Defined in:
lib/notesgrip/NotesDocument.rb

Overview

NotesDocumentCollection Class ===============

Instance Method Summary collapse

Methods included from DocCollection

#GetFirstDocument, #GetLastDocument, #GetNextDocument, #GetNthDocument, #GetPrevDocument, #[], #each_document

Methods inherited from GripWrapper

#initialize, #raw

Constructor Details

This class inherits a constructor from Notesgrip::GripWrapper

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Notesgrip::GripWrapper

Instance Method Details

#AddDocument(document) ⇒ Object 



202
203
204
205
 
# File 'lib/notesgrip/NotesDocument.rb', line 202

def AddDocument( document)
  raw_doc = toRaw(document)
  @raw_object.AddDocument(raw_doc)
end

#Clone ⇒ Object 



207
208
209
 
# File 'lib/notesgrip/NotesDocument.rb', line 207

def Clone()
   NotesDocumentCollection.new(@raw_object.Clone())
end

#Contains(inputNotes) ⇒ Object 



211
212
213
214
 
# File 'lib/notesgrip/NotesDocument.rb', line 211

def Contains( inputNotes )
  raw_obj = toRaw(inputNotes)
  @raw_object.Contains(raw_obj)
end

#Count ⇒ Object Also known as: size 



193
194
195
 
# File 'lib/notesgrip/NotesDocument.rb', line 193

def Count
  @raw_object.count
end

#DeleteDocument(document) ⇒ Object 



216
217
218
219
 
# File 'lib/notesgrip/NotesDocument.rb', line 216

def DeleteDocument( document )
  raw_doc = toRaw(document)
  @raw_object.DeleteDocument(raw_doc)
end

#FTSearch(query, maxDocs) ⇒ Object 



221
222
223
224
 
# File 'lib/notesgrip/NotesDocument.rb', line 221

def FTSearch( query, maxDocs )
  raw_docCollection = @raw_object.FTSearch( query, maxDocs )
  FTSearch( raw_docCollection )
end

#GetDocument(document) ⇒ Object 



226
227
228
229
230
 
# File 'lib/notesgrip/NotesDocument.rb', line 226

def GetDocument( document )
  raw_doc = toRaw(document)
  raw_doc2 = @raw_object.GetDocument(raw_doc)
  raw_doc2 ? NotesDocument.new(raw_doc2) : nil
end

#inspect ⇒ Object

—- Additional Methods ——



253
254
255
 
# File 'lib/notesgrip/NotesDocument.rb', line 253

def inspect
  "<#{self.class}, Count:#{self.Count}>"
end

#Intersect(inputNotes) ⇒ Object 



232
233
234
235
 
# File 'lib/notesgrip/NotesDocument.rb', line 232

def Intersect( inputNotes )
  raw_obj = toRaw(inputNotes)
  @raw_object.Intersect(raw_obj)
end

#Merge(inputNotes) ⇒ Object 



237
238
239
240
 
# File 'lib/notesgrip/NotesDocument.rb', line 237

def Merge( inputNotes )
  raw_obj = toRaw(inputNotes)
  @raw_object.Merge(raw_obj)
end

#Parent ⇒ Object 



198
199
200
 
# File 'lib/notesgrip/NotesDocument.rb', line 198

def Parent
  NotesDatabase.new(@raw_object.Parent)
end

#StampAllMulti(document) ⇒ Object 



242
243
244
245
 
# File 'lib/notesgrip/NotesDocument.rb', line 242

def StampAllMulti( document )
  raw_doc = toRaw(document)
  @raw_object.StampAllMulti(raw_doc)
end

#Subtract(inputNotes) ⇒ Object 



247
248
249
250
 
# File 'lib/notesgrip/NotesDocument.rb', line 247

def Subtract( inputNotes )
  raw_obj = toRaw(inputNotes)
  @raw_object.Subtract(raw_obj)
end