Class: Notesgrip::NotesView

Inherits:
GripWrapper show all
Includes:
DocCollection
Defined in:
lib/notesgrip/NotesView.rb

Overview

NotesView Class ===================

Instance Method Summary collapse

Methods included from DocCollection

#[], #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

#AllEntries ⇒ Object 



8
9
10
 
# File 'lib/notesgrip/NotesView.rb', line 8

def AllEntries
  NotesViewEntryCollection.new(@raw_object.AllEntries)
end

#ColumnNames ⇒ Object 



12
13
14
15
 
# File 'lib/notesgrip/NotesView.rb', line 12

def ColumnNames
  #@raw_object.ColumnNames
  raise "ColumnNames() is not work."
end

#Columns ⇒ Object 



17
18
19
20
21
22
23
24
25
 
# File 'lib/notesgrip/NotesView.rb', line 17

def Columns
  ret_list = []
  columns = @raw_object.Columns
  return [] unless columns
  columns.each {|raw_column|
    ret_list.push NotesViewColumn.new(raw_column)
  }
  ret_list
end

#CopyColumn(sourceColumn, destinationIndex = nil) ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/notesgrip/NotesView.rb', line 36

def CopyColumn( sourceColumn, destinationIndex=nil )
  #raw_object = toRaw(sourceColumn)
  #raw_viewColumn = @raw_object.CopyColumn(sourceColumn, destinationIndex)
  #raw_viewColumn ? NotesViewColumn.new(raw_viewColumn) : nil
  raise "CopyColumn() is not work."
end

#count ⇒ Object Also known as: size 



187
188
189
 
# File 'lib/notesgrip/NotesView.rb', line 187

def count
  self.AllEntries.Count
end

#CreateColumn(position = nil, columnName = nil, formula = nil) ⇒ Object 



43
44
45
46
47
 
# File 'lib/notesgrip/NotesView.rb', line 43

def CreateColumn( position=nil, columnName=nil, formula=nil )
  #raw_viewColumn = @raw_object.CreateColumn( position, columnName, formula )
  #raw_viewColumn ? NotesViewColumn.new(raw_viewColumn) : nil
  raise "CreateColumn() is not work."
end

#CreateViewNav(cacheSize = 128) ⇒ Object 



49
50
51
52
 
# File 'lib/notesgrip/NotesView.rb', line 49

def CreateViewNav( cacheSize=128 )
  raw_viewNavigator = @raw_object.CreateViewNav( cacheSize )
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFrom(navigatorObject, cacheSize = 128) ⇒ Object 



54
55
56
57
58
 
# File 'lib/notesgrip/NotesView.rb', line 54

def CreateViewNavFrom( navigatorObject, cacheSize=128 )
  raw_entry = toRaw(navigatorObject)
  raw_viewNavigator = @raw_object.CreateViewNavFrom( raw_entry, cacheSize)
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFromAllUnread(username = nil) ⇒ Object 



60
61
62
63
 
# File 'lib/notesgrip/NotesView.rb', line 60

def CreateViewNavFromAllUnread( username=nil )
  raw_viewNavigator = @raw_object.CreateViewNavFromAllUnread( username )
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFromCategory(category, cacheSize = 128) ⇒ Object 



65
66
67
68
 
# File 'lib/notesgrip/NotesView.rb', line 65

def CreateViewNavFromCategory( category, cacheSize=128 )
  raw_viewNavigator = @raw_object.CreateViewNavFromCategory( category, cacheSize)
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavFromDescendants(navigatorObject, cacheSize = 128) ⇒ Object 



70
71
72
73
74
 
# File 'lib/notesgrip/NotesView.rb', line 70

def CreateViewNavFromDescendants( navigatorObject, cacheSize=128 )
  raw_obj = toRaw(navigatorObject)
  raw_viewNavigator = @raw_object.CreateViewNavFromDescendants( raw_obj, cacheSize )
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#CreateViewNavMaxLevel(level, cacheSize = 128) ⇒ Object 



76
77
78
79
 
# File 'lib/notesgrip/NotesView.rb', line 76

def CreateViewNavMaxLevel( level, cacheSize=128 )
  raw_viewNavigator = @raw_object.CreateViewNavMaxLevel( level, cacheSize )
  raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
end

#each_column ⇒ Object 



179
180
181
182
183
 
# File 'lib/notesgrip/NotesView.rb', line 179

def each_column
  self.Columns.each {|column|
    yield column
  }
end

#each_entry ⇒ Object

—— Additional Methods —–



173
174
175
176
177
 
# File 'lib/notesgrip/NotesView.rb', line 173

def each_entry
  self.AllEntries.each {|entry|
    yield entry
  }
end

#FTSearch(query, maxDocs = 0) ⇒ Object 



81
82
83
 
# File 'lib/notesgrip/NotesView.rb', line 81

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

