Lotus Notes I Domino. Leksykon

IDZ DO
PRZYKADOWY ROZDZIA
SPIS TRECI
KATALOG KSIEK
KATALOG ONLINE
ZAMW DRUKOWANY KATALOG
TWJ KOSZYK
DODAJ DO KOSZYKA
CENNIK I INFORMACJE
ZAMW INFORMACJE
O NOWOCIACH
ZAMW CENNIK
CZYTELNIA
FRAGMENTY KSIEK ONLINE
Wydawnictwo Helion
ul. Chopina 6
44-100 Gliwice
tel. (32)230-98-63
e-mail: helion@helion.pl
Lotus Notes i Domino.

Leksykon
Autorzy: Tim Bankes, Dave Hatter

Tumaczenie: Zbigniew Gaa
ISBN: 83-7197-476-0
Tytu oryginau: Lotus Notes and Domino Essential
Reference
Format: B5, stron: 688
Lotus Notes i Domino. Leksykon jest narzdziem niezastpionym dla osb

pragncych tworzy aplikacje w sposb szybki i zdecydowany. Zawiera bowiem
wszystkie klasy frontendowe (klasy interfejsw) i backendowe (klasy baz danych)
zarwno dla jzyka LotusScript, jak i Javy opatrzone omwieniem ich waciwoci,
metod oraz zdarze. W odrnieniu od plikw pomocy Notesa i innych dokumentacji
referencyjnych, omwienie kadej z tych klas zawiera liczna przykady zastosowa
opisywanych zagadnie. Dziki tej ksice mona zapomnie o bdzeniu po
meandrach pomocy Notesa w poszukiwaniu odpowiedzi na nurtujce nas pytanie.
Opracowany zgodnie ze sposobem mylenia programisty, Lotus Notes i Domino
leksykon w znacznym stopniu upraszcza proces wyszukiwania informacji. Mona
korzysta ze spisu treci i indeksu, ale czy nie atwiej korzysta z umieszczonych
bezporednio w tekcie odnonikw, tabeli referencyjnych i schematw hierarchii
obiektowej? Posiadajc kompendium wiedzy w postaci niniejszej ksiki zamiana
oowiu posiadanej wiedzy na zote aplikacje Notesa bdzie duo prostsze.
Spord innych publikacji na ten temat ksika ta jest:
najdokadniejszym omwieniem modelu obiektowego Notes a do wersji 5.0;
usprawnionym sposobem wyszukiwania interesujcych nas klas, waciwoci
metod i zdarze;
rozbudowanym schematem hierarchii obiektowej jzykw LotusScript i Java
dajcym peen obraz kadej z klas;
penym i jednoczenie zwartym zbiorem referencji.
Pozwala take na korzystanie z praktycznych przykadw przygotowanych przez Tima
Bankesa i Dava Hattera programistw o duym zasobie dowiadcze zawodowych.
"
"
"
"

Button 4.0 4.1x 4.5x 4.6 5.0 17
Skadnia LotusScript 17
Zdarzenia 17
Komentarz 17
Przykad 18
Field 4.0 4.1x 4.5x 4.6x 5.0 19
Zdarzenia 19
Komentarz 20
Przykad 21
Navigator 4.0 4.1x 4.5x 4.6x 5.0 22
Zdarzenia 22
Komentarz 22
Przykad 22
NotesUIDatabase 4.5x 4.6x 5.0 24
Waciwoci 24
Metody 25
Zdarzenia 26
Komentarz 29
Przykad 30
NotesUIDocument 4.0 4.1x 4.5x 4.6x 5.0 31
Waciwoci 31
Metody 36
Zdarzenia 47
Komentarz 49
Przykad 49
NotesUIView 4.5x 4.6x 5.0 51
Waciwoci 51
Metody 52
Zdarzenia 53
Komentarz 56
Przykad 56
NotesUIWorkspace 4.0 4.1x 4.5x 4.6x 5.0 57
Waciwoci 57
Metody 58
Komentarz 70
Przykad 70
NotesACL 4.0 4.1x 4.5x 4.6x 5.0 72
Waciwoci 73
Metody 75
Komentarz 78
Przykad 79
NotesACLEntry 4.0 4.1x 4.5x 4.6x 5.0 80

Parametry LotusScript 80
Waciwoci 81
Metody 88
Komentarz 89
Przykad 89
NotesAgent 4.0 4.1x 4.5x 4.6x 5.0 92
Waciwoci 92
Metody 95
Komentarz 95
Przykad 96
NotesDatabase 4.0 4.1x 4.5x 4.6x 5.0 97
Waciwoci 98
Metody 105
Komentarz 120
Przykad 121
NotesDateRange 4.5x 4.6x 5.0 122
Waciwoci 122
Przykad 123
NotesDateTime 4.0 4.1x 4.5x 4.6x 5.0 124
Waciwoci 124
Metody 126
Komentarz 129
Przykad 130
NotesDbDirectory 4.0 4.1x 4.5x 4.6x 5.0 131
Waciwoci 132
Metody 132
Komentarz 133
Przykad 133
NotesDocument 4.0 4.1x 4.5x 4.6x 5.0 135
Waciwoci 136
Metody 144
Komentarz 154
Przykad 155
NotesDocumentCollection 4.0 4.1x 4.5x 4.6x 5.0 158
Waciwoci 159
Metody 160
Komentarz 166
Przykad 167
NotesEmbeddedObject 4.0 4.1x 4.5x 4.6x 5.0 169

Waciwoci 169
Metody 172
Komentarz 173
Przykad 173
NotesForm 4.5x 4.6x 5.0 177
Waciwoci 177
Metody 179
Komentarz 179
Przykad 179
NotesInternational 4.5x 4.6x 5.0 181
Waciwoci 181
Przykad 183
NotesItem 4.0 4.1x 4.5x 4.6x 5.0 184
Waciwoci 185
Metody 189
Komentarz 191
Przykad 192
NotesLog 4.0 4.5x 4.6x 5.0 193
Waciwoci 193
Metody 194
Komentarz 197
Przykad 197
NotesName 4.0 4.1x 4.5x 4.6x 5.0 199
Waciwoci 199
Metody 202
Komentarz 202
Przykad 203
NotesNewsletter 4.0 4.1x 4.5x 4.6x 5.0 204
Waciwoci 205
Metody 206
Komentarz 207
Przykad 207
NotesOutline 5.0 209
Waciwoci 209
Metody 210
Przykad 212
NotesOutlineEntry 5.0 213
Waciwoci 213
Metody 215
Przykad 216
NotesRegistration 4.6x 5.0 217
Waciwoci 217
Metody 219
Komentarz 226
Przykad 227
NotesReplication 5.0 228
Waciwoci 228
Metody 232
Komentarz 233
Przykad 233
NotesRichTextItem 4.0 4.1x 4.5x 4.6x 5.0 234
Waciwoci 235
Metody 236
Komentarz 241
Przykad 242
NotesRichTextParagraphStyle 5.0 244
Waciwoci 244
Metody 247
Komentarz 249
Przykad 249
NotesRichTextStyle 4.6x 5.0 251
Waciwoci 251
Komentarz 254
Przykad 254
NotesRichTextTab 5.0 255
Waciwoci 255
Metody 256
Komentarz 256
Przykad 256
NotesSession 4.0 4.5x 4.6x 5.0 258
Waciwoci 258
Metody 263
Przykad 269
NotesTimer 4.5x 4.6x 5.0 270
Waciwoci 270
Metody 271
Zdarzenia 271
Komentarz 271
Przykad 272
Wstp
NotesView 4.0 4.1x 4.5x 4.6x 5.0 273
Waciwoci 274
Metody 279
Komentarz 288
Przykad 289
NotesViewColumn 4.6x 5.0 291
Waciwoci 291
Komentarz 300
Przykad 300
NotesViewEntry 5.0 302
Waciwoci 303
Metody 305
Przykad 305
NotesViewEntryCollection 5.0 307
Waciwoci 307
Metody 308
Komentarz 312
Przykad 312
NotesViewNavigator 5.0 313
Waciwoci 313
Metody 314
Komentarz 318
Przykad 318
ACL 4.6x 5.0 323
Skadnia Javy 323
Metody 323
Komentarz 331
Przykad 331
ACLEntry 4.6x 5.0 333
Skadnia Javy 333
Metody 333
Komentarz 347
Przykad 347
Agent 4.6x 5.0 350
Skadnia Javy 350
Metody 350
Komentarz 355
Przykad 355
AgentContext 4.6x 5.0 357
Skadnia Javy 357
Metody 357
Przykad 362
Database 4.0 4.1x 4.5x 4.6x 5.0 364
Skadnia Javy 364
Metody 365
Komentarz 385
Przykad 386
3
DateRange 4.5x 4.6x 5.0 387
Skadnia Javy 387
Parametry Javy 387
Metody 388
Przykad 389
DateTime 4.6x 5.0 390
Skadnia Javy 390
Parametry Javy 390
Metody 391
Komentarz 396
Przykad 397
DbDirectory 4.6x 5.0 399
Skadnia Javy 399
Parametry Javy 399
Metody 400
Komentarz 403
Przykad 403
Document 4.6x 5.0 405
Skadnia Javy 406
Metody 406
Komentarz 424
Przykad 426
DocumentCollection 4.6x 5.0 427
Skadnia Javy 427
Metody 428
Komentarz 436
Przykad 437
EmbeddedObject 4.6x 5.0 439
Skadnia Javy 439
Metody 440
Komentarz 442
Przykad 443
Form 4.6x 5.0 444
Skadnia Javy 444
Metody 444
Przykad 447
International 4.6x 5.0 449
Skadnia Javy 449
Metody 449
Komentarz 452
Przykad 452
Item 4.6x 5.0 453
Skadnia Javy 453
Parametry Javy 453
Metody 454
Komentarz 463
Przykad 464
Log 4.6x 5.0 466
Skadnia Javy 466
Parametry Javy 466
Metody 466
Komentarz 470
Przykad 471
Name 4.6x 5.0 473

