Class: Notesgrip::NotesDatabase

Inherits:
GripWrapper show all
Defined in:
lib/notesgrip/NotesDatabase.rb

Overview

NotesDatabase Class ===============

Constant Summary collapse

ACLLEVEL_NOACCESS = 
0
ACLLEVEL_DEPOSITOR = 
1
ACLLEVEL_READER = 
2
ACLLEVEL_AUTHOR = 
3
ACLLEVEL_EDITOR = 
4
ACLLEVEL_DESIGNER = 
5
ACLLEVEL_MANAGER = 
6
DBMOD_DOC_ACL = 
64
DBMOD_DOC_AGENT = 
512
DBMOD_DOC_ALL = 
32767
DBMOD_DOC_DATA = 
1
DBMOD_DOC_FORM = 
4
DBMOD_DOC_HELP = 
256
DBMOD_DOC_ICON = 
16
DBMOD_DOC_REPLFORMULA = 
2048
DBMOD_DOC_SHAREDFIELD = 
1024
DBMOD_DOC_VIEW = 
8
FTINDEX_DAILY = 
1
FTINDEX_HOURLY = 
3
FTINDEX_IMMEDIATE = 
4
FTINDEX_SCHEDULED = 
2
DBTYPE_ADDR_BOOK =

Domino Directory or Personal Address Book

10
DBTYPE_IMAP_SVR_PROXY =

IMAP server proxy

6
DBTYPE_LIBRARY =

database library

12
DBTYPE_LIGHT_ADDR_BOOK =

Directory Catalog

9
DBTYPE_MAILBOX =

mailbox

3
DBTYPE_MAILFILE =

mail file

2
DBTYPE_MULTIDB_SRCH =

Domain Catalog

8
DBTYPE_NEWS_SVR_PROXY =

news server proxy

5
DBTYPE_PERS_JOURNAL =

Personal Journal

11
DBTYPE_PORTFOLIO =

portfolio

7
DBTYPE_STANDARD =

standard

13
DBTYPE_SUBSCRIPTIONS =

subscriptions

4
DBTYPE_WEB_APP =

Web application

1
CMPC_ARCHIVE_DELETE_COMPACT =

archive and delete, then compact

1
CMPC_ARCHIVE_DELETE_ONLY =

archive and delete with no compact; supersedes a

2
CMPC_CHK_OVERLAP =

check overlap

32768
CMPC_COPYSTYLE =

copy style; supersedes b and B

16
CMPC_DISABLE_DOCTBLBIT_OPTMZN =

disable document table bit map optimization

128
CMPC_DISABLE_LARGE_UNKTBL =

disable large unknown table

4096
CMPC_DISABLE_RESPONSE_INFO =

disable “Don’t support specialized response hierarchy”

512
CMPC_DISABLE_TRANSACTIONLOGGING =

disable transaction logging

262144
CMPC_DISABLE_UNREAD_MARKS =

disable “Don’t maintain unread marks”

1048576
CMPC_DISCARD_VIEW_INDICES =

discard view indexes

32
CMPC_ENABLE_DOCTBLBIT_OPTMZN =

enable document table bit map optimization; supersedes f

64
CMPC_ENABLE_LARGE_UNKTBL =

enable large unknown table; supersedes k

2048
CMPC_ENABLE_RESPONSE_INFO =

enable “Don’t support specialized response hierarchy”; supersedes H

256
CMPC_ENABLE_TRANSACTIONLOGGING =

enable transaction logging; supersedes t

131072
CMPC_ENABLE_UNREAD_MARKS =

enable “Don’t maintain unread marks”; supersedes U

524288
CMPC_IGNORE_COPYSTYLE_ERRORS =

ignore copy-style errors

1024
CMPC_MAX_4GB =

set maximum database size at 4 gigabytes

16384
CMPC_NO_LOCKOUT =

do not lock out users

8192
CMPC_RECOVER_INPLACE =

recover unused space in-place and reduce file size; supersedes b

8
CMPC_RECOVER_REDUCE_INPLACE =

recover unused space in-place without reducing file size

4
CMPC_REVERT_FILEFORMAT =

do not convert old file format

65536
FTINDEX_ALL_BREAKS =

index sentence and paragraph breaks

4
FTINDEX_ATTACHED_BIN_FILES =

index attached files (binary)

16
FTINDEX_ATTACHED_FILES =

index attached files (raw text)

1
FTINDEX_CASE_SENSITIVE =

enable case-sensitive searches

8
FTINDEX_ENCRYPTED_FIELDS =

index encrypted fields

2
FIXUP_INCREMENTAL =

checks only documents since last Fixup

4
FIXUP_NODELETE =

prevents Fixup from deleting corrupted documents

16
FIXUP_NOVIEWS =

does not check views

64
FIXUP_QUICK =

checks documents more quickly but less thoroughly

2
FIXUP_REVERT =

