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 



431
432
433
434
 
# File 'lib/notesgrip/NotesDocument.rb', line 431

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

#Clone ⇒ Object 



436
437
438
 
# File 'lib/notesgrip/NotesDocument.rb', line 436

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

#Contains(inputNotes) ⇒ Object 



440
441
442
443
 
# File 'lib/notesgrip/NotesDocument.rb', line 440

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

#Count ⇒ Object Also known as: size 



422
423
424
 
# File 'lib/notesgrip/NotesDocument.rb', line 422

def Count
  @raw_object.count
end

#DeleteDocument(document) ⇒ Object 



445
446
447
448
 
# File 'lib/notesgrip/NotesDocument.rb', line 445

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

#FTSearch(query, maxDocs) ⇒ Object 



450
451
452
453
 
# File 'lib/notesgrip/NotesDocument.rb', line 450

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

#GetDocument(document) ⇒ Object 



455
456
457
458
459
 
# File 'lib/notesgrip/NotesDocument.rb', line 455

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 ——



482
483
484
 
# File 'lib/notesgrip/NotesDocument.rb', line 482

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

#Intersect(inputNotes) ⇒ Object 



461
462
463
464
 
# File 'lib/notesgrip/NotesDocument.rb', line 461

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

#IsSorted ⇒ Object

—- Simple Method Relay —-



487
488
489
 
# File 'lib/notesgrip/NotesDocument.rb', line 487

def IsSorted()
  @raw_object.IsSorted()
end

#MarkAllRead(username = nil) ⇒ Object 



499
500
501
 
# File 'lib/notesgrip/NotesDocument.rb', line 499

def MarkAllRead(username=nil)
  @raw_object.MarkAllRead(username)
end

#MarkAllUnread(username = nil) ⇒ Object 



503
504
505
 
# File 'lib/notesgrip/NotesDocument.rb', line 503

def MarkAllUnread(username=nil)
  @raw_object.MarkAllUnread(username)
end

#Merge(inputNotes) ⇒ Object 



466
467
468
469
 
# File 'lib/notesgrip/NotesDocument.rb', line 466

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

#Parent ⇒ Object 



427
428
429
 
# File 'lib/notesgrip/NotesDocument.rb', line 427

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

#PutAllInFolder(folderName, createonfail = true) ⇒ Object 



507
508
509
 
# File 'lib/notesgrip/NotesDocument.rb', line 507

def PutAllInFolder(folderName, createonfail=true)
  @raw_object.PutAllInFolder(folderName, createonfail)
end

#Query ⇒ Object 



491
492
493
 
# File 'lib/notesgrip/NotesDocument.rb', line 491

def Query()
  @raw_object.Query()
end

#RemoveAll(force = true) ⇒ Object 



511
512
513
 
# File 'lib/notesgrip/NotesDocument.rb', line 511

def RemoveAll(force=true)
  @raw_object.RemoveAll(force)
end

#RemoveAllFromFolder(folderName) ⇒ Object 



515
516
517
 
# File 'lib/notesgrip/NotesDocument.rb', line 515

def RemoveAllFromFolder(folderName)
  @raw_object.RemoveAllFromFolder(folderName)
end

#StampAll(itemname, value) ⇒ Object 



519
520
521
 
# File 'lib/notesgrip/NotesDocument.rb', line 519

def StampAll(itemname, value)
  @raw_object.StampAll()
end

#StampAllMulti(document) ⇒ Object 



471
472
473
474
 
# File 'lib/notesgrip/NotesDocument.rb', line 471

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

#Subtract(inputNotes) ⇒ Object 



476
477
478
479
 
# File 'lib/notesgrip/NotesDocument.rb', line 476

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

#UntilTime ⇒ Object 



495
496
497
 
# File 'lib/notesgrip/NotesDocument.rb', line 495

def UntilTime()
  @raw_object.UntilTime()
end

#UpdateAll ⇒ Object 



523
524
525
 
# File 'lib/notesgrip/NotesDocument.rb', line 523

def UpdateAll()
  @raw_object.UpdateAll()
end