#GetAllDocumentsByKey(keyArray, exactMatch = false) ⇒ Object 



85
86
87
88
 
# File 'lib/notesgrip/NotesView.rb', line 85

def GetAllDocumentsByKey( keyArray , exactMatch = false )
  raw_docCollection = @raw_object.GetAllDocumentsByKey( keyArray , exactMatch)
  NotesDocumentCollection.new(raw_docCollection)
end

#GetAllEntriesByKey(keyArray, exactMatch = false) ⇒ Object 



90
91
92
93
 
# File 'lib/notesgrip/NotesView.rb', line 90

def GetAllEntriesByKey( keyArray , exactMatch=false )
  raw_viewEntryCollection = @raw_object.GetAllEntriesByKey( keyArray , exactMatch)
  NotesViewEntryCollection.new(raw_viewEntryCollection)
end

#GetAllReadEntries(username = nil) ⇒ Object 



95
96
97
98
 
# File 'lib/notesgrip/NotesView.rb', line 95

def GetAllReadEntries( username=nil )
  raw_viewEntryCollection = @raw_object.GetAllReadEntries( username)
  NotesViewEntryCollection.new(raw_viewEntryCollection)
end

#GetAllUnreadEntries(username = nil) ⇒ Object 



100
101
102
103
 
# File 'lib/notesgrip/NotesView.rb', line 100

def GetAllUnreadEntries( username=nil )
  raw_viewEntryCollection = @raw_object.GetAllUnreadEntries( username)
  NotesViewEntryCollection.new(raw_viewEntryCollection)
end

#GetChild(document) ⇒ Object 



105
106
107
108
109
 
# File 'lib/notesgrip/NotesView.rb', line 105

def GetChild( document )
  raw_doc = toRaw(document)
  raw_respdoc = @raw_object.GetChild(raw_doc)
  raw_respdoc ? NotesDocument.new(raw_rspdoc) : nil
end

#GetColumn(columnNumber) ⇒ Object 



111
112
113
114
115
 
# File 'lib/notesgrip/NotesView.rb', line 111

def GetColumn( columnNumber )
  #raw_viewColumn = @raw_object.GetColumn(columnNumber)
  #NotesViewColumn.new(raw_viewColumn)
  raise "GetColumn() is not work."
end

#GetDocumentByKey(keyArray, exactMatch = false) ⇒ Object 



117
118
119
120
 
# File 'lib/notesgrip/NotesView.rb', line 117

def GetDocumentByKey( keyArray, exactMatch=false )
  raw_doc = @raw_object.GetDocumentByKey( keyArray, exactMatch )
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#GetEntryByKey(keyArray, exactMatch = false) ⇒ Object 



122
123
124
125
 
# File 'lib/notesgrip/NotesView.rb', line 122

def GetEntryByKey( keyArray, exactMatch=false )
  raw_viewEntry = @raw_object.GetEntryByKey( keyArray, exactMatch)
  NotesViewEntry.new(raw_viewEntry)
end

#GetFirstDocument ⇒ Object 



127
128
129
130
 
# File 'lib/notesgrip/NotesView.rb', line 127

def GetFirstDocument
  raw_doc = @raw_object.GetFirstDocument()
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#GetLastDocument ⇒ Object 



132
133
134
135
 
# File 'lib/notesgrip/NotesView.rb', line 132

def GetLastDocument
  raw_doc = @raw_object.GetLastDocument()
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#GetNextDocument(document) ⇒ Object 



137
138
139
140
141
 
# File 'lib/notesgrip/NotesView.rb', line 137

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

#GetNextSibling(document) ⇒ Object 



143
144
145
146
147
 
# File 'lib/notesgrip/NotesView.rb', line 143

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

#GetNthDocument(index) ⇒ Object 



149
150
151
152
 
# File 'lib/notesgrip/NotesView.rb', line 149

def GetNthDocument(index)
  raw_doc = @raw_object.GetNthDocument(index)
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#GetParentDocument(document) ⇒ Object 



154
155
156
157
158
 
# File 'lib/notesgrip/NotesView.rb', line 154

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

#GetPrevDocument(document) ⇒ Object 



160
161
162
163
164
 
# File 'lib/notesgrip/NotesView.rb', line 160

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

#GetPrevSibling(document) ⇒ Object 



166
167
168
169
170
 
# File 'lib/notesgrip/NotesView.rb', line 166

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

#inspect ⇒ Object 



192
193
194
 
# File 'lib/notesgrip/NotesView.rb', line 192

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

#Parent ⇒ Object 



27
28
29
 
# File 'lib/notesgrip/NotesView.rb', line 27

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

#UniversalID ⇒ Object Also known as: UNID 



31
32
33
 
# File 'lib/notesgrip/NotesView.rb', line 31

def UniversalID
  @raw_object.UniversalID
end