reverts ID tables to the previous release format

32
FIXUP_TXLOGGED =

includes databases enabled for transaction logging

8
FIXUP_VERIFY =

makes no modifications

1
FT_DATE_ASC =

Constant for FTSearch

64
FT_DATE_DES =

sorts by document creation date in ascending order.

32
FT_SCORES =

sorts by document creation date in descending order.

8
FT_DATABASE =

sorts by relevance score (default).

8192
FT_FUZZY =

includes Domino databases.

16384
FT_FILESYSTEM =

searches for related words. Need not be an exact match.

4096
FT_STEMS =

includes files that are not Domino databases.

512
FT_THESAURUS =

uses stem words as the basis of the search.

1024
DBOPT_LZCOMPRESSION =

uses LZ1 compression for attachments

65
DBOPT_MAINTAINLASTACCESSED =

maintains LastAccessed property

44
DBOPT_MOREFIELDS =

allows more fields in database

54
DBOPT_NOHEADLINEMONITORS =

doesn’t allow headline monitoring

46
DBOPT_NOOVERWRITE =

doesn’t overwrite free space

36
DBOPT_NORESPONSEINFO =

doesn’t support specialized response hierarchy

38
DBOPT_NOTRANSACTIONLOGGING =

disables transaction logging

45
DBOPT_NOUNREAD =

doesn’t maintain unread marks

37
DBOPT_OPTIMIZATION =

enables document table bitmap optimization

41
DBOPT_REPLICATEUNREADMARKSTOANY =

replicates unread marks to all servers

71
DBOPT_REPLICATEUNREADMARKSTOCLUSTER =

replicates unread marks to clustered servers only

70
DBOPT_SOFTDELETE =

allows soft deletions

49
DBSIGN_DOC_ACL =

signs the ACL

64
DBSIGN_DOC_AGENT =

signs all agents

512
DBSIGN_DOC_ALL =

(default) signs all elements except data documents’ active content

32767
DBSIGN_DOC_DATA =

signs all data documents’ active content (hotspots)

1
DBSIGN_DOC_FORM =

signs all forms

4
DBSIGN_DOC_HELP =

signs the “About Database” and “Using Database” documents

256
DBSIGN_DOC_ICON =

signs the icon

16
DBSIGN_DOC_REPLFORMULA =

signs the replication formula

2048
DBSIGN_DOC_SHAREDFIELD =

signs all shared fields

1024
DBSIGN_DOC_VIEW =

signs all views

8

Instance Method Summary collapse

Methods inherited from GripWrapper

#raw

Constructor Details

#initialize(raw_object) ⇒ NotesDatabase

Returns a new instance of NotesDatabase.



6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/notesgrip/NotesDatabase.rb', line 6

def initialize(raw_object)
  super(raw_object)
  # auto open Database 
  unless @raw_object.isOpen
    begin
      @raw_object.Open("","")
    rescue WIN32OLERuntimeError
      # unable access DataBase
    end
  end
end

Dynamic Method Handling

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

Instance Method Details

#ACL ⇒ Object 



18
19
20
 
# File 'lib/notesgrip/NotesDatabase.rb', line 18

def ACL
  NotesACL.new(@raw_object.ACL)
end

#ACLActivityLog ⇒ Object

——-Simple Method Relay——–



250
251
252
 
# File 'lib/notesgrip/NotesDatabase.rb', line 250

def ACLActivityLog
  @raw_object.ACLActivityLog()
end

#Agents ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'lib/notesgrip/NotesDatabase.rb', line 22

def Agents
  agent_arr = @raw_object.Agents
  return [] unless agent_arr  # Case of No Agent in database
  ret_list = []
  agent_arr.each {|raw_agent|
    ret_list.push NotesAgent.new(raw_agent)
  }
  ret_list
end

#AllDocuments ⇒ Object 



32
33
34
 
# File 'lib/notesgrip/NotesDatabase.rb', line 32

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

#Categories ⇒ Object 



254
255
256
 
# File 'lib/notesgrip/NotesDatabase.rb', line 254

def Categories()
  @raw_object.Categories()
end

#Categories=(categoryList) ⇒ Object 



258
259
260
 
# File 'lib/notesgrip/NotesDatabase.rb', line 258

def Categories=(categoryList)
  @raw_object.Categories = categoryList
end

#Compact ⇒ Object 



520
521
522
523
 
# File 'lib/notesgrip/NotesDatabase.rb', line 520

def Compact()
  sizeDelta = @raw_object.Compact()
  return sizeDelta
end

#CompactWithOptions(options) ⇒ Object 



546
547
548
 
# File 'lib/notesgrip/NotesDatabase.rb', line 546

def CompactWithOptions( options )
  @raw_object.CompactWithOptions( options )
end

#Create ⇒ Object 



550
551
552
553
 
# File 'lib/notesgrip/NotesDatabase.rb', line 550

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