Skadnia Javy 473
Parametry Javy 473
Metody 473
Komentarz 479
Przykad 480
Newsletter 4.6x 5.0 482
Skadnia Javy 482
Parametry Javy 482
Metody 483
Komentarz 486
Przykad 486
NotesFactory 5.0 488
Skadnia Javy 488
Metody 488
Przykad 489
Outline 5.0 491
Skadnia Javy 491
Parametry Javy 491
Metody 491
Przykad 494
OutlineEntry 5.0 496
Skadnia Javy 496
Metody 496
Przykad 500
Registration 4.6x 5.0 503
Skadnia Javy 503
Metody 503
Komentarz 514
Przykad 515
Replication 5.0 516
Skadnia Javy 516
Metody 516
Komentarz 523
Przykad 524
RichTextItem 4.6x 5.0 526
Skadnia Javy 526
Metody 526
Komentarz 534
Przykad 535
RichTextParagraphStyle 5.0 537
Skadnia Java 537
Parametry Javy 537
Metody 537
Komentarz 544
Przykad 544
RichTextStyle 4.6x 5.0 546
Skadnia Javy 546
Parametry Javy 546
Metody 546
Komentarz 552
Przykad 552
RichTextTab 5.0 554

Skadnia Javy 554
Metody 554
Komentarz 555
Przykad 556
Session 4.6x 5.0 558
Skadnia Javy 558
Metody 559
Przykad 566
View 4.6x 5.0 567
Skadnia Javy 567
Metody 568
Komentarz 585
Przykad 585
ViewColumn 4.6x 5.0 588
Skadnia Javy 588
Metody 588
Komentarz 600
Przykad 600
ViewEntry 5.0 601
Skadnia Javy 601
Metody 602
Przykad 605
ViewEntryCollection 5.0 606
Skadnia Javy 606
Metody 606
Komentarz 612
Przykad 612
ViewNavigator 5.0 614
Skadnia Javy 614
Metody 614
Komentarz 622
Przykad 622
4.0 4.1x 4.5x 4.6x 5.0
Klasa NotesDatabase jest jedn z najwaniejszych i najbardziej podstawowych klas Notes, poniewa to wanie NotesDatabase (Notes Storage Facility) jest gwnym orodkiem przechowywania
danych w Notes/Domino. Opanowanie jej licznych metod pozwala na uzyskanie biegoci w projektowaniu aplikacji Notes/Domino.

lub

Istnieje wiele sposobw uzyskiwania dostpu do obiektw NotesDatabase. Oto niektre z nich.
Zupenie now baz danych utworzy moemy przy uyciu metody z klasy NotesDbDirectory.
Now baz danych, w oparciu o ju istniejc, mona utworzy, korzystajc z metod
,

lub z klasy NotesDatabase.
Jeli znamy nazw serwera bazy danych i nazw pliku, to dostp do bazy moemy uzyska przy
uyciu metod: oraz klasy NotesSession ( 258).
Do dostpu do bazy danych, w ktrej aktualnie dziaa skrypt, bez wskazywania serwera lub nazwy
pliku, suy waciwo z klasy NotesSession ( 259).
Znajc serwer i mona istniejc baz danych otworzy za pomoc metody ! "
# .
Znajc nazw serwera, na ktrym rezyduje baza danych, ale nie znajc nazwy jej pliku, mona
uy klasy NotesDbDirectory ( 131).
Aby okreli, ktre bazy s ksikami adresowymi, a nastpnie otworzy je, uywamy waciwoci $$#
% z NotesSession ( 258).
Jeli chcemy otworzy baz pocztow biecego uytkownika, stosujemy metod !&.
Majc dowolny z obiektw: NotesView, NotesDocument, NotesDocumentCollection, NotesACL,
NotesViewEntry lub NotesViewEntryCollection warto sprbowa skorzysta z waciwoci '
lub ' .

strServer
(wmg)
Warto cigu zawierajca nazw serwera, na ktrym rezyduje baza danych. Aby wskaza
baz na lokalnej maszynie, naley poda pusty cig znakw (" ").
strFileName
(wmg)
Warto cigu zawierajca ciek dostpu oraz nazw pliku bazy Notes w katalogu danych
Notes. Jeli baza nie znajduje si w katalogu danych Notes to, precyzujc parametr, naley
poda pen ciek dostpu do pliku.

ACL
O.Ref.

())$
*

Zwraca obiekt NotesACL ( 72) zawierajcy list kontroli dostpu do bazy danych.
Agents

