Domino Designer 5 - Programmers guide - Java Script

Structure of this guide......Page 37
Documentation for Domino Administration......Page 38
Documentation for Domino Designer......Page 39
Running a Java program......Page 41
Accessing database properties......Page 53
Locating a database on a server or the local directory......Page 59
Opening a database......Page 60
Creating, compacting, removing, and replicating a database......Page 64
Examining and adjusting an access control list......Page 66
Accessing a form......Page 69
Accessing an outline......Page 70
Accessing view properties......Page 71
Locating a view......Page 75
Accessing view columns......Page 76
Working with view entries and navigators......Page 78
Accessing documents......Page 81
Accessing document properties......Page 82
Collecting all documents and all unprocessed documents......Page 85
Collecting documents by searching......Page 87
Locating a document by ID......Page 88
Removing a document......Page 89
Accessing items......Page 90
Accessing item properties......Page 91
Copying an item......Page 94
Working with a rich text item......Page 95
Working with an embedded object......Page 96
Accessing Domino sessions......Page 97
Accessing session properties......Page 98
Using environment variables......Page 99
Accessing agents......Page 100
Accessing international settings......Page 102
Working with time......Page 104
Making a log......Page 107
Representing a name......Page 108
Properties and methods with ECL security......Page 111
AppletBase class......Page 118
NotesError and NotesException classes......Page 119
NotesFactory class......Page 141
NotesThread class......Page 142
recycle method......Page 144
Visibility interface......Page 145
ACL class......Page 146
InternetLevel property......Page 147
IsUniformAccess property......Page 149
Parent property......Page 150
Roles property......Page 151
addRole method......Page 152
createACLEntry method......Page 153
deleteRole method......Page 154
getEntry method......Page 155
getFirstEntry method......Page 157
getNextEntry method......Page 158
removeACLEntry method......Page 159
renameRole method......Page 160
ACLEntry class......Page 161
IsAdminReaderAuthor property......Page 163
IsCanCreateDocuments property......Page 164
IsCanCreateLSOrJavaAgent property......Page 165
IsCanCreatePersonalAgent property......Page 166
IsCanCreatePersonalFolder property......Page 167
IsCanDeleteDocuments property......Page 169
IsPerson property......Page 171
IsPublicReader property......Page 172
IsServer property......Page 173
Level property......Page 174
Name property......Page 176
NameObject property......Page 177
Parent property......Page 178
Roles property......Page 179
UserType property......Page 180
disableRole method......Page 182
enableRole method......Page 183
isRoleEnabled method......Page 184
remove method......Page 185
Agent class......Page 186
Comment property......Page 188
CommonOwner property......Page 189
IsEnabled property......Page 190
IsNotesAgent property......Page 192
IsPublic property......Page 193
LastRun property......Page 194
Owner property......Page 196
Parent property......Page 197
Query property......Page 198
ServerName property......Page 199
Target property......Page 201
remove method......Page 203
run method......Page 205
runOnServer method......Page 206
AgentContext class......Page 207
CurrentAgent property......Page 209
CurrentDatabase property......Page 210
DocumentContext property......Page 211
EffectiveUserName property......Page 212
LastExitStatus property......Page 213
LastRun property......Page 214
SavedData property......Page 215
UnprocessedDocuments property......Page 216
unprocessedFTSearch method......Page 218
unprocessedSearch method......Page 222
updateProcessedDoc method......Page 225
Database class......Page 226
ACL property......Page 233
Agents property......Page 234
AllDocuments property......Page 235
Categories property......Page 236
Created property......Page 237
CurrentAccessLevel property......Page 238
DesignTemplateName property......Page 240
FilePath property......Page 241
FolderReferencesEnabled property......Page 242
IsDelayUpdates property......Page 244
IsFTIndexed property......Page 246
IsMultiDbSearch property......Page 247
IsOpen property......Page 248
IsPrivateAddressBook property......Page 249
IsPublicAddressBook property......Page 250
LastFTIndexed property......Page 251
LastModified property......Page 252
Managers property......Page 253
MaxSize property......Page 254
PercentUsed property......Page 255
ReplicaID property......Page 256
ReplicationInfo property......Page 257
Server property......Page 258
Size property......Page 259
SizeQuota property......Page 260
TemplateName property......Page 261
Title property......Page 262
Views property......Page 263
compact method......Page 264
createCopy method......Page 265
createDocument method......Page 266
createFromTemplate method......Page 267
createOutline method......Page 269
createReplica method......Page 270
enableFolder method......Page 271
FTDomainSearch method......Page 272
FTSearch method......Page 273
getAgent method......Page 276
getDocumentByID method......Page 277
getDocumentByUNID method......Page 278
getDocumentByURL method......Page 280
getForm method......Page 282
getOutline method......Page 283
getProfileDocCollection......Page 284
getProfileDocument method......Page 285
getURLHeaderInfo method......Page 286
getView method......Page 288
grantAccess method......Page 289
open method......Page 290
queryAccess method......Page 291
remove method......Page 293
replicate method......Page 294
revokeAccess method......Page 295
search method......Page 297
updateFTIndex method......Page 298
DateRange class......Page 299
EndDateTime property......Page 302
StartDateTime property......Page 303
DateTime class......Page 304
DateOnly property......Page 308
GMTTime property......Page 309
IsDST property......Page 310
LocalTime property......Page 311
TimeOnly property......Page 313
TimeZone property......Page 314
adjustDay method......Page 316
adjustHour method......Page 317
adjustMinute method......Page 319
adjustMonth method......Page 320
adjustSecond method......Page 321
adjustYear method......Page 322
convertToZone method......Page 324
setAnyDate method......Page 325
setNow method......Page 326
timeDifference method......Page 327
toJavaDate method......Page 328
DbDirectory class......Page 329
Name property......Page 330
createDatabase method......Page 331
getFirstDatabase method......Page 333
getNextDatabase method......Page 334
openDatabase method......Page 335
openDatabaseByReplicaID method......Page 336
openDatabaseIfModified method......Page 337
openMailDatabase method......Page 338
Document class......Page 339
Authors property......Page 343
ColumnValues property......Page 345
Created property......Page 346
EmbeddedObjects property......Page 347
EncryptionKeys property......Page 349
FTSearchScore property......Page 350
HasEmbedded property......Page 351
IsEncryptOnSend property......Page 352
IsNewNote property......Page 353
IsProfile property......Page 354
IsSaveMessageOnSend property......Page 355
IsSentByAgent property......Page 356
IsSigned property......Page 357
IsSignOnSend property......Page 358
IsValid property......Page 359
Items property......Page 360
LastAccessed property......Page 361
NoteID property......Page 362
ParentDatabase property......Page 363
ParentDocumentUNID property......Page 364
ParentView property......Page 365
Responses property......Page 366
Size property......Page 368
UniversalID property......Page 369
Verifier property......Page 370
appendItemValue method......Page 371
computeWithForm method......Page 373
copyAllItems method......Page 375
copyItem method......Page 376
copyToDatabase method......Page 378
createReplyMessage method......Page 379
createRichTextItem method......Page 380
encrypt method......Page 381
getAttachment method......Page 383
getFirstItem method......Page 384
getItemValue method......Page 386
getItemValueInteger method......Page 388
getItemValueString method......Page 389
makeResponse method......Page 390
putInFolder method......Page 391
remove method......Page 393
removeFromFolder method......Page 394
removeItem method......Page 395
renderToRTItem method......Page 396
replaceItemValue method......Page 397
save method......Page 400
send method......Page 401
DocumentCollection class......Page 404
IsSorted property......Page 407
Parent property......Page 409
Query property......Page 410
addDocument method......Page 411
deleteDocument method......Page 412
FTSearch method......Page 414
getDocument method......Page 415
getNextDocument method......Page 417
getNthDocument method......Page 419
getPrevDocument method......Page 421
putAllInFolder method......Page 422
removeAll method......Page 424
stampAll method......Page 425
updateAll method......Page 427
EmbeddedObject class......Page 428
ClassName property......Page 430
Name property......Page 431
Source property......Page 432
Verbs property......Page 433
doVerb method......Page 434
extractFile method......Page 435
Form class......Page 436
Aliases property......Page 438
Fields property......Page 439
FormUsers property......Page 440
IsProtectReaders property......Page 442
IsProtectUsers property......Page 443
IsSubForm property......Page 444
Name property......Page 445
Readers property......Page 446
remove method......Page 447
International class......Page 448
AMString property......Page 450
CurrencySymbol property......Page 451
DateSep property......Page 452
DecimalSep property......Page 454
IsCurrencySuffix property......Page 455
IsDateDMY property......Page 456
IsDateYMD property......Page 457
IsTime24Hour property......Page 458
PMString property......Page 459
TimeZone property......Page 460
Tomorrow property......Page 461
Item class......Page 462
IsAuthors property......Page 466
IsEncrypted property......Page 468
IsNames property......Page 470
IsReaders property......Page 471
IsSigned property......Page 472
IsSummary property......Page 473
Parent property......Page 474
Type property......Page 476
ValueDouble property......Page 479
ValueLength property......Page 480
Values property......Page 481
ValueString property......Page 483
abstractText method......Page 484
appendToTextList method......Page 485
containsValue method......Page 487
copyItemToDocument method......Page 488
remove method......Page 490
Log class......Page 491
IsLogActions property......Page 494
IsLogErrors property......Page 495
IsOverwriteFile property......Page 496
NumActions property......Page 498
NumErrors property......Page 499
ProgramName property......Page 500
close method......Page 501
logAction method......Page 502
logError method......Page 503
logEvent method......Page 505
openAgentLog method......Page 506
openFileLog method......Page 507
openMailLog method......Page 509
openNotesLog method......Page 510
Name class......Page 512
Addr822Comment1 property......Page 515
Addr822LocalPart property......Page 516
Canonical property......Page 517
Generation property......Page 518
IsHierarchical property......Page 519
Language property......Page 520
OrgUnit2 property......Page 524
Parent property......Page 525
Newsletter class......Page 526
IsDoSubject property......Page 529
SubjectItemName property......Page 530
formatDocument method......Page 531
formatMsgWithDoclinks method......Page 533
Outline class......Page 535
Alias property......Page 538
addEntry method......Page 539
createEntry method......Page 540
getFirst method......Page 541
getLast method......Page 542
getNextSibling method......Page 543
getParent method......Page 544
getPrevSibling method......Page 545
moveEntry method......Page 546
removeEntry method......Page 548
OutlineEntry class......Page 549
Alias property......Page 550
Document property......Page 551
Formula property......Page 552
HasChildren property......Page 553
IsHidden property......Page 555
IsPrivate property......Page 556
NamedElement property......Page 557
URL property......Page 558
setAction method......Page 559
setNamedElement method......Page 560
setNoteLink method......Page 561
Registration class......Page 562
CreateMailDb property......Page 564
IDType property......Page 565
MinPasswordLength property......Page 566
RegistrationServer property......Page 567
UpdateAddressbook property......Page 568
addCertifierToAddressbook method......Page 569
addServerToAddressbook method......Page 570
addUserToAddressbook method......Page 571
deleteIDOnServer method......Page 573
getUserInfo method......Page 574
recertify method......Page 575
registerNewCertifier method......Page 576
registerNewServer method......Page 577
registerNewUser method......Page 578
switchToID method......Page 579
Replication class......Page 580
IsAbstract property......Page 583
CutoffDate property......Page 584
IsCutoffDelete property......Page 585
IsDisabled property......Page 586
IsDoNotBrowse property......Page 587
IsDoNotCatalog property......Page 588
IsHideDesign property......Page 589
IsIgnoreDeletes property......Page 590
IsIgnoreDestDeletes property......Page 591
IsMultiDbIndex property......Page 592
IsNoChronos property......Page 593
Priority property......Page 594
save method......Page 596
RichTextItem class......Page 597
EmbeddedObjects property......Page 599
addNewLine method......Page 600
addTab method......Page 602
appendDocLink method......Page 603
appendRTItem method......Page 605
appendStyle method......Page 606
embedObject method......Page 607
getEmbeddedObject method......Page 609
getFormattedText method......Page 610
RichTextParagraphStyle class......Page 612
Alignment property......Page 614
InterLineSpacing property......Page 615
Pagination property......Page 616
RightMargin property......Page 617
SpacingBelow property......Page 618
clearAllTabs method......Page 619
setTabs method......Page 620
RichTextStyle class......Page 622
Color property......Page 624
Effects property......Page 625
Font property......Page 626
Italic property......Page 627
StrikeThrough property......Page 628
RichTextTab class......Page 629
Position property......Page 631
Session class......Page 632
AddressBooks property......Page 635
CommonUserName property......Page 637
International property......Page 638
IsOnServer property......Page 639
NotesVersion property......Page 640
Platform property......Page 641
ServerName property......Page 642
UserName property......Page 643
UserNameObject property......Page 644
createDateRange method......Page 645
createDateTime method......Page 646
createName method......Page 647
createRegistration method......Page 648
createRichTextStyle method......Page 649
evaluate method......Page 650
freeTimeSearch method......Page 652
getDatabase method......Page 653
getDbDirectory method......Page 654
getEnvironmentString method......Page 655
getEnvironmentValue method......Page 657
getURLDatabase method......Page 659
setEnvironmentVar method......Page 660
View class......Page 662
Aliases property......Page 667
AllEntries property......Page 668
BackgroundColor property......Page 669
ColumnCount property......Page 671
Columns property......Page 672
Created property......Page 673
HeaderLines property......Page 674
IsAutoUpdate property......Page 675
IsCalendar property......Page 676
IsCategorized property......Page 677
IsDefaultView property......Page 678
IsFolder property......Page 679
IsModified property......Page 680
IsPrivate property......Page 681
IsProtectReaders property......Page 682
LastModified property......Page 683
Name property......Page 684
Parent property......Page 685
Readers property......Page 686
Spacing property......Page 687
UniversalID property......Page 688
createViewNav method......Page 689
createViewNavFrom method......Page 691
createViewNavFromCategory method......Page 692
createViewNavFromChildren method......Page 694
createViewNavFromDescendants method......Page 695
createViewNavMaxLevel method......Page 697
FTSearch method......Page 698
getAllDocumentsByKey method......Page 701
getAllEntriesByKey method......Page 703
getChild method......Page 706
getColumn method......Page 707
getDocumentByKey method......Page 708
getEntryByKey method......Page 710
getFirstDocument method......Page 712
getLastDocument method......Page 713
getNextDocument method......Page 714
getNextSibling method......Page 716
getNthDocument method......Page 717
getParentDocument method......Page 718
getPrevDocument method......Page 720
getPrevSibling method......Page 721
refresh method......Page 722
remove method......Page 723
ViewColumn class......Page 724
Alignment property......Page 727
DateFmt property......Page 728
FontColor property......Page 730
FontFace property......Page 732
FontStyle......Page 733
Formula property......Page 734
IsAccentSensitiveSort property......Page 735
IsCategory property......Page 736
IsFormula property......Page 737
IsHideDetail property......Page 738
IsResortAscending property......Page 740
IsResortToView property......Page 741
IsResponse property......Page 742
IsSecondaryResortDescending property......Page 743
IsSortDescending property......Page 744
IsSorted property......Page 745
ItemName property......Page 746
NumberAttrib property......Page 747
NumberFormat property......Page 749
Position property......Page 750
TimeFmt property......Page 751
Width property......Page 752
ViewEntry class......Page 754
ColumnIndentLevel property......Page 756
ColumnValues property......Page 757
Document property......Page 758
IndentLevel property......Page 759
IsDocument property......Page 760
IsValid property......Page 761
Parent property......Page 762
getPosition method......Page 763
ViewEntryCollection class......Page 764
Parent property......Page 766
addEntry method......Page 767
deleteEntry method......Page 768
FTSearch method......Page 770
getEntry method......Page 771
getFirstEntry method......Page 773
getLastEntry method......Page 774
getNextEntry method......Page 775
getNthEntry method......Page 776
putAllInFolder method......Page 777
removeAll method......Page 779
removeAllFromFolder method......Page 780
stampAll method......Page 781
updateAll method......Page 782
ViewNavigator class......Page 783
MaxLevel property......Page 786
getChild method......Page 787
getFirst method......Page 790
getFirstDocument method......Page 792
getLast method......Page 793
getLastDocument method......Page 795
getNextCategory method......Page 796
getNextDocument method......Page 797
getNextSibling method......Page 798
getNth method......Page 799
getParent method......Page 800
getPos method......Page 801
getPrev method......Page 802
getPrevCategory method......Page 803
getPrevSibling method......Page 804
gotoChild method......Page 805
gotoEntry method......Page 807
gotoFirst method......Page 808
gotoFirstDocument method......Page 809
gotoLast method......Page 810
gotoLastDocument method......Page 812
gotoNext method......Page 813
gotoNextCategory method......Page 814
gotoNextSibling method......Page 815
gotoPos method......Page 816
gotoPrevCategory method......Page 817
gotoPrevDocument method......Page 818
gotoPrevSibling method......Page 819
Index......Page 821