#CreateCopy(newServer, newDbFile, maxsize = 4) ⇒ Object 



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

def CreateCopy( newServer, newDbFile , maxsize=4 )
  db = @raw_object.CreateCopy( newServer, newDbFile , maxsize )
  NotesDatabase.new(db)
end

#Created ⇒ Object 



262
263
264
 
# File 'lib/notesgrip/NotesDatabase.rb', line 262

def Created()
  @raw_object.Created()
end

#CreateDocument(formName = nil) ⇒ Object 



75
76
77
78
79
80
81
82
83
 
# File 'lib/notesgrip/NotesDatabase.rb', line 75

def CreateDocument(formName=nil)
  raw_doc = @raw_object.CreateDocument()
  new_doc = raw_doc ? NotesDocument.new(raw_doc) : nil
  if new_doc and formName
    new_doc.AppendItemValue('Form', formName)
    #new_doc['Form'].Values =  formName
  end
  new_doc
end

#CreateFromTemplate(newServer, newDbFile, inheritFlag, maxsize = 4) ⇒ Object 



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

def CreateFromTemplate( newServer, newDbFile, inheritFlag, maxsize=4 )
  db = @raw_object.CreateFromTemplate( newServer, newDbFile, inheritFlag, maxsize )
  NotesDatabase.new(db)
end

#CreateFTIndex(options, recreate = false) ⇒ Object 



560
561
562
 
# File 'lib/notesgrip/NotesDatabase.rb', line 560

def CreateFTIndex( options , recreate=false )
  @raw_object.CreateFTIndex( options , recreate )
end

#CreateNoteCollection(selectAllFlag = false) ⇒ Object 



91
92
93
94
 
# File 'lib/notesgrip/NotesDatabase.rb', line 91

def CreateNoteCollection( selectAllFlag = false)
  raw_notesNotesCollection = @raw_object.CreateNoteCollection( selectAllFlag)
  NotesNoteCollection.new(raw_notesNotesCollection)
end

#CreateOutline(outlinename, defaultOutline = false) ⇒ Object 



96
97
98
99
 
# File 'lib/notesgrip/NotesDatabase.rb', line 96

def CreateOutline( outlinename, defaultOutline=false )
  raw_outline = @raw_object.CreateOutline( outlinename, defaultOutline)
  NotesOutline.new(raw_outline)
end

#CreateReplica(newServer, newDbFile) ⇒ Object 



101
102
103
104
 
# File 'lib/notesgrip/NotesDatabase.rb', line 101

def CreateReplica( newServer, newDbFile )
  raw_db = @raw_object.CreateReplica( newServer, newDbFile )
  raw_doc ? NotesDocument.new(raw_doc) : nil
end

#CreateView(viewName = nil, viewSelectionFormula = nil, templateView = nil, prohibitDesignRefreshModifications = false) ⇒ Object 



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

def CreateView( viewName=nil, viewSelectionFormula=nil, templateView=nil, prohibitDesignRefreshModifications=false )
  raw_view = @raw_object.CreateView( viewName, viewSelectionFormula, templateView, prohibitDesignRefreshModifications )
  NotesView.new(raw_view)
end

#CurrentAccessLevel ⇒ Object 



266
267
268
 
# File 'lib/notesgrip/NotesDatabase.rb', line 266

def CurrentAccessLevel()
  @raw_object.CurrentAccessLevel()
end

#DelayUpdates ⇒ Object 



270
271
272
 
# File 'lib/notesgrip/NotesDatabase.rb', line 270

def DelayUpdates()
  @raw_object.DelayUpdates()
end

#DelayUpdates=(flag) ⇒ Object 



274
275
276
 
# File 'lib/notesgrip/NotesDatabase.rb', line 274

def DelayUpdates=(flag)
  @raw_object.DelayUpdates = flag
end

#DesignTemplateName ⇒ Object 



278
279
280
 
# File 'lib/notesgrip/NotesDatabase.rb', line 278

def DesignTemplateName()
  @raw_object.DesignTemplateName()
end

#each_agent ⇒ Object 



233
234
235
236
237
 
# File 'lib/notesgrip/NotesDatabase.rb', line 233

def each_agent
  self.Agents.each {|agent|
    yield agent
  }
end

#each_document ⇒ Object 



212
213
214
215
216
217
 
# File 'lib/notesgrip/NotesDatabase.rb', line 212

def each_document
  doc_collection = self.AllDocuments
  doc_collection.each {|doc|
    yield doc
  }
end

#each_form ⇒ Object 



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

def each_form
  form_collection = self.Forms
  form_collection.each {|form|
    yield form
  }
end

#each_profile ⇒ Object 



239
240
241
242
243
 
# File 'lib/notesgrip/NotesDatabase.rb', line 239

def each_profile
  self.GetProfileDocCollection.each {|profileDoc|
    yield profileDoc
  }
end

#each_view ⇒ Object 