+(+$
*
Zwraca tablic obiektw NotesAgent ( 92). Jeli dostp do waciwoci nastpuje ze stacji
roboczej, to tablica zawiera bdzie publiczne i personalne agenty, nalece do biecego
uytkownika. Jeli waciwo jest wywoana z serwera, to tablica bdzie zawieraa tylko
agenty publiczne.
NotesDatabase
AllDocuments
O.Ref.

+($
$
*
Waciwo zwraca nieposortowany zbir NotesDocumentCollection ( 158) zawierajcy

wszystkie dokumenty z bazy danych. Ze wzgldu na to, e metoda moe zwrci ogromny
zbir waciwoci, naley jej uywa tylko wtedy, gdy rzeczywicie chcemy uzyska dostp
do kadego z dokumentw bazy. Chcc uzyska dostp do podzbioru dokumentw w bazie
danych, mona zastosowa metody +
#, z klasy NotesView ( 283),
- ( 117) lub - ( 108) z klasy NotesDatabase albo .#, z klasy
NotesViewEntry. Poniszy przykad ilustruje zastosowanie waciwoci.

!
"# $

Categories
O/Z

+(+
$
*

($
*
+

Zawiera wykaz kategorii, w ktrych baza danych wystpuje w Notes Database Library.
Jeli zawiera wiele kategorii, to s one rozdzielane przecinkami lub rednikami.
Created

+($$
*

Waciwo zwraca wariant typu (7) wskazujcy godzin i dat utworzenia bazy danych.
CurrentAccessLevel

+($
*

Zwraca poziom dostpu dla uytkownika biecego w postaci liczby o zakresie od 0

(brak dostpu) do 6 (dostp na poziomie menadera). Warto pamita, e waciwo
nie zwraca poziomu dostpu dla uytkownika biecego stacji roboczej, lecz poziom
dostpu dla osoby, ktra ostatnia zapisywaa agenta na serwerze. Kada z liczb moe by
przedstawiona jako jedna z nastpujcych staych.
Warto staej
Poziom dostpu
%%&'&%()&
Uprawnienia dostpu na poziomie No Access (brak dostpu).
%%&'&%(&*)+,)-
Uprawnienia dostpu na poziomie Depositor (deponent).
%%&'&%(-&&-
Uprawnienia dostpu na poziomie Reader (czytelnik).
%%&'&%(,.)-
Uprawnienia dostpu na poziomie Author (autor).
%%&'&%(&+,)-
Uprawnienia dostpu na poziomie Editor (redaktor).
%%&'&%(&+/&-
Uprawnienia dostpu na poziomie Designer (projektant).
%%&'&%(0/&-
Uprawnienia dostpu na poziomie Manager (menader).
DelayUpdates
O/Z
T/F

+(/$$
*

($
*/$
Waciwo ta wskazuje, czy operacje zapisu w bazie danych powinny by dokonywane

niezwocznie, czy te przetwarzane wsadowo (co przyspiesza dziaanie). Ustawienie wartoci
). (warto standardowa) powoduje, e aktualizacje bazy danych s dokonywane
natychmiast, powodujc zatrzymanie skryptu do czasu zakoczenia operacji zapisu.
W przeciwnym razie (gdy warto parametru wynosi /., aktualizacje zatrzymywane s
w pamici i wykonywane pniej, a skrypt kontynuuje swoje dziaanie. Warto pamita,
e mimo i metoda ta przyspiesza dziaanie, to podczas awarii serwera niezapisane dane
zostan utracone. Waciwo wpywa na operacje zapisu i usuwania dokumentw.
DesignTemplateName

+($
*
Jeli baza danych dziedziczy swoj struktur od szablonu, to waciwo zwraca nazw
szablonu. W przeciwnym razie zwraca pusty cig znakw (" "). Jeli baza danych dziedziczy
tylko pewne elementy projektu (takie jak widok lub nawigator), a nie cay projekt, to metoda
zwraca pusty cig znakw.

0"121 34 5 65 78 " , 9:
;5
FileName

+($
*
Zwraca rzeczywist nazw i rozszerzenie pliku bazy, bez cieki dostpu.

Poniszy przykad demonstruje budow oglnej procedury, ktra na podstawie waciwoci
serwera klasy NotesDatabase, takich m.in. jak , '- i , zwraca miejsce
lokalizacji biecej bazy danych. Stanowi moe uyteczny dodatek do biblioteki skryptu,
zwaszcza gdy chcemy tworzy aplikacje wielobazodanowe i wszystkie bazy danych
przechowywa w tym samym katalogu (co jest dobr praktyk).
*< - = % $'
>? "# 6#
34
>
@ 36AA6
% B$ "
< *C "
< *C% ;D < *C% < *C$E% < $$$
% F$ =
% B$< *C
- = % %
& <
FilePath

+('-$
*
Zwraca rzeczywist nazw i rozszerzenie pliku bazy oraz jego ciek dostpu. Bazy danych
na stacjach roboczych zwracaj pen ciek dostpu (na przykad, C:\Notes\data\definiti\
cmgr.nsf), a bazy danych na serwerze wzgldn ciek dostpu do katalogu danych Notes
(na przykad definiti\cmgr.nsf).
5.0 FolderRefsEnabled
O/Z
T/F

+($0$
*

($
* $0
NotesDatabase
Waciwo mona stosowa do okrelania, czy referencje do folderw s dla okrelonej bazy
danych dostpne. Jeli waciwo ta ma warto /., to okrela folder, w ktrym dokument
si znajduje. Przed rozpoczciem sprawdzania odniesie folderu upewnij si, e waciwo
jest odpowiednio ustawiona. Kada baza uywajca odniesie folderu musi mie uaktywnion
waciwo
$0.
Forms
O/Z
()

+(
$
*
Metoda zwraca tablic wszystkich obiektw NotesForm ( 177) z bazy danych.

5.0 IsDirectoryCatalog
T/F

+(
+$
*

Zastosowanie waciwoci determinuje, czy baza danych jest baz typu Directory Catalog,
znan rwnie jako Lightweight NAB. Waciwo zwraca warto ). dla wszystkich baz,
do ktrych dostp nie nastpi przez waciwo $$#
% klasy NotesSession ( 258)

i ktre s jawnie otwarte (waciwo ! zwraca /.; zobacz opis !).
IsFTIndexed
T/F

+( $1$$
* !
Waciwo ta wskazuje, czy baza danych posiada indeks penotekstowy. Zwraca warto
/., gdy indeks istnieje i )., w przeciwnym razie.
IsMultiDbSearch
O/Z
T/F

+(& -$
* "#
Waciwo zwraca warto /., gdy baza jest czci indeksu wyszukiwania wielobazowego
i )., w przeciwnym razie.
IsOpen
T/F

+( !$
* $
Metoda wskazuje, czy baza danych zostaa otwarta. Zwraca warto /., gdy jest ona otwarta
i ). w przeciwnym razie.
IsPrivateAddressBook
T/F

+('#$
* %&
Waciwo '$$#
% zwraca warto /. dla dowolnej bazy danych, bdcej

Osobist ksik adresow, do ktrej dostp nastpi przy uyciu waciwoci $$#
%
z klasy NotesSession ( 258). Dla wszelkich baz, z Osobist ksik adresow wcznie,
do ktrych dostp nastpi inaczej ni za porednictwem waciwoci $$#
% z klasy
NotesSession, waciwo zwraca warto )..
IsPublicAddressBook
T/F

+(' #$
* %&
Waciwo IsPublicAddressBook zwraca warto /. dla dowolnej bazy danych, bdcej
Osobist ksik adresow, do ktrej dostp nastpi przy uyciu waciwoci $$#
%
z klasy NotesSession ( 258). Dla wszelkich baz, z Osobist ksik adresow wcznie,
do ktrych dostp nastpi inaczej ni za porednictwem waciwoci $$#
% z klasy
NotesSession, waciwo ta zwraca warto )..
LastFTIndexed

+() $1$
* !
Zwraca wariant typu DATE zawierajcy dat i godzin ostatniego indeksowania

penotekstowego bazy danych. Jeli baza danych nie posiada indeksu, waciwo zwraca
do popularn dat 12/30/1899.
LastModified

+(&
$$
*"
Zwraca wariant typu DATE zawierajcy dat i godzin ostatniej modyfikacji bazy danych.
Managers
()

+(&+
*"
Waciwo zwraca tablic zawierajc nazwy osb, serwerw oraz grup, ktrym przyznano
dostp do bazy danych na poziomie Manager. Poniszy przykad demonstruje zastosowanie
tej waciwoci do przesyania menaderom baz danych da podwyszenia poziomu dostpu
do bazy. Moe by uruchamiana w postaci agenta wywoywanego przez kliknicie przycisku.

0
0
1
-C, 2+ 0, @G$
05 *A 5 "A
1 , 24A3
54 A A54 5 C7$
1
% H$
1 , 2 !78 , $
1
% B$
1 , 2+ ;5678 < C8 8
= $
1
% B$
1 , 2- +78 - +$
1
% B$
1 , 2*A 5 "A 5 C$
0 < 0 " $
5.0 MaxSize
Et

+(+&12$
*"!#'
Waciwo zwraca maksymalny dopuszczalny rozmiar bazy danych okrelony podczas jej
utworzenia.
MaxSizeV5

+($ &132$
*"!#'()
Zwraca minimalny dopuszczalny rozmiar dla bazy danych Notes wersji 5.0.
NotesDatabase
Parent
O.Ref.

+(
$
*
Waciwo zwraca obiekt NotesSession ( 258) przedstawiajcy aktualn sesj NotesSession.

PercentUsed

+($ /$$
*
Waciwo zwraca rozmiar przestrzeni przeznaczonej w bazie do przechowywania danych.

Prosz zapozna si z poniszym przykadem.

+; * IJF,C

& +;
ReplicaID
ReplicaID

+( $
*
Waciwo zwraca ID repliki bazy danych (jest to 16-cyfrowy cig znakw

alfanumerycznych).
ReplicationInfo
O.Ref.

+( 0
$
*
Kada baza Notes zawiera jeden obiekt NotesReplication ( 271), do ktrego za pomoc tej
waciwoci mona uzyska dostp.
Server

+($
*#
Waciwo zwraca nazw serwera, na ktrym rezyduje baza danych. Jeli baza znajduje si na
stacji roboczej, to metoda zwraca pusty cig znakw (" ").
Size

+($ 2$
*#'
Waciwo zwraca rozmiar bazy danych w bajtach w formacie liczby typu double.
SizeQuota
O/Z

+(+4
$
*#'*

($
*#'*+4

Waciwo zwraca rozmiar przestrzeni dyskowej przydzielonej bazie danych. Nie wszystkie
bazy ograniczone s przydzielon im przestrzeni. Dla tych baz metoda zwraca warto 0.
Jeli skrypt (a dokadnie jego waciciel) ma dostp administracyjny do serwera, to moe
zmienia t waciwo, ale w wikszoci wypadkw stanowi ona parametr tylko do odczytu.
TemplateName

+($
*
Waciwo zwraca pusty cig (" "), jeli baza nie jest szablonem. W przeciwnym razie zwraca
warto wprowadzon dla nazwy szablonu.
Title
O/Z

+($
*

($
*
Waciwo zawiera tytu bazy danych (wywietlany na ikonie bazy). Nie mona zmieni
tytuu bazy danych, przez ktr nastpi dostp do tej waciwoci.
UnprocessedDocuments
O.Ref.

+($/
$$
*
Ta niesamowicie przydatna waciwo obowizuje jedynie agentw lub skrypty akcji

widokw. Moe by uyta tylko na obiektach NotesDocument uzyskanych dziki waciwoci
obiektu NotesSession ( 259). Zwraca obiekt NotesDocumentCollection
( 149) zawierajcy dokumenty nalece do bazy danych, ktre biecy agent lub akcja
widoku uznaje za nieprzetworzone. Gdy dostp nastpuje spoza agenta lub akcji widoku,
zwrcony zbir nie bdzie zawiera adnych dokumentw. Natomiast w razie wywoania
waciwoci /
$
z obiektu NotesDatabase, do ktrego dostp nie nastpi
za pomoc waciwoci , metoda zgosi bd.
Warto pamita, e jeli uywamy agentw dziaajcych na nowych i zmodyfikowanych
dokumentach, niedawno otrzymanych dokumentach pocztowych, dokumentach wklejonych
lub wieo zmodyfikowanych, to w celu oznaczenia kadego dokumentu zbioru jako
przetworzonego trzeba wywoa metod /$'
$
z NotesSession ( 268).
Zapobiega to wielokrotnemu przetwarzaniu tych samych dokumentw.
Gdy nie wywoamy tej metody dla kadego dokumentu, to agent przy kadorazowym
uruchomieniu bdzie przetwarza te same dokumenty. Naley pamita, e waciwo
/$'
$
oznacza dokument jako przetworzony jedynie dla wyranie okrelonego
agenta, w ktrym zostaa wywoana.
Waciwo /
$
uyta w akcji widoku zwraca te same dokumenty, co baza
danych uruchomiona na wybranych dokumentach.
Ponisza tabela ilustruje dokadnie, czego mona oczekiwa, uywajc tej metody.
Zadanie (ktrego wystpienie
uruchamia agenta)
Wynik jest zbiorem dokumentw (Document Collection)

speniajcym ponisze kryteria
Wszystkie dokumenty
w bazie danych
Spenione s kryteria wyszukiwania okrelone w Database

Builder (edytorze bazy danych).
Wszystkie dokumenty nowe

i zmodyfikowane od czasu
ostatniego uruchomienia agenta
Nieprzetwarzane uprzednio przez baz za pomoc metody

* .
Niedawno utworzone
lub zmodyfikowane

Builder (Edytorze bazy danych).
Wszystkie nie przeczytane

dokumenty w widoku
Dokumenty z widoku, nieprzeczytane, speniajce kryteria

podane w Database Builder (Edytorze bazy danych).
Wszystkie dokumenty w widoku

Dokumenty zaznaczone /
akcja widoku
Dokumenty zaznaczone w widoku, speniajce kryteria

Uruchomione jeden raz
Dokument biecy.
NotesDatabase
Zadanie (ktrego wystpienie

uruchamia agenta)
Wynik jest zbiorem dokumentw (Document Collection)

speniajcym ponisze kryteria
Niedawno wysane dokumenty
wieo wysane do bazy danych, speniajce kryteria podane

w Database Builder (Edytorze bazy danych).
Niedawno modyfikowane
dokumenty
Dokumenty wieo zmodyfikowane, speniajce kryteria

Views
()

+(5 $
*(+
Waciwo zwraca tablic zawierajc wszystkie obiekty NotesView ( 273) znajdujce si

w bazie danych.

Compact
)+2$00$
*

Metoda nie posiada parametrw, zwraca liczb (w formacie dugim), reprezentujc przestrze
zwolnion w wyniku kompaktowania.
Create
$
*
!+&12
strServer
(wmg)
Nazwa serwera, na ktrym chcemy utworzy baz danych. Aby utworzy baz na komputerze
lokalnym, naley poda pusty cig znakw (" ").
strFilename
(wmg)
Nazwa pliku, ktr chcemy nada bazie.

intOpenFlag
(wmg)
T/F
Parametr ten suy do otwierania bazy danych podczas jej tworzenia (gdy jego warto wynosi
/.). Jeli otwarcie nie jest przewidywane, naley parametrowi nada warto ).. W celu
jej pniejszego otwarcia naley zastosowa metod ! lub ! 0&
$0$.
intMaxSize
(opc)
Maksymalny dopuszczalny rozmiar bazy danych.

Metoda umoliwia tworzenie nowego obiektu NotesDatabase. Oba parametry:
i mog zawiera pusty cig, o ile zainicjowalimy ju obiekt NotesDatabase,
podajc nazw serwera i pliku.
CreateCopy
$
$
*

&12
strServer
(wmg)
Nazwa serwera, na ktrym chcemy utworzy now kopi baz danych. Jeli ma nim by
komputer lokalny, to poda musimy pusty cig znakw (" ").
strFileName
(wmg)
Nazwa pliku, ktr chcemy przypisa nowej kopii.

intMaxSize
(opc)

Metoda
tworzy now kopi (nie replik) aktualnej bazy danych, zwracan jako
obiekt NotesDatabase. Warto pamita, e w razie gdyby baza danych na serwerze okrelonym
w miaa tak sam nazw, jak baza podana w , to zgoszony zostaby
bd. Jednoczenie do nowej bazy danych skopiowana zostanie lista dostpu ACL.
CreateDocument
$

$
*

Metoda nie posiada parametrw, zwraca nowy obiekt NotesDocument ( 135). Mona j
stosowa wraz z automatyzacj !). w celu utworzenia nowego obiektu bez stosowania metody
. Naley pamita o wywoaniu metody z obiektu NotesDocument w celu zapisania
nowego dokumentu na dysku.
CreateFromTemplate
$
$
*

-&12
strServer
(wmg)
Nazwa serwera, na ktrym znajdowa si bdzie nowa kopia bazy danych. Pozostawienie
pustego cigu znakw (" ") spowoduje utworzenie nowej kopii na komputerze lokalnym.
strFileName
(wmg)

intlnherit
(wmg)
T/F
Jeli chcemy, aby nowa baza danych dziedziczya struktur bazy biecej, to warto
parametru - ustawiamy na /.. W przeciwnym razie na )..
intMaxSize
(opc)

Metoda stosowana jest do tworzenia nowej bazy z ju istniejcej. Nowa baza bdzie zawiera
wszystkie elementy projektu i dokumenty bazy rdowej. Zwraca obiekt NotesDatabase
przedstawiajcy now baz danych.
CreateOutline

!$
*
$ 0!
strName
(wmg)
Nazwa nowego szkicu.

intDefauItOutline
(opc)
Warto /. tworzy nowy szkic z domylnymi wpisami.
T/ F
Metoda ! pozwala na utworzenie nowego szkicu w biecej bazie danych.
CreateReplica
$
$
*

NotesDatabase
11
strServer
(wmg)
Nazwa serwera, na ktrym znajdowa si bdzie nowa kopia bazy danych. Pozostawienie
pustego cigu znakw (" ") spowoduje utworzenie nowej kopii na komputerze lokalnym.
strFileName
(wmg)

Metoda zwraca obiekt NotesDatabase przedstawiajcy now replik kopii biecej bazy
danych. Lista dostpu ACL aktualnej bazy danych kopiowana jest do nowej repliki. Podobnie
jak w metodzie
, w razie gdyby baza danych na serwerze okrelonym w
miaa tak sam nazw, jak baza podana w , to zgoszony zostaby bd.
Jednoczenie do nowej bazy danych skopiowana zostanie lista dostpu ACL.
EnableFolder
$
*
$
strFolderName
(wmg)
Nazwa udostpnianego foldera.

Metoda .
$ pozwala na udostpnianie folderw.
5.0 FTDomainSearch
$

$
* #4&1

.

!
!-!

strQuery
(wmg)
Zapytanie, ktre chcemy wykona.

intMaxDocs
(wmg)
Okrela maksymaln liczb dokumentw, ktre maj zosta zwrcone w odpowiedzi na

zapytanie. Aby otrzyma wszystkie dokumenty speniajce kryterium, naley parametrowi
&1
nada warto 0.
strEntryForm
(wmg)
Nazwa formularza wyszukiwania w katalogu dziedziny.

intSortOptions
(opc)
Wskazuje, ktr z trzech opcji sortowania chcemy zastosowa. Mona posuy si jedn
z nastpujcych staych.
Staa
Rezultat
<,()-&
Sortowanie w oparciu o trafno wyniku. Jest to ustawienie domylne.
<,(,&(&
Sortuje wyniki w oparciu o dat utworzenia dokumentu w kolejnoci malejcej.
<,(,&(
Sortuje wyniki w oparciu o dat utworzenia dokumentu w kolejnoci rosncej.
intOtherOptions
(opc)
Wskazuje dodatkowe opcje wyszukiwania. Mona zastosowa jedn z nastpujcych staych:

6.&, 6#., 6 ).7.& lub 6/887.
intStart
Pierwsza zwracana strona.
(opc)
intCount
(opc)
Liczba zwracanych stron.

Jest to bardzo uyteczna metoda, ktra dokonuje przeszukania penotekstowego wszystkich
dokumentw w domenie. Zwraca NotesDocument zawierajcy wykaz formatowanych
dokumentw speniajcych warunki zapytania. Aby uy metody, trzeba najpierw
skonfigurowa katalog domeny (Domain Catalog).
FTSearch
$

$
*#4&1

!
!-

strQuery
(wmg)

intMaxDocs
(wmg)
Okrela maksymaln liczb dokumentw, ktre maj zosta zwrcone w odpowiedzi na

zapytanie. Aby otrzyma wszystkie dokumenty speniajce kryterium, naley parametrowi
&1
nada warto 0.
intSortOptions
(opc)
Staa
Rezultat
<,()-&
<,(,&(&
<,(,&(
intOtherOptions
(opc)
Wskazuje dodatkowe opcje wyszukiwania. Mona zastosowa jedn z nastpujcych staych:

6.&, 6#., 6 ).7.& lub 6/887.
Metoda - wyszukuje wszystkie dokumenty znajdujce si w bazie danych i zwraca
zbir NotesDocumentCollection zawierajcy wszystkie dokumenty speniajce kryterium
zapytania penotekstowgo. Dokumenty sortowane s w oparciu o parametr
!
.
Jeli nie podano adnego typu opcji, dokumenty s zwracane w porzdku wedug trafnoci
ich wyniku. Jeli wyniki s sortowane wedug daty, nie bd zwracane wyniki trafnoci.
Wane jest, aby pamita, e metoda ta bdzie dziaa nawet wtedy, gdy baza danych nie jest
indeksowana penotekstowo, jednak dziaanie bdzie duo wolniejsze.
Jeli nie chcemy przeszukiwa wszystkich dokumentw w bazie danych, moemy uy
metody - klasy NotesView ( 281) w celu wyszukiwania tylko dokumentw zawartych
w okrelonym widoku. Moemy rwnie uy - z NotesDocumentCollection.
Poniszy przykad ukazuje tworzenie oglnej funkcji wyszukiwania penotekstowego.
*< &2 CK " 2+ " $

+; +<,+ 2 ,C
+; = ,C
<,+ 2, $
&
NotesDatabase
13
+;0"21+&5 6

! 6
L03 5 66 G

6
! 6
" A
5 C

6 G
6
MNHO:<,+ 2 $P,C
&2<
& +;
& +;
& +;
&2 C <, CK 02$
& <
GetAgent
+
+$
*, +
strAgentName
(wmg)
Nazwa agenta, ktrego chcemy otrzyma.

Metoda zwraca obiekt NotesAgent ( 89) przedstawiajcy podanego agenta.
GetDocumentByID
$

$
*, %

strNoteID

dokumentu.
(wmg)
Metoda zwraca obiekt NotesDocument ( 135) przedstawiajcy dokument, ktrego

odpowiada wartoci podanej w
. Prosz zapozna si z poniszym przykadem.

" 1 +QP$
>
53

G 6
GetDocumentByUNID
$

$
*
#/
/
strNoteUNID
(wmg)
Universal ID dokumentu.
Metoda zwraca obiekt NotesDocument ( 135) przedstawiajcy dokument, ktrego /
odpowiada wartoci podanej w / . Prosz zapozna si z poniszym przykadem.

" 1 +
1:9<NPQR<<FS1FQPRQHQ9Q<9FF::N&Q$
>
53

G 6
GetDocumentByURL
$

$
*, %/)
$
/-9 9
$'
1
'
1
$$
strURL
(wmg)
Adres URL strony, ktr chcemy uzyska. Mona wprowadzi do 15 kB.
intReload
(opc)
Jeli ustawiona zostanie warto 0 (standardowa), to strona pobierana bdzie z hosta

w Internecie tylko wtedy, gdy nie ma jej w bazie danych Web Navigator Notes. Podanie
wartoci 1 sprawia, e strona pobierana jest z internetowego hosta do pamici za kadym
razem. Warto 2 sprawia, e strona adowana jest z hosta tylko wtedy, gdy zostaa
zmodyfikowana po zapisaniu jej w bazie danych Web Navigatora.
intUrlList
(opc)
Parametr ten pozwala okreli, czy chcemy zachowa odnoniki z pobranych stron w polu
o nazwie /))% w dokumencie Notes (Web Navigator tworzy nowe pole /))% za
kadym razem, gdy rozmiar pola osignie 64 kB). Podanie wartoci /. spowoduje zapisanie
adresw URL w polu (polach) /))%, a warto ). oznacza, e nie bd zapisane.
Warto 1 (/.) podajemy, gdy adresy URL chcemy zapisa w polu (polach) /))%. Jeli
nie chcemy zapisywa adresw URL w polu (polach) /))% wystarczy poda warto 0
().) lub te pomin ten parametr. Jeli zapiszemy adresy URL, moemy stosowa je
w agentach. Mona, na przykad, utworzy agenta, ktry otwiera witryny Web w bazie Web
Navigatora, a nastpnie aduje wszystkie witryny Web zapisane w kadym z pl /))%.
strCharset
(opc)
Okrela kodowanie znakw & &. (na przykad, ISO 8859-1 dla U.S.A.), ktre chcemy
zastosowa do przetwarzania stron internetowych przez Web Navigator. Parametr powinien
zosta okrelony, tylko gdy Web Navigator nie jest w stanie poprawnie okreli zestawu
znakw & &..
strWebusername
(opc)
Jeli host wymaga identyfikacji, mona uy tego parametru, by poda hostowi nazw
uytkownika.
strWebpassword
(opc)
Jeli host wymaga identyfikacji, mona uy tego parametru, by poda hostowi haso.
strProxywebusername
(opc)
Jeli serwer proxy wymaga identyfikacji, mona uy tego parametru, by poda serwerowi
nazw uytkownika.
strProxywebpassword
(opc)
haso.
intReturnimmediately
(opc)
Parametr wskazuje, czy kontynuowa skrypt, nie czekajc na zakoczenie procesu pobierania.
Podanie wartoci /. oznacza natychmiastowy zwrot wartoci przez skrypt, ). (warto
standardowa) oznacza oczekiwanie. Naley pamita, e podanie wartoci /. nie powoduje
zwrotu obiektu NotesDocument, reprezentujcego stron o okrelonym adresie URL.
Metoda
#/) tworzy dokument w bazie danych nawigatora sieci i zwraca dla
niego obiekt NotesDocument (pod warunkiem, e wartoci parametru $
nie jest ).). Metoda dziaa zarwno na bazach Server Web Navigator, jak i Personal Web
Navigator.

" 1 -%C7TT
; B$
>
53

G 6
NotesDatabase
15
GetForm
0

$
*,
strName
(wmg)
Nazwa albo alias formularza, do ktrego chcemy uzyska dostp.

Metoda zwraca obiekt NotesForm ( 177) przedstawiajcy formularze okrelone w parametrze
.
GetOutline

!$
*,$
strName
(wmg)
Nazwa szkicu, do ktrego chcemy uzyska dostp.

Metoda pozwala uzyska dostp do istniejcych obiektw szkicu.
GetProfileDocCollection
$

$
*,

strName
(wmg)
Nazwa zbioru, ktr chcemy pobra.

Metoda zwraca zbir dokumentw profilowanych.
GetProfileDocument
$

$
*, '
00
/
strProfilename
(wmg)
Nazwa albo alias profilu dokumentu, ktry chcemy utworzy lub do ktrego chcemy uzyska
dostp.
strUsername
(opc)
Nazwa uytkownika lub klucz dokumentu profilu, ktry chcemy pobra bd utworzy.
Jeli aden dokument profilu nie odpowiada podanym parametrom, to metoda utworzy
nowy dokument profilu z nazw i nazw uytkownika okrelon przez '
0
i /. W przeciwnym wypadku zwrcony zostanie obiekt NotesDocument ( 135),
przedstawiajcy dokument profilu odpowiadajcy parametrom. Prosz zapozna si
z poniszym przykadem.

" *; * C

C $
>3

G 6
GetURLHeaderInfo
:$
*,- /):$9
9
$'
1 '
1
$
strURL
(wmg)
Adres URL strony, ktr chcemy pobra. Mona wprowadzi do 15 kB.
strHeadername
(wmg)
Okrela cig nagwka dla adresu URL, ktry chcemy pobra. Wicej informacji
o dopuszczalnych cigach nagwkw mona znale w specyfikacji HTTP
(http://www.w3.org/).
strWebusername
(opc)
Jeli host wymaga identyfikacji, mona uy tego parametru, by poda hostowi nazw
uytkownika.
strWebpassword
(opc)
Jeli host wymaga identyfikacji, mona uy tego parametru, by poda hostowi haso.
strProxywebusername
(opc)
nazw uytkownika.
strProxywebpassword
(opc)
haso.
Metoda zwraca warto danego nagwka w postaci cigu. Jeli zwrcony zostanie pusty
cig znakw (" "), to albo pod podanym adresem URL nie znaleziono wartoci danego
nagwka, albo podany adres URL nie zosta znaleziony w ogle.
GetView

5 $
*5 5
strViewName
(wmg)
Parametr ten okrela nazw lub alias widoku bd foldera, do ktrych chcemy uzyska dostp.
Stosowa naley albo pen nazw widoku lub foldera (z ukonikami wcznie), albo pene
aliasy, ale nigdy nazw i aliasw jednoczenie.
Wywoanie metody z lokalnej bazy danych powoduje zwrcenie publicznych i osobistych
widokw i folderw. Dla baz danych opartych na serwerze metoda zwrci tylko widoki
i foldery publiczne.
Metoda 5 zwraca obiekt NotesView ( 273) przedstawiajcy widok albo folder okrelony
przez parametr 5 .
GrantAccess
$
*)
strName
(wmg)
Parametr ten suy do wskazania nazwy osoby, grupy lub serwera, dla ktrych chcemy ustawi
poziom dostpu.
intLevel
(wmg)
Wskazuje poziom dostpu, ktry chcemy przydzieli. Ponisza tabela przedstawia

dopuszczalne stae dla tego parametru.
Staa
Opis
%%&'&%()&
%%&'&%(&*)+,)-
NotesDatabase
17
Staa
Opis
%%&'&%(-&&-
%%&'&%(,.)-
%%&'&%(&+,)-
%%&'&%(&+/&-
%%&'&%(0/&-
Metoda pozwala ustawi w bazie ACL odpowiedni poziom dostpu dla dowolnego serwera,
osoby lub grupy. Jeli serwer, osoba lub grupa okrelone w istniej w ACL, to ich
poziomy dostpu aktualizowane s zgodnie z wartoci parametru ). W innej sytuacji,
podana nazwa dodawana jest do listy ACL wraz z okrelonym poziomem dostpu. Wywoanie
metody powoduje nadanie rolom ACL ich wartoci domylnych.
New
$
+

$
+

strServer
(wmg)
Nazwa serwera, na ktrym chcemy utworzy baz danych. Aby utworzy baz na komputerze
lokalnym, naley poda pusty cig znakw (" ").
strFileName
(wmg)
Rzeczywista nazwa pliku bazy danych, do ktrej chcemy uzyska dostp.

Metoda zwraca obiekt NotesDatabase przedstawiajcy baz o podanej lokalizacji i nazwie.
Jeli to moliwe, otwiera rwnie t baz. Warto pamita, e metoda ta (w przeciwiestwie
do metod innych klas) nie tworzy nowej bazy na dysku. W tym celu skorzysta naley
z jednej z trzech nastpujcych metod: ,
lub .
Open
Open
0+$
*$
strServer
(wmg)
Wskazuje nazw serwera, na ktrym znajduje si baza danych. Jeli baza istnieje na
komputerze lokalnym, to poda wystarczy pusty cig znakw (" ").
strFileName
(wmg)
Okrela faktyczn nazw pliku bazy danych, dostp do ktrej chcemy uzyska. Jeli obiekt
NotesDatabase zosta ju zainicjalizowany, to jako parametr poda naley pusty cig (" ").
Metoda ! pozwala na takie otwarcie bazy danych, aby skrypt mia dostp do jej
waciwoci. Zwraca warto /., gdy znalezienie i otwarcie okrelonej bazy danych koczy
si powodzeniem i warto )., jeli okrelonej bazy danych nie mona byo otworzy.
W celu zastosowania tej metody, wywoujcy j skrypt musi mie prawa dostpu do bazy
na poziomie co najmniej czytelnika.
Istniej dwa podstawowe sposoby uycia metody. Pierwszy polega na otwarciu ju
zainicjalizowanej bazy danych. Wwczas, jako warto kadego z dwu parametrw wystarczy
poda pusty cig znakw (" "). Sposb drugi polega na otwarciu ju istniejcej bazy danych,
ktra nie zostaa jeszcze zainicjalizowana, kiedy to trzeba poda zarwno nazw serwera,
jak i nazw pliku.
OpenByReplicaID
+$
*$ %
strServer
(wmg)
Parametr wskazuje nazw serwera, na ktrym znajduje si baza danych. Jeli baza istnieje
na komputerze lokalnym, naley zastosowa pusty cig znakw.
strRepID
(wmg)
Okrela replica ID bazy danych, ktr chcemy otworzy.

Metoda stosuje replica ID do prby otwarcia bazy danych. Zwraca warto /., gdy otwarcie
zakoczyo si powodzeniem oraz warto ). w przeciwnym przypadku. Prosz zapozna
si z poniszym przykadem.

$
;" ) 1 - +RQHQ99:17FFQBFFB$
OpenIfModified
+$
*$ " 0$

strServer
(wmg)
Parametr wskazuje nazw serwera, na ktrym znajduje si baza danych. Jeli baza istnieje
na komputerze lokalnym, to jako warto paramertu poda naley pusty cig znakw.
strDbfiIe
(wmg)
Parametr ten okrela nazw pliku bazy danych, ktr chcemy otworzy.
ndtNotesDateTime
(wmg)
O.Ref.
Obiekt NotesDateTime ( 124) przedstawiajcy dat graniczn. Jeli jakikolwiek dokument

bazy by po tej dacie modyfikowany, to baza danych zostaje otwarta. Jeli aden dokument
w bazie nie zosta po tej dacie zmodyfikowany, to baza danych pozostaje zamknita.
Metoda pozwala na warunkowe otwieranie bazy danych w oparciu o to, czy dokonywano
modyfikacji zawartych w niej dokumentw. Zwraca warto /., gdy otwarcie podanej bazy
zakoczyo si powodzeniem oraz warto ). w przeciwnym przypadku.
OpenMail
$
*$ "
Metoda nie posiada parametrw. Podejmuje prb lokalizacji oraz otwarcia bazy pocztowej
biecego uytkownika. Jeli metoda wywoywana jest przez skrypt uruchomiony na stacji
roboczej, to prbuje okreli plik poczty uytkownika na podstawie zapisw w pliku Notes.ini.
Jeli metoda !& wywoana jest na serwerze, to agent prbuje ustali serwer pocztowy
oraz plik poczty waciciela tego skryptu na podstawie zamieszczonej na serwerze Publicznej
ksiki adresowej. Warto pamita, e skrypty dziaajce na serwerze nie posiadaj prawa
dostpu do innych serwerw, tak wic, wywoujc t metod na serwerze, plik poczty
powinien znajdowa si na serwerze, na ktrym uruchomiony zostanie agent. W innym razie
wygenerowany zostanie kommunikat o bdzie.
NotesDatabase
19
OpenURLDb
+$
*$
Metoda prbuje otworzy baz danych Web Navigator. Zwraca warto /., gdy otwarcie
bazy zakoczyo si powodzeniem oraz warto ). w przeciwnym przypadku.
OpenWithFailover
+$
*$ .
strServer
(wmg)
Nazwa gwnego serwera, w ktrego klastrze rezyduje baza danych.

strFileName
(wmg)
Faktyczna nazwa pliku bazy danych, ktr chcemy otworzy.

Metoda pozwala skorzysta z zalet stosowanego w Domino klastrowania serwerw i otworzy
baz danych znajdujc si na serwerze wchodzcym w skad klastra. Zwraca warto /.,
gdy otwarcie bazy zakoczyo si pomylnie oraz warto ). w przeciwnym przypadku.
Jeli baza nie moe zosta otwarta na wybranym serwerze, to metoda automatycznie odnajduje
w klastrze jej replik, po znalezieniu ktrej, otwiera baz danych. Waciwo wskazuje
wwczas serwer, na ktrym replika bazy zostaa znaleziona.
QueryAccess
)$
**
strName
(wmg)
Parametr ten okrela nazwy osoby, grupy lub serwera, dla ktrych chcemy zna poziom
dostpu.
Metoda 4 szuka w licie dostpu ACL bazy danych wartoci okrelonych
w parametrze oraz zwraca sta reprezentujc poziom dostpu dla podanej nazwy.
Zestawienie moliwych staych przedstawiamy w tabeli poniej.
Staa
Poziom dostpu
%%&'&%()&
%%&'&%(&*)+,)-
%%&'&%(-&&-
%%&'&%(,.)-
%%&'&%(&+,)-
%%&'&%(&+/&-
%%&'&%(0/&-
A oto sposb, w jaki omawiana metoda wyprowadza poziom dostpu.

Jeli podana nazwa (osoby, grupy lub serwera) jest ujta na licie dostpu i jest rwnie
czonkiem grup (grupy) wchodzcych w skad listy ACL, to zwracany jest najwyszy poziom
dostpu.
Jeli podana nazwa odnosi si do czonka grupowego, to zwracany jest poziom dostpu dla tej
grupy.
Jeli podana nazwa odnosi si do czonka kilku grup listy ACL, to zwracany jest poziom
dostpu grupy o najwyszym jej poziomie.
Jeli podana nazwa nie odnosi si do czonka adnej grupy, to zwracany jest standardowy
poziom dostpu.
Warto pamita, e metoda korzysta z podstawowej ksiki adresowej urzdzenia, na ktrym
wykonywany jest skrypt. Na stacji roboczej uywa osobistej ksiki adresowej, a na serwerze
publicznej ksiki adresowej.
Remove
$
*
Metoda nie przyjmuje parametrw. Trwale usuwa baz danych z przestrzeni dyskowej.
Replicate
+$
*
strServerNarne
(wmg)
Okrela nazw serwera, wzgldem ktrego replikacja ma by wykonywana. Jeli istnieje

wicej ni jedna replika bazy danych na podanym serwerze, to zreplikowane zostan
wszystkie.
Metoda daje moliwo automatyzacji procesu replikacji. Zwraca warto /., jeli proces
replikacji zakoczy si pomylnie oraz warto )., w razie wygenerowania jakichkolwiek
bdw. Poniej przedstawiamy przykad jej zastosowania.

- / T ; $
RevokeAccess
$
*&
strName
(wmg)
Parametr ten uywany jest do okrelania nazwy serwera, osoby lub grupy, ktrych prawa
dostpu odwoujemy.
Metoda pozwala usun wskazany w parametrze serwer, osob lub grup z listy ACL
bazy danych, skutecznie nadajc mu dostp o poziomie domylnym. Warto pamita, e tym
wanie rni si od przyznania dostpu o poziomie brak dostpu przy uyciu metody
, co cakowicie zamyka dostp serwera, osoby lub grupy do bazy danych. Jeli
serwer, osoba lub grupa podana w parametrze nie moe by znaleziona, to metoda

% generuje komunikat o bdzie.
Search
$

$
*#

$
&1

strFormula
(wmg)
Parametr stosowany jest do przekazania formuy funkcji @ okrelajcej kryteria wyboru.

ndtNotesDateTime
(wmg)
O.Ref.
Parametr jest obiektem NotesDateTime ( 124) stosowanym jako data graniczna, tak aby
przeszukiwane byy tylko dokumenty utworzone lub modyfikowane po tej dacie.
NotesDatabase
21
intMaxDocs
(wmg)
Parametr okrela liczb dokumentw, ktra powinna by zwracana w zbiorze. Nadajc temu
parametrowi warto 0, sprawimy, e zbir dokumentw speniajcych kryterium wyboru
bdzie obejmowa wszystkie dokumenty.
Metoda zwraca niesortowany zbir NotesDocumentCollection zawierajcy wszystkie
dokumenty speniajce kryterium wyboru. Zawsze jest zdecydowanie wolniejsza
od wyszukiwania penotekstowego. Jeli zatem istnieje alternetywa, zawsze warto korzysta
z wyszukiwania penotekstowego.
UnprocessedFTSearch
$

$
* #4
&1

!
!-!

strQuery
(wmg)

intMaxDocs
(wmg)
Okrela maksymaln liczb dokumentw, ktre chcemy otrzyma w odpowiedzi na zapytanie.

Aby otrzyma wszystkie dokumenty speniajce kryterium, parametrowi temu nada naley
warto 0.
intSortOptions
(opc)
Staa
Rezultat
<,()-&
<,(,&(&
<,(,&(
intOtherOptions
(opc)
Okrela dodatkowe opcje wyszukiwania. Mona zastosowa jedn z nastpujcych staych:

6.&, 6#., 6 ).7.& lub 6/887.
Metoda /
$- dotyczy jedynie agentw i skryptw akcji widokw. Mona
z niej korzysta tylko dla obiektw NotesDocument uzyskanych dziki waciwoci
z obiektu NotesSession ( 259). Zwraca ona obiekt NotesDocumentCollection
( 158) bdcy zbiorem dokumentw bazy danych, ktre biecy agent lub akcja widoku
uznaje za nieprzetworzone. Gdy dostp nastpuje spoza agenta lub akcji widoku, zwrcony
zbir nie bdzie zawiera adnych dokumentw. Natomiast wywoanie metody z obiektu
NotesDatabase, do ktrego dostp nastpi inaczej ni poprzez waciwo
spowoduje zgoszenie bdu.
$
/$'
$
Waciwo /
$
Zadanie (na ktrego
wystpienie agent zadziaa)
Wynik jest zbiorem dokumentw (Document Collection),

ktry spenia ponisze kryteria
Wszystkie dokumenty
w bazie danych.

Wszystkie nowe
ostatniego uruchomienia
dokumenty.
Nieprzetwarzane poprzednio przez tego agenta za pomoc

metody * .
Niedawno utworzone
lub modyfikowane.

Wszystkie nieczytane
dokumenty w widoku.

Wszystkie dokumenty
w widoku.

Wybrane dokumenty.
Dokumenty wskazane (wybrane) w widoku, speniajce kryteria

Uruchomione jeden raz.
Biecy dokument.
Niedawno wysane
dokumenty.
wieo wysane do bazy danych, speniajce kryteria podane

dokumenty.
wieo modyfikowane dokumenty, speniajce kryteria podane

Wklejone dokumenty.
wieo wklejone dokumenty, speniajce kryteria podane

Jeli warunki te s spenione, metoda wykonuje penotekstowe wyszukiwanie dokumentw

uwaanych przez agenta za nieprzetworzone i zwraca rezultaty w postaci posortowanego
zbioru dokumentw.
UnprocessedSearch
$

$
*/
$-

$
&1

strFormula
(wmg)
Parametr stosowany jest do przekazania formuy funkcji @ okrelajcej kryteria wyboru.

ndtNotesDateTime
(wmg)
O.Ref.
Parametr jest obiektem NotesDateTime ( 124) okrelajcym dat graniczn, tak aby
przeszukiwane byy tylko dokumenty utworzone lub modyfikowane po tej dacie.
NotesDatabase
intMaxDocs
23
(wmg)
Parametr okrela liczb dokumentw, ktre chcemy otrzyma w wyniku zapytania.

Aby otrzyma wszystkie dokumenty speniajce kryterium, naley w parametrze wpisa 0.
Metoda zwraca niesortowany NotesDocumentCollection zawierajcy wszystkie dokumenty
speniajce kryterium wyboru. Metoda ta jest zawsze znacznie wolniejsza ni wykonywanie
wyszukiwania penotekstowego. Powinna by zatem unikana, gdy istnieje moliwo
wyszukiwania penotekstowego.
Metoda dotyczy jedynie agentw lub skryptw akcji widokw. Moe by uyta tylko
na obiektach NotesDocument uzyskanych dziki waciwoci z obiektu
NotesSession. Zwraca obiekt NotesDocumentCollection zawierajcy dokumenty z bazy
danych, ktre biecy agent lub akcja widoku uznaje za nieprzetworzone. Gdy dostp
nastpuje spoza agenta lub akcji widoku, zwrcony zbir nie bdzie zawiera adnych
dokumentw. Natomiast, wywoujc metod z obiektu NotesDatabase, do ktrego dostp
nie nastpi z , metoda zgosi bd.
$
/$'
$
Waciwo /
$
Zadanie (na ktrego

Wszystkie dokumenty
w bazie danych.
Spenione s kryteria wyszukiwania okrelone

Wszystkie nowe
ostatniego uruchomienia
dokumenty.
Nieprzetwarzane poprzednio przez tego agenta

za pomoc metody * .
Niedawno utworzone
lub modyfikowane.
Spenione s kryteria wyszukiwania okrelone

Wszystkie nieczytane
dokumenty w widoku.

Wszystkie dokumenty
w widoku.

Wybrane dokumenty /
widoki akcji.
Dokumenty wskazane (wybrane) w widoku, speniajce kryteria

Uruchomione jeden raz.
Biecy dokument.
Zadanie (na ktrego


Niedawno wysane
dokumenty.
wieo wysane do bazy danych. speniajce kryteria podane

dokumenty.
wieo modyfikowane dokumenty, speniajce kryteria podane

Wklejone dokumenty.
wieo wklejone dokumenty, speniajce kryteria podane

Jeli warunki te s spenione, metoda wykonuje penotekstowe wyszukiwanie dokumentw

uwaanych przez agenta za nieprzetworzone i zwraca rezultaty w postaci posortowanego
zbioru dokumentw.
UpdateFTIndex
$
* !+
intCreateFlag
(wmg)
T/F
Jeli nie istnieje aden indeks, to podanie wartoci /. spowoduje utworzenie nowego
indeksu (dotyczy to tylko baz lokalnych). W przeciwnym razie, istniejcy indeks zostanie
zaktualizowany. Jeli baza nie jest lokalna, to jako warto parametru + poda
naley )..
Metoda pozwala na programowe tworzenie (tylko dla lokalnych baz danych) lub aktualizacj
indeksw penotekstowych.

Podczas wykonywania dziaa na klasie NotesDatabase pamita naley o nastpujcych zasadach.
Przed uzyskaniem dostpu do wikszoci waciwoci bazy danych przy uyciu LotusScript, baz
trzeba najpierw otworzy.
W celu sprawdzenia, czy baza danych jest otwarta mona skorzysta z waciwoci !. Jeli
nie jest, to mona j otworzy, wywoujc metod ! ! 0&
$0$.
Aby otworzy baz danych, uytkownik lub agent uytkownika (a dokadnie waciciel agenta)
musi posiada prawa dostpu o poziomie co najmniej typu Reader.
aden skrypt dziaajcy na serwerze nie moe uzyska dostpu do bazy danych na innym serwerze. Prba uzyskania takiego dostpu spowoduje wygenerowanie bdu. Podobnie, jeli skrypt nie
posiada prawa dostpu o poziomie odpowiednim do wykonywanej funkcji, to jego wykonanie zostanie zaniechane.
Jeli dostp do obiektu NotesDatabase nastpuje przez obiekt NotesDbDirectory, to obiekt taki nie
jest uwaany za otwarty. Za otwarte nie mona uwaa rwnie obiektw NotesDatabase, do ktrych dostp uzyskujemy przez waciwo $$#
% z klasy NotesSession. Take obiekty NotesDatabase utworzone za pomoc metody nie s otwarte, o ile baza nie istnieje na podanym
w parametrze serwerze i nie posiada nazwy okrelonej w .
NotesDatabase
Zamknite bazy udostpniaj jednak nastpujce waciwoci: , '-,

'$$#
%, ' $$#
%, ' oraz .
25
!,

Poniszy przykad sprawdza, czy aktualny uytkownik znajduje si na licie ACL biecej bazy
danych oraz czy posiada prawa dostpu na poziomie przynajmniej autora. Jeli tak, to udostpniany jest mu dostp na poziomie Editor. Jeli nie, to przyznawany jest mu dostp na poziomie
Reader.

& %&
< + "
%
& / <&
C & +C "
+; & ,C
+; & % = I%%&'&%(,.)-,C
& % = %%&'&%(&+,)& +;
&2
& +;
%
/ %%&'&%(-&&-$

Lotus Notes I Domino. Leksykon

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Lotus Notes I Domino. Leksykon

Uploaded by

Copyright:

Available Formats

IDZ DO

Lotus Notes i Domino.

Autorzy: Tim Bankes, Dave Hatter

Lotus Notes i Domino. Leksykon jest narzdziem niezastpionym dla osb

NotesACLEntry 4.0 4.1x 4.5x 4.6x 5.0 80

NotesEmbeddedObject 4.0 4.1x 4.5x 4.6x 5.0 169

Parametry LotusScript 209

Parametry LotusScript 255

Parametry LotusScript 270

Parametry Javy 390

Parametry Javy 453

Parametry Javy 466

Name 4.6x 5.0 473

Parametry Javy 473

Parametry Javy 482

Parametry Javy 491

RichTextTab 5.0 554

4.0 4.1x 4.5x 4.6x 5.0

Waciwo zwraca nieposortowany zbir NotesDocumentCollection ( 158) zawierajcy

Zwraca poziom dostpu dla uytkownika biecego w postaci liczby o zakresie od 0

Uprawnienia dostpu na poziomie No Access (brak dostpu).

Uprawnienia dostpu na poziomie Depositor (deponent).

Uprawnienia dostpu na poziomie Reader (czytelnik).

Uprawnienia dostpu na poziomie Author (autor).

Uprawnienia dostpu na poziomie Editor (redaktor).

Uprawnienia dostpu na poziomie Designer (projektant).

Uprawnienia dostpu na poziomie Manager (menader).

Waciwo ta wskazuje, czy operacje zapisu w bazie danych powinny by dokonywane

Zwraca rzeczywist nazw i rozszerzenie pliku bazy, bez cieki dostpu.

Metoda zwraca tablic wszystkich obiektw NotesForm ( 177) z bazy danych.

% klasy NotesSession ( 258)

Waciwo ' $$#

% zwraca warto /. dla dowolnej bazy danych, bdcej

Zwraca wariant typu DATE zawierajcy dat i godzin ostatniego indeksowania

Waciwo zwraca obiekt NotesSession ( 258) przedstawiajcy aktualn sesj NotesSession.

Waciwo zwraca rozmiar przestrzeni przeznaczonej w bazie do przechowywania danych.

Waciwo zwraca ID repliki bazy danych (jest to 16-cyfrowy cig znakw

Ta niesamowicie przydatna waciwo obowizuje jedynie agentw lub skrypty akcji

Wynik jest zbiorem dokumentw (Document Collection)

Spenione s kryteria wyszukiwania okrelone w Database

Wszystkie dokumenty nowe

Nieprzetwarzane uprzednio przez baz za pomoc metody

Spenione s kryteria wyszukiwania okrelone w Database

Wszystkie nie przeczytane

Dokumenty z widoku, nieprzeczytane, speniajce kryteria

Wszystkie dokumenty w widoku

Dokumenty z widoku, nieprzeczytane, speniajce kryteria

Dokumenty zaznaczone w widoku, speniajce kryteria

Uruchomione jeden raz

Zadanie (ktrego wystpienie

Wynik jest zbiorem dokumentw (Document Collection)

Niedawno wysane dokumenty

wieo wysane do bazy danych, speniajce kryteria podane

Dokumenty wieo zmodyfikowane, speniajce kryteria

Waciwo zwraca tablic zawierajc wszystkie obiekty NotesView ( 273) znajdujce si

Nazwa pliku, ktr chcemy nada bazie.

Maksymalny dopuszczalny rozmiar bazy danych.

Nazwa pliku, ktr chcemy przypisa nowej kopii.

Maksymalny dopuszczalny rozmiar bazy danych.

Nazwa pliku, ktr chcemy przypisa nowej kopii.

Maksymalny dopuszczalny rozmiar bazy danych.

Nazwa nowego szkicu.

Nazwa pliku, ktr chcemy przypisa nowej kopii.

% klasy NotesSession ( 258)

Waciwo '$$#

% zwraca warto /. dla dowolnej bazy danych, bdcej

+;0"21+&5 6

Metoda zwraca obiekt NotesDocument ( 135) przedstawiajcy dokument, ktrego