219
220
221
222
223
224
 
# File 'lib/notesgrip/NotesDatabase.rb', line 219

def each_view
  view_collection = self.Views
  view_collection.each {|view|
    yield view
  }
end

#EnableFolder(foldername) ⇒ Object 



564
565
566
 
# File 'lib/notesgrip/NotesDatabase.rb', line 564

def EnableFolder(foldername)
  @raw_object.EnableFolder(foldername)
end

#FileFormat ⇒ Object 



282
283
284
 
# File 'lib/notesgrip/NotesDatabase.rb', line 282

def FileFormat()
  @raw_object.FileFormat()
end

#FileName ⇒ Object 



286
287
288
 
# File 'lib/notesgrip/NotesDatabase.rb', line 286

def FileName()
  @raw_object.FileName()
end

#FilePath ⇒ Object 



290
291
292
 
# File 'lib/notesgrip/NotesDatabase.rb', line 290

def FilePath()
  @raw_object.FilePath()
end

#Fixup(options) ⇒ Object 



575
576
577
 
# File 'lib/notesgrip/NotesDatabase.rb', line 575

def Fixup(options)
  @raw_object.Fixup(options)
end

#FolderReferencesEnabled ⇒ Object 



294
295
296
 
# File 'lib/notesgrip/NotesDatabase.rb', line 294

def FolderReferencesEnabled()
  @raw_object.FolderReferencesEnabled()
end

#FolderReferencesEnabled=(flag) ⇒ Object 



298
299
300
 
# File 'lib/notesgrip/NotesDatabase.rb', line 298

def FolderReferencesEnabled=(flag)
  @raw_object.FolderReferencesEnabled = flag
end

#Forms ⇒ Object 



44
45
46
47
48
49
50
 
# File 'lib/notesgrip/NotesDatabase.rb', line 44

def Forms
  ret_list = []
  @raw_object.Forms.each {|raw_form|
    ret_list.push NotesForm.new(raw_form)
  }
  ret_list
end

#FTDomainSearch(query, maxDocs = 0, sortoptions = FT_SCORES, otheroptions = 0, start = 0, count = 1, entryform = "") ⇒ Object

uses thesaurus synonyms.



588
589
590
591
592
 
# File 'lib/notesgrip/NotesDatabase.rb', line 588

def FTDomainSearch( query, maxDocs=0, sortoptions=FT_SCORES, otheroptions=0, start=0, count=1, entryform="" )
  #raw_doc = @raw_object.FTDomainSearch( query, maxDocs, sortoptions, otheroptions, start, count, entryform )
  #raw_doc ? NotesDocument.new(raw_doc) : nil
  raise "FTDomainSearch() is not work."
end

#FTIndexFrequency ⇒ Object 



302
303
304
 
# File 'lib/notesgrip/NotesDatabase.rb', line 302

def FTIndexFrequency()
  @raw_object.FTIndexFrequency()
end

#FTIndexFrequency=(frequency) ⇒ Object 



310
311
312
 
# File 'lib/notesgrip/NotesDatabase.rb', line 310

def FTIndexFrequency=(frequency)
  @raw_object.FTIndexFrequency = frequency
end

#FTSearch(query, maxdocs = 0, sortoptions = FT_SCORES, otheroptions = 0) ⇒ Object 



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

def FTSearch( query, maxdocs=0, sortoptions=FT_SCORES, otheroptions=0 )
  raw_docCollection = @raw_object.FTSearch( query, maxdocs, sortoptions, otheroptions)
  NotesDocumentCollection.new(raw_docCollection)
end

#FTSearchRange(query, maxdocs = 0, sortoptions = FT_SCORES, otheroptions = 0, start = 0) ⇒ Object 



116
117
118
119
 
# File 'lib/notesgrip/NotesDatabase.rb', line 116

def FTSearchRange( query, maxdocs=0, sortoptions=FT_SCORES, otheroptions=0, start=0 )
  raw_docCollection = @raw_object.FTSearchRange( query, maxdocs, sortoptions, otheroptions, start)
  NotesDocumentCollection.new(raw_docCollection)
end

#GetAgent(agentName) ⇒ Object 



121
122
123
124
 
# File 'lib/notesgrip/NotesDatabase.rb', line 121

def GetAgent( agentName )
  raw_agent = @raw_object.GetAgent(agentName)
  NotesAgent.new(raw_agent)
end

#GetAllReadDocuments(username = nil) ⇒ Object 



126
127
128
129
 
# File 'lib/notesgrip/NotesDatabase.rb', line 126

def GetAllReadDocuments( username=nil )
  raw_docCollection = @raw_object.GetAllReadDocuments(username)
  NotesDocumentCollection.new(raw_docCollection)
end

#GetAllUnreadDocuments(username = nil) ⇒ Object 



131
132
133
134
 
# File 'lib/notesgrip/NotesDatabase.rb', line 131

def GetAllUnreadDocuments( username=nil )
  raw_docCollection = @raw_object.GetAllUnreadDocuments(username)
  NotesDocumentCollection.new(raw_docCollection)
end

#GetDocumentByID(noteID) ⇒ Object 



136
137
138
139
 
# File 'lib/notesgrip/NotesDatabase.rb', line 136

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

#GetDocumentByUNID(unid) ⇒ Object 



141
142
143
144
 
# File 'lib/notesgrip/NotesDatabase.rb', line 141

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

#GetDocumentByURL(url, reload = 0, urllist = 0, charset = "", webusername = "", webpassword = nil, proxywebusername = nil, proxywebpassword = nil, returnimmediately = false) ⇒ Object 



146
147
148
149
150
 
# File 'lib/notesgrip/NotesDatabase.rb', line 146

def GetDocumentByURL( url, reload=0, urllist=0, charset="", webusername="", webpassword=nil, proxywebusername=nil, proxywebpassword=nil, returnimmediately=false )
  #raw_doc = @raw_object.GetDocumentByURL( url, reload, urllist, charset, webusername, webpassword, proxywebusername, proxywebpassword, returnimmediately )
  #raw_doc ? NotesDocument.new(raw_doc) : nil
  raise "GetDocumentByURL() is not Work"
end

#GetForm(name) ⇒ Object 



152
153
154
155
 
# File 'lib/notesgrip/NotesDatabase.rb', line 152

def GetForm( name )
  raw_form = @raw_object.GetForm(name)
  raw_form ? NotesForm.new(raw_form) : nil
end

#GetModifiedDocuments(since = nil, noteClass = DBMOD_DOC_DATA) ⇒ Object 



168
169
170
171
172
 
# File 'lib/notesgrip/NotesDatabase.rb', line 168

def GetModifiedDocuments( since=nil , noteClass=DBMOD_DOC_DATA )
  #raw_docCollection = @raw_object.GetModifiedDocuments( since, noteClass)
  #NotesDocumentCollection.new(raw_docCollection)
  raise "GetModifiedDocuments() is not work."
end

#GetOption(optionName) ⇒ Object 



606
607
608
 
# File 'lib/notesgrip/NotesDatabase.rb', line 606

def GetOption(optionName)
  @raw_object.GetOption(optionName)
end

#GetOutline(outlinename) ⇒ Object 



175
176
177
178
179
 
# File 'lib/notesgrip/NotesDatabase.rb', line 175

def GetOutline( outlinename )
  #raw_outline = @raw_object.GetOutline( outlinename )
  #NotesOutline.new(raw_outline)
  raise "GetOutline is not work."
end

#GetProfileDocCollection(profilename = nil) ⇒ Object 



181
182
183
184
 
# File 'lib/notesgrip/NotesDatabase.rb', line 181

def GetProfileDocCollection( profilename=nil )
  raw_docCollection = @raw_object.GetProfileDocCollection( profilename )
  NotesDocumentCollection.new(raw_docCollection)
end

#GetProfileDocument(profilename, uniqueKey = nil) ⇒ Object 



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

def GetProfileDocument( profilename, uniqueKey=nil )
  raw_document = @raw_object.GetProfileDocument( profilename, uniqueKey)
  raw_document ? NotesDocument.new(raw_document) : nil
end

#GetView(viewName) ⇒ Object Also known as: view 



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

def GetView( viewName )
  raw_view = @raw_object.GetView( viewName )
  raw_view ? NotesView.new(raw_view) : nil
end

#GrantAccess(name, level) ⇒ Object 



610
611
612
 
# File 'lib/notesgrip/NotesDatabase.rb', line 610

def GrantAccess(name, level)
  @raw_object.GrantAccess(name, level)
end

#HttpURL ⇒ Object 



314
315
316
 
# File 'lib/notesgrip/NotesDatabase.rb', line 314

def HttpURL()
  @raw_object.HttpURL()
end

#inspect ⇒ Object 



245
246
247
 
# File 'lib/notesgrip/NotesDatabase.rb', line 245

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

#IsClusterReplication ⇒ Object 



318
319
320
 
# File 'lib/notesgrip/NotesDatabase.rb', line 318

def IsClusterReplication()
  @raw_object.IsClusterReplication()
end

#IsClusterReplication=(flag) ⇒ Object 



322
323
324
 
# File 'lib/notesgrip/NotesDatabase.rb', line 322

def IsClusterReplication=(flag)
  @raw_object.IsClusterReplication = flag
end

#IsConfigurationDirectory ⇒ Object 



326
327
328
 
# File 'lib/notesgrip/NotesDatabase.rb', line 326

def IsConfigurationDirectory()
  @raw_object.IsConfigurationDirectory()
end

#IsCurrentAccessPublicReader ⇒ Object 



330
331
332
 
# File 'lib/notesgrip/NotesDatabase.rb', line 330

def IsCurrentAccessPublicReader()
  @raw_object.IsCurrentAccessPublicReader()
end

#IsCurrentAccessPublicWriter ⇒ Object 



334
335
336
 
# File 'lib/notesgrip/NotesDatabase.rb', line 334

def IsCurrentAccessPublicWriter()
  @raw_object.IsCurrentAccessPublicWriter()
end

#IsDesignLockingEnabled ⇒ Object 



338
339
340
 
# File 'lib/notesgrip/NotesDatabase.rb', line 338

def IsDesignLockingEnabled()
  @raw_object.IsDesignLockingEnabled()
end

#IsDesignLockingEnabled=(flag) ⇒ Object 



342
343
344
 
# File 'lib/notesgrip/NotesDatabase.rb', line 342

def IsDesignLockingEnabled=(flag)
  @raw_object.IsDesignLockingEnabled = flag
end

#IsDirectoryCatalog ⇒ Object 



346
347
348
 
# File 'lib/notesgrip/NotesDatabase.rb', line 346

def IsDirectoryCatalog()
  @raw_object.IsDirectoryCatalog()
end

#IsDocumentLockingEnabled ⇒ Object 



350
351
352
 
# File 'lib/notesgrip/NotesDatabase.rb', line 350

def IsDocumentLockingEnabled()
  @raw_object.IsDocumentLockingEnabled()
end

#IsDocumentLockingEnabled=(flag) ⇒ Object 



354
355
356
 
# File 'lib/notesgrip/NotesDatabase.rb', line 354

def IsDocumentLockingEnabled=(flag)
  @raw_object.IsDocumentLockingEnabled = flag
end

#IsFTIndexed ⇒ Object 



358
359
360
 
# File 'lib/notesgrip/NotesDatabase.rb', line 358

def IsFTIndexed()
  @raw_object.IsFTIndexed()
end

#IsInMultiDbIndexing ⇒ Object 



362
363
364
 
# File 'lib/notesgrip/NotesDatabase.rb', line 362

def IsInMultiDbIndexing()
  @raw_object.IsInMultiDbIndexing()
end

#IsInMultiDbIndexing=(flag) ⇒ Object 



366
367
368
 
# File 'lib/notesgrip/NotesDatabase.rb', line 366

def IsInMultiDbIndexing=(flag)
  @raw_object.IsInMultiDbIndexing = flag
end

#IsInService ⇒ Object 



370
371
372
 
# File 'lib/notesgrip/NotesDatabase.rb', line 370

def IsInService()
  @raw_object.IsInService()
end

#IsInService=(flag) ⇒ Object 



374
375
376
 
# File 'lib/notesgrip/NotesDatabase.rb', line 374

def IsInService=(flag)
  @raw_object.IsInService = flag
end

#IsLink ⇒ Object 



378
379
380
 
# File 'lib/notesgrip/NotesDatabase.rb', line 378

def IsLink()
  @raw_object.IsLink()
end

#IsMultiDbSearch ⇒ Object 



382
383
384
 
# File 'lib/notesgrip/NotesDatabase.rb', line 382

def IsMultiDbSearch()
  @raw_object.IsMultiDbSearch()
end

#IsOpen ⇒ Object 



386
387
388
 
# File 'lib/notesgrip/NotesDatabase.rb', line 386

def IsOpen()
  @raw_object.IsOpen()
end

#IsPendingDelete ⇒ Object 



390
391
392
 
# File 'lib/notesgrip/NotesDatabase.rb', line 390

def IsPendingDelete()
  @raw_object.IsPendingDelete()
end

#IsPrivateAddressBook ⇒ Object 



394
395
396
 
# File 'lib/notesgrip/NotesDatabase.rb', line 394

def IsPrivateAddressBook()
  @raw_object.IsPrivateAddressBook()
end

#IsPublicAddressBook ⇒ Object 



398
399
400
 
# File 'lib/notesgrip/NotesDatabase.rb', line 398

def IsPublicAddressBook()
  @raw_object.IsPublicAddressBook()
end

#LastFixup ⇒ Object 



402
403
404
 
# File 'lib/notesgrip/NotesDatabase.rb', line 402

def LastFixup()
  @raw_object.LastFixup()
end

#LastFTIndexed ⇒ Object 



406
407
408
 
# File 'lib/notesgrip/NotesDatabase.rb', line 406

def LastFTIndexed()
  @raw_object.LastFTIndexed()
end

#LastModified ⇒ Object 



410
411
412
 
# File 'lib/notesgrip/NotesDatabase.rb', line 410

def LastModified()
  @raw_object.LastModified()
end

#LimitRevisions ⇒ Object 



414
415
416
 
# File 'lib/notesgrip/NotesDatabase.rb', line 414

def LimitRevisions()
  @raw_object.LimitRevisions()
end

#LimitRevisions=(revisions) ⇒ Object 



418
419
420
 
# File 'lib/notesgrip/NotesDatabase.rb', line 418

def LimitRevisions=(revisions)
  @raw_object.LimitRevisions = revisions
end

#LimitUpdatedBy ⇒ Object 



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

def LimitUpdatedBy()
  @raw_object.LimitUpdatedBy()
end

#LimitUpdatedBy=(revisions) ⇒ Object 



426
427
428
 
# File 'lib/notesgrip/NotesDatabase.rb', line 426

def LimitUpdatedBy=(revisions)
  @raw_object.LimitUpdatedBy = revisions
end

#ListInDbCatalog ⇒ Object 



430
431
432
 
# File 'lib/notesgrip/NotesDatabase.rb', line 430

def ListInDbCatalog()
  @raw_object.ListInDbCatalog()
end

#ListInDbCatalog=(flag) ⇒ Object 



434
435
436
 
# File 'lib/notesgrip/NotesDatabase.rb', line 434

def ListInDbCatalog=(flag)
  @raw_object.ListInDbCatalog = flag
end

#Managers ⇒ Object 



438
439
440
 
# File 'lib/notesgrip/NotesDatabase.rb', line 438

def Managers()
  @raw_object.Managers()
end

#MarkForDelete ⇒ Object 



614
615
616
 
# File 'lib/notesgrip/NotesDatabase.rb', line 614

def MarkForDelete()
  @raw_object.MarkForDelete()
end

#MaxSize ⇒ Object 



442
443
444
 
# File 'lib/notesgrip/NotesDatabase.rb', line 442

def MaxSize()
  @raw_object.MaxSize()
end

#name ⇒ Object

—- Additional Methods ——



204
205
206
 
# File 'lib/notesgrip/NotesDatabase.rb', line 204

def name
  @raw_object.Title
end

#NotesURL ⇒ Object 



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

def NotesURL()
  @raw_object.NotesURL()
end

#Open ⇒ Object 



618
619
620
 
# File 'lib/notesgrip/NotesDatabase.rb', line 618

def Open()
  @raw_object.Open()
end

#open? ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
 
# File 'lib/notesgrip/NotesDatabase.rb', line 208

def open?()
  @raw_object.IsOpen()
end

#OpenByReplicaID ⇒ Object 



622
623
624
 
# File 'lib/notesgrip/NotesDatabase.rb', line 622

def OpenByReplicaID()
  raise "OpenByReplicaID() is not work."
end

#OpenIfModified ⇒ Object 



626
627
628
 
# File 'lib/notesgrip/NotesDatabase.rb', line 626

def OpenIfModified()
  raise "OpenIfModified() is not work."
end

#OpenMail ⇒ Object 



630
631
632
 
# File 'lib/notesgrip/NotesDatabase.rb', line 630

def OpenMail()
  raise "OpenIfModified() is not work."
end

#OpenURLDb ⇒ Object 



634
635
636
 
# File 'lib/notesgrip/NotesDatabase.rb', line 634

def OpenURLDb()
  raise "OpenURLDb() is not work."
end

#OpenWithFailover ⇒ Object 



638
639
640
 
# File 'lib/notesgrip/NotesDatabase.rb', line 638

def OpenWithFailover()
  raise "OpenWithFailover() is not work."
end

#Parent ⇒ Object 



52
53
54
 
# File 'lib/notesgrip/NotesDatabase.rb', line 52

def Parent()
  NotesSession.new()
end

#PercentUsed ⇒ Object 



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

def PercentUsed()
  @raw_object.PercentUsed()
end

#QueryAccess(name) ⇒ Object 



642
643
644
 
# File 'lib/notesgrip/NotesDatabase.rb', line 642

def QueryAccess(name)
  @raw_object.QueryAccess(name)
end

#QueryAccessPrivileges(name) ⇒ Object 



646
647
648
 
# File 'lib/notesgrip/NotesDatabase.rb', line 646

def QueryAccessPrivileges(name)
  @raw_object.QueryAccessPrivileges(name)
end

#QueryAccessRoles(name) ⇒ Object 



650
651
652
 
# File 'lib/notesgrip/NotesDatabase.rb', line 650

def QueryAccessRoles(name)
  @raw_object.QueryAccessRoles(name)
end

#Remove ⇒ Object 



654
655
656
 
# File 'lib/notesgrip/NotesDatabase.rb', line 654

def Remove()
  @raw_object.Remove()
end

#RemoveFTIndex ⇒ Object 



658
659
660
 
# File 'lib/notesgrip/NotesDatabase.rb', line 658

def RemoveFTIndex()
  @raw_object.RemoveFTIndex()
end

#ReplicaID ⇒ Object 



454
455
456
 
# File 'lib/notesgrip/NotesDatabase.rb', line 454

def ReplicaID()
  @raw_object.ReplicaID()
end

#Replicate(serverName) ⇒ Object 



662
663
664
 
# File 'lib/notesgrip/NotesDatabase.rb', line 662

def Replicate(serverName)
  @raw_object.Replicate(serverName)
end

#ReplicationInfo ⇒ Object 



56
57
58
 
# File 'lib/notesgrip/NotesDatabase.rb', line 56

def ReplicationInfo
  NotesReplication.new(@raw_object.NotesReplication)
end

#RevokeAccess(name) ⇒ Object 



666
667
668
 
# File 'lib/notesgrip/NotesDatabase.rb', line 666

def RevokeAccess(name)
  @raw_object.RevokeAccess(name)
end

#Search(formula, notesDateTime = nil, maxDocs = 0) ⇒ Object 



197
198
199
200
201
 
# File 'lib/notesgrip/NotesDatabase.rb', line 197

def Search( formula, notesDateTime=nil, maxDocs=0 )
  #raw_docCollection = @raw_object.Search( formula, notesDateTime, maxDocs )
  #NotesDocumentCollection.new(raw_docCollection)
  raise "Search() is not work."
end

#Server ⇒ Object 



458
459
460
 
# File 'lib/notesgrip/NotesDatabase.rb', line 458

def Server()
  @raw_object.Server()
end

#SetOption(optionName, flag) ⇒ Object 



670
671
672
 
# File 'lib/notesgrip/NotesDatabase.rb', line 670

def SetOption( optionName, flag )
  @raw_object.SetOption(optionName, flag)
end

#Sign(documentType) ⇒ Object 



684
685
686
 
# File 'lib/notesgrip/NotesDatabase.rb', line 684

def Sign(documentType)
  @raw_object.Sign(documentType)
end

#Size ⇒ Object 



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

def Size()
  @raw_object.Size()
end

#SizeQuota ⇒ Object 



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

def SizeQuota()
  @raw_object.SizeQuota()
end

#SizeQuota=(quota) ⇒ Object 



470
471
472
 
# File 'lib/notesgrip/NotesDatabase.rb', line 470

def SizeQuota=(quota)
  @raw_object.SizeQuota = quota
end

#SizeWarning ⇒ Object 



474
475
476
 
# File 'lib/notesgrip/NotesDatabase.rb', line 474

def SizeWarning()
  @raw_object.SizeWarning()
end

#SizeWarning=(warning) ⇒ Object 



478
479
480
 
# File 'lib/notesgrip/NotesDatabase.rb', line 478

def SizeWarning=(warning)
  @raw_object.SizeWarning = warning
end

#TemplateName ⇒ Object 



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

def TemplateName()
  @raw_object.TemplateName()
end

#Title ⇒ Object 



486
487
488
 
# File 'lib/notesgrip/NotesDatabase.rb', line 486

def Title()
  @raw_object.Title()
end

#Type ⇒ Object 



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

def Type()
  @raw_object.Type()
end

#UndeleteExpireTime ⇒ Object 



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

def UndeleteExpireTime()
  @raw_object.UndeleteExpireTime()
end

#UndeleteExpireTime=(hours) ⇒ Object 



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

def UndeleteExpireTime=(hours)
  @raw_object.UndeleteExpireTime = hours
end

#UnprocessedDocuments ⇒ Object 



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

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

#UnprocessedFTSearch(query, maxdocs = 0, sortoptions = nil, otheroptions = nil) ⇒ Object 



688
689
690
 
# File 'lib/notesgrip/NotesDatabase.rb', line 688

def UnprocessedFTSearch(query, maxdocs=0, sortoptions=nil, otheroptions=nil )
  raise "UnprocessedFTSearch() is not work."
end

#UnprocessedFTSearchRange(query, maxdocs = 0, sortoptions = nil, otheroptions = nil, start = 0) ⇒ Object 



692
693
694
 
# File 'lib/notesgrip/NotesDatabase.rb', line 692

def UnprocessedFTSearchRange(query, maxdocs=0, sortoptions=nil, otheroptions=nil, start=0)
  raise "UnprocessedFTSearchRange() is not work."
end

#UnprocessedSearch(formula, notesDateTime, maxDocs) ⇒ Object 



696
697
698
 
# File 'lib/notesgrip/NotesDatabase.rb', line 696

def UnprocessedSearch(formula, notesDateTime, maxDocs)
  raise "UnprocessedSearch() is not work."
end

#UpdateFTIndex(createFlag) ⇒ Object 



700
701
702
 
# File 'lib/notesgrip/NotesDatabase.rb', line 700

def UpdateFTIndex(createFlag)
  @raw_object.UpdateFTIndex(createFlag)
end

#Views ⇒ Object 



60
61
62
63
64
65
66
67
68
 
# File 'lib/notesgrip/NotesDatabase.rb', line 60

def Views
  ret_list = []
  raw_views = @raw_object.Views
  return [] unless raw_views
  raw_views.each {|raw_view|
    ret_list.push NotesView.new(raw_view)
  }
  ret_list
end