Use your current version of Help-Database for actual and correct references.
ACL class ..............................
ACLEntry class .........................
Agent class ............................
AgentContext class .....................
Database class .........................
DateRange class ........................
DateTime class .........................
DbDirectory class ......................
Document class .........................
DocumentCollection class ...............
EmbeddedObject class ...................
Form class .............................
International class ....................
Item class .............................
Log class ..............................
MIMEEntity class .......................
MIMEHeader class .......................
Name class .............................
Newsletter class .......................
Outline class ..........................
OutlineEntry class .....................
Registration class .....................
Replication class ......................
RichTextItem class .....................
RichTextParagraphStyle class ...........
RichTextStyle class ....................
RichTextTab class ......................
Session class ..........................
Stream class ...........................
View class .............................
ViewColumn class .......................
ViewEntry class ........................
ViewEntryCollection class ..............
ViewNavigator class ....................
* Supporting components ................
* Java constants ........................
ACL class
Properties:
InternetLevel property public int getInternetLevel()
IsUniformAccess property public boolean isUniformAccess()
Parent property public Database getParent()
Roles property public java.util.Vector getRoles()
Methods:
addRole method public void addRole(String name)
createACLEntry method public ACLEntry createACLEntry(String name, int level)
deleteRole method public void deleteRole(String name)
getEntry method public ACLEntry getEntry(String ename)
getFirstEntry method public ACLEntry getFirstEntry()
getNextEntry method public ACLEntry getNextEntry()
removeACLEntry method public void removeACLEntry(String name)
renameRole method public void renameRole(String oldname, String newname)
save method public void save()
ACLEntry class
Properties:
IsAdminReaderAuthor property public boolean isAdminReaderAuthor()
IsAdminServer property public boolean isAdminServer()
IsCanCreateDocuments property public boolean isCanCreateDocuments()
IsCanCreateLSOrJavaAgent property public boolean isCanCreateLSOrJavaAgent()
IsCanCreatePersonalAgent property public boolean isCanCreatePersonalAgent()
IsCanCreatePersonalFolder property public boolean isCanCreatePersonalFolder()
IsCanCreateSharedFolder property public boolean isCanCreateSharedFolder()
IsCanDeleteDocuments property public boolean isCanDeleteDocuments()
IsGroup property public boolean isGroup()
IsPerson property public boolean isPerson()
IsPublicReader property public boolean isPublicReader()
IsPublicWriter property public boolean isPublicWriter()
IsServer property public boolean isServer()
Level property public int getLevel()
Name property public String getName()
NameObject property public Name getNameObject()
Parent property public ACL getParent()
Roles property public java.util.Vector getRoles()
UserType property public int getUserType()
Methods:
disableRole method public void disableRole(String role)
enableRole method public void enableRole(String role)
isRoleEnabled method public boolean isRoleEnabled(String role)
remove method public void remove()
Agent class
Properties:
Comment property public String getComment()
CommonOwner property public String getCommonOwner()
IsEnabled property public boolean isEnabled()
IsNotesAgent property public boolean isNotesAgent()
IsPublic property public boolean isPublic()
IsWebAgent property public boolean isWebAgent()
LastRun property public DateTime getLastRun()
Name property public String getName()
Owner property public String getOwner()
ParameterDocID property public String get
Parent property public Database getParent()
Query property public String getQuery()
ServerName property public String getServerName()
Target property public int getTarget()
Trigger property public int getTrigger()
Methods:
remove method public void remove()
run method public void run( )
runOnServer method public int runOnServer( )
save method
public void save()
AgentContext class
Properties:
CurrentAgent property public Agent getCurrentAgent()
CurrentDatabase property public Database getCurrentDatabase()
DocumentContext property public Document getDocumentContext()
EffectiveUserName property public String getEffectiveUserName()
LastExitStatus property public int getLastExitStatus()
LastRun property public DateTime getLastRun()
SavedData property public Document getSavedData()
UnprocessedDocuments property public DocumentCollection getUnprocessedDocuments()
Methods:
unprocessedFTSearch method public DocumentCollection unprocessedFTSearch(String query, int maxdocs)
unprocessedSearch method public DocumentCollection unprocessedSearch(String formula, DateTime limit, int maxdocs)
updateProcessedDoc method public void updateProcessedDoc(Document doc)
Database class
Properties:
ACL property public ACL getACL()
Agents property public java.util.Vector getAgents()
AllDocuments property public DocumentCollection getAllDocuments()
Categories property public String getCategories()
Created property public DateTime getCreated()
CurrentAccessLevel property public int getCurrentAccessLevel throws NotesException
DesignTemplateName property public String getDesignTemplateName()
FileName property public String getFileName()
FilePath property public String getFilePath()
FolderReferencesEnabled property public boolean getFolderReferencesEnabled()
Forms property public java.util.Vector getForms()
IsDelayUpdates property public boolean isDelayUpdates()
IsFTIndexed property public boolean isFTIndexed()
IsOpen property public boolean isOpen()
IsPrivateAddressBook property public boolean isPrivateAddressBook()
IsPublicAddressBook property public boolean isPublicAddressBook()
LastFTIndexed property public DateTime getLastFTIndexed()
LastModified property public DateTime getLastModified()
Managers property public java.util.Vector getManagers()
MaxSize property public long getMaxSize()
Parent property public Session getParent()
PercentUsed property public double getPercentUsed()
ReplicaID property public String getReplicaID()
ReplicationInfo property public Replication getReplicationInfo()
Server property public String getServer()
Size property public double getSize()
SizeQuota property public int getSizeQuota()
TemplateName property public String getTemplateName()
Title property public String getTitle()
Views property public java.util.Vector getViews()
Methods:
compact method public int compact()
createCopy method public Database createCopy(String server, String dbfile)
createDocument method public Document createDocument()
createFromTemplate method public Database createFromTemplate(String server, String dbfile, boolean inherit)
createOutline method public Outline createOutline(String name)
createReplica method public Database createReplica(String server, String dbfile)
enableFolder method public void enableFolder(String folder)
FTDomainSearch method " that follows. int max The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents. int sortopt Integer. Use one of the following constant
FTSearch method " that follows. int max The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents (up to 5,000. See
FTSearchRange method " that follows. int max The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents. sortopt Integer. Use one of the following constants to
getAgent method public Agent getAgent(String name)
getDocumentByID method public Document getDocumentByID(String noteid)
getDocumentByUNID method public Document getDocumentByUNID(String unid)
getDocumentByURL method public Document getDocumentByURL(String url, boolean reload)
getForm method public Form getForm(String name)
getOutline method public Outline getOutline(String outlinename)
getProfileDocCollection public DocumentCollection getProfileDocCollection(String profileName)
getProfileDocument method public Document getProfileDocument(String profile, String profilekey)
getURLHeaderInfo method public String getURLHeaderInfo(String url, String header, String webuser, String webpasswd, String proxyuser, String proxypasswd)
getView method public View getView(String name)
grantAccess method public void grantAccess(String name, int level)
open method public boolean open()
queryAccess method public int queryAccess(String name)
queryAccessRoles method public Vector queryAccessRoles(String name)
remove method public void remove()
replicate method public boolean replicate(String server)
revokeAccess method public void revokeAccess(String name)
search method public DocumentCollection search(String formula)
updateFTIndex method public void updateFTIndex(boolean create)
DateRange class
Properties:
EndDateTime property public DateTime getEndDateTime()
Parent property public Session getParent()
StartDateTime property public DateTime getStartDateTime()
Text property public String getText()
DateTime class
Properties:
DateOnly property public String getDateOnly()
GMTTime property public String getGMTTime()
IsDST property public boolean isDST()
LocalTime property public String getLocalTime()
Parent property public Session getParent()
TimeOnly property public String getTimeOnly()
TimeZone property public int getTimeZone()
ZoneTime property public String getZoneTime()
Methods:
adjustDay method public void adjustDay(int n)
adjustHour method public void adjustHour(int n)
adjustMinute method public void adjustMinute(int n)
adjustMonth method public void adjustMonth(int n)
adjustSecond method public void adjustSecond(int n)
adjustYear method public void adjustYear(int n)
convertToZone method public void convertToZone(int zone, boolean isDST)
setAnyDate method public void setAnyDate()
setAnyTime method public void setAnyTime()
setNow method public void setNow()
timeDifference method public int timeDifference(DateTime dt)
toJavaDate method public java.util.Date toJavaDate()
DbDirectory class
Properties:
Name property public String getName()
Parent property public Session getParent()
Methods:
createDatabase method public Database createDatabase(String dbfile)
getFirstDatabase method public Database getFirstDatabase(int type)
getNextDatabase method public Database getNextDatabase()
openDatabase method public Database openDatabase(String dbfile)
openDatabaseByReplicaID method public Database openDatabaseByReplicaID(String rid)
openDatabaseIfModified method public Database openDatabaseIfModified(String dbfile, DateTime date)
openMailDatabase method public Database openMailDatabase()
Document class
Properties:
Authors property public java.util.Vector getAuthors()
ColumnValues property public java.util.Vector getColumnValues()
Created property public DateTime getCreated()
EmbeddedObjects property public java.util.Vector getEmbeddedObjects()
EncryptionKeys property public java.util.Vector getEncryptionKeys()
FolderReferences property public java.util.Vector getFolderReferences()
FTSearchScore property public int getFTSearchScore()
HasEmbedded property public boolean hasEmbedded()
IsDeleted property public boolean isDeleted()
IsEncryptOnSend property public boolean isEncryptOnSend()
IsNewNote property public boolean isNewNote()
IsProfile property public boolean isProfile()
IsResponse property public boolean isResponse()
IsSaveMessageOnSend property public boolean isSaveMessageOnSend()
IsSentByAgent property public boolean isSentByAgent()
IsSigned property public boolean isSigned()
IsSignOnSend property public boolean isSignOnSend()
IsValid property public boolean isValid()
Items property public java.util.Vector getItems()
Key property public String getKey()
LastAccessed property public DateTime getLastAccessed()
LastModified property public DateTime getLastModified()
NameOfProfile property public String getNameOfProfile()
NoteID property public String getNoteID()
ParentDatabase property public Database getParentDatabase()
ParentDocumentUNID property public String getParentDocumentUNID()
ParentView property public View getParentView()
Responses property public DocumentCollection getResponses()
Signer property public String getSigner()
Size property public int getSize()
UniversalID property public String getUniversalID()
Verifier property public String getVerifier()
Methods:
appendItemValue method public Item appendItemValue(String name)
closeMIMEEntities method public boolean closeMIMEEntities()
computeWithForm method public boolean computeWithForm(boolean dodatatypes, boolean raiseerror)
copyAllItems method public void copyAllItems(Document doc, boolean replace)
copyItem method public Item copyItem(Item item)
copyToDatabase method public Document copyToDatabase(Database db)
createMIMEEntity method public MIMEEntity createMIMEEntity()
createReplyMessage method public Document createReplyMessage(boolean toall)
createRichTextItem method public RichTextItem createRichTextItem(String name)
encrypt method public void encrypt()
generateXML method public String generateXML()
getAttachment method public EmbeddedObject getAttachment(String filename)
getFirstItem method public Item getFirstItem(String name)
getItemValue method public java.util.Vector getItemValue(String name)
getItemValueCustomData method public Object getItemValueCustomData(String itemname)
getItemValueCustomDataBytes method public bytes[] getItemValueCustomDataBytes(String itemname, String datatypename)
getItemValueDouble method public double getItemValueDouble(String name)
getItemValueInteger method public int getItemValueInteger(String name)
getItemValueString method public String getItemValueString(String name)
getMIMEEntity method public MIMEEntity getMIMEEntity()
hasItem method public boolean hasItem(String name)
makeResponse method public void makeResponse(Document doc)
putInFolder method public void putInFolder(String name)
remove method public boolean remove(boolean force)
removeFromFolder method public void removeFromFolder(String name)
removeItem method public void removeItem(String name)
renderToRTItem method public boolean renderToRTItem(RichTextItem rtitem)
replaceItemValue method public Item replaceItemValue(String name, Object value)
replaceItemValueCustomData method public void replaceItemValueCustomData(String itemname, Object userobj)
replaceItemValueCustomDataBytes method public void replaceItemValueCustomData(String itemname, String datatypename, byte[] bytearray)
save method public boolean save()
send method public void send()
sign method public void sign()
DocumentCollection class
Properties:
Count property public int getCount()
IsSorted property public boolean isSorted()
Parent property public Database getParent()
Query property public String getQuery()
Methods:
addDocument method public void addDocument(Document doc)
deleteDocument method public void deleteDocument(Document doc)
FTSearch method " that follows. int maxdocs The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents.
getDocument method public Document getDocument(Document doc)
getFirstDocument method public Document getFirstDocument()
getLastDocument method public Document getLastDocument()
getNextDocument method public Document getNextDocument()
getNthDocument method public Document getNthDocument(int n)
getPrevDocument method public Document getPrevDocument()
putAllInFolder method public void putAllInFolder(String folderName)
removeAll method public void removeAll(boolean force)
removeAllFromFolder method public void removeAllFromFolder(String foldername)
stampAll method public void stampAll(String itemname, Object value)
updateAll method public void updateAll()
EmbeddedObject class
Properties:
ClassName property public String getClassName()
FileSize property public int getFileSize()
InputSource property public org.xml.sax.InputSource getInputSource()
InputStream property public java.io.InputStream getInputStream()
Name property public String getName()
Object property public int getObject()
Parent property public RichTextItem getParent()
Source property public String getSource()
Type property public int getType()
Verbs property public java.util.Vector getVerbs()
Methods:
activate method public int activate(boolean show)
doVerb method public void doVerb(String verb)
extractFile method public void extractFile(String path)
remove method public void remove()
Form class
Properties:
Aliases property public java.util.Vector getAliases()
Fields property public java.util.Vector getFields()
FormUsers property public java.util.Vector getFormUsers()
IsProtectReaders property public boolean isProtectReaders()
IsProtectUsers property public boolean isProtectUsers()
IsSubForm property public boolean isSubForm()
Name property public String getName()
Parent property public Database getParent()
Readers property public java.util.Vector getReaders()
Methods:
getFieldType method public int getFieldType(String name)
remove method public void remove()
International class
Properties:
AMString property public String getAMString()
CurrencyDigits property public int getCurrencyDigits()
CurrencySymbol property public String getCurrencySymbol()
DateSep property public String getDateSep()
DecimalSep property public String getDecimalSep()
IsCurrencySpace property public boolean isCurrencySpace()
IsCurrencySuffix property public boolean isCurrencySuffix()
IsCurrencyZero property public boolean isCurrencyZero()
IsDateDMY property public boolean isDateDMY()
IsDateMDY property public boolean isDateMDY()
IsDateYMD property public boolean isDateYMD()
IsDST property public boolean isDST()
IsTime24Hour property public boolean isTime24Hour()
Parent property public Session getParent()
PMString property public String getPMString()
ThousandsSep property public String getThousandsSep()
TimeSep property public String getTimeSep()
TimeZone property public int getTimeZone()
Today property public String getToday()
Tomorrow property public String getTomorrow()
Yesterday property public String getYesterday()
Item class
Properties:
DateTimeValue property public DateTime getDateTimeValue()
IsAuthors property public boolean isAuthors()
IsEncrypted property public boolean isEncrypted()
IsNames property public boolean isNames()
IsProtected property public boolean isProtected()
IsReaders property public boolean isReaders()
IsSaveToDisk property public boolean isSaveToDisk()
IsSigned property public boolean isSigned()
IsSummary property public boolean isSummary()
LastModified property public DateTime getLastModified()
Name property public String getName()
Parent property public Document getParent()
Text property public String getText()
Type property public int getType()
ValueDouble property public double getValueDouble()
ValueInteger property public int getValueInteger()
ValueLength property public int getValueLength()
Values property public java.util.Vector getValues()
ValueString property public String getValueString()
Methods:
abstractText method public String abstractText(int maxlen, boolean dropvowels, boolean userdict)
appendToTextList method public void appendToTextList(String value)
containsValue method public boolean containsValue(Object value)
copyItemToDocument method public Item copyItemToDocument(Document doc)
getMIMEEntity method public MIMEEntity getMIMEEntity()
getValueCustomData method public Object getValueCustomData()
getValueCustomDataBytes method public byte[] getValueCustomDataBytes(String datatypename)
remove method public void remove()
setValueCustomData method public void setValueCustomData(Object userobj)
setValueCustomDataBytes method public void setValueCustomData(String datatypename, Byte bytearray)
Log class
Properties:
IsLogActions property public boolean isLogActions()
IsLogErrors property public boolean isLogErrors()
IsOverwriteFile property public boolean isOverwriteFile()
NumActions property public int getNumActions()
NumErrors property public int getNumErrors()
Parent property public Session getParent()
ProgramName property public String getProgramName()
Methods:
close method public void close()
logAction method public void logAction(String action)
logError method public void logError(int code, String text)
logEvent method public void logEvent(String text, String queue, int event, int severity)
openAgentLog method public void openAgentLog()
openFileLog method public void openFileLog(String filepath)
openMailLog method public void openMailLog(java.util.Vector recipients, String subject)
openNotesLog method public void openNotesLog(String server, String database)
MIMEEntity class
Properties:
BoundaryEnd property public String getBoundaryEnd( )
BoundaryStart property public String getBoundaryStart( )
Charset property public String getCharset( )
ContentAsText property public String getContentAsText( )
ContentSubType property public String getContentSubType( )
ContentType property public String getContentType( )
Encoding property public int getEncoding( )
HeaderObjects property public java.util.Vector getHeaderObjects( )
Headers property public String getHeaders( )
Preamble property public String getPreamble( )
Methods:
createChildEntity method public MIMEEntity createChildEntity( )
createHeader method public MIMEEntity createHeader(String headerName)
createParentEntity method public MIMEEntity createParentEntity( )
decodeContent method public void decodeContent( )
encodeContent method public void encodeContent(int encoding)
getContentAsBytes method public void getContentAsBytes(Stream stream)
getContentAsText method public void getContentAsText(Stream stream)
getEntityAsText method public void getEntityAsText(Stream stream)
getFirstChildEntity method public MIMEEntity getFirstChildEntity( )
getNextEntity method public MIMEEntity getNextEntity( )
getNextSibling method public MIMEEntity getNextSibling( )
getNthHeader method public MIMEHeader getNthHeader(String headerName)
getParentEntity method public MIMEEntity getParentEntity( )
getPrevEntity method public MIMEEntity getPrevEntity( )
getPrevSibling method public MIMEEntity getPrevSibling( )
getSomeHeaders method public String getSomeHeaders()
remove method public void remove( )
setContentFromBytes method public void setContentFromBytes(Stream stream, String contentType, int encoding)
setContentFromText method public void setContentFromText(Stream stream, String contentType, int encoding)
MIMEHeader class
Properties:
HeaderName property public String getHeaderName( )
Methods:
addValText method public boolean addValText(String valueText)
getHeaderVal method public String getHeaderVal( )
getHeaderValAndParams method public String getHeaderValAndParams( )
getParamVal method public String getParamVal(String paramName)
remove method public void remove( )
setHeaderVal method public boolean setHeaderVal(String headerValue)
setHeaderValAndParams method public boolean setHeaderValAndParams(String headerParamValue)
setParamVal method public boolean setParamVal(String parameterName, String parameterValue)
Name class
Properties:
Abbreviated property public String getAbbreviated()
Addr821 property public String getAddr821()
Addr822Comment1 property public String getAddr822Comment1()
Addr822Comment2 property public String getAddr822Comment2()
Addr822Comment3 property public String getAddr822Comment3()
Addr822LocalPart property public String getAddr822LocalPart()
Addr822Phrase property public String getAddr822Phrase()
ADMD property public String getADMD()
Canonical property public String getCanonical()
Common property public String getCommon()
Country property public String getCountry()
Generation property public String getGeneration()
Given property public String getGiven()
Initials property public String getInitials()
IsHierarchical property public boolean isHierarchical()
Keyword property public String getKeyword()
Language property public String getLanguage()
Organization property public String getOrganization()
OrgUnit1 property public String getOrgUnit1()
OrgUnit2 property public String getOrgUnit2()
OrgUnit3 property public String getOrgUnit3()
OrgUnit4 property public String getOrgUnit4()
Parent property public Session getParent()
PRMD property public String getPRMD()
Surname property public String getSurname()
Newsletter class
Properties:
IsDoScore property public boolean isDoScore()
IsDoSubject property public boolean isDoSubject()
Parent property public Session getParent()
SubjectItemName property public String getSubjectItemName()
Methods:
formatDocument method public Document formatDocument(Database db, int index)
formatMsgWithDoclinks method public Document formatMsgWithDoclinks(Database db)
Outline class
Properties:
Alias property public String getAlias()
Comment property public String getComment()
Name property public String getName()
ParentDatabase property public Database getParentDatabase()
Methods:
addEntry method public void addEntry(OutlineEntry entry, OutlineEntry referenceEntry)
createEntry method public OutlineEntry createEntry(OutlineEntry fromEntry)
getChild method public OutlineEntry getChild(OutlineEntry entry)
getFirst method public OutlineEntry getFirst()
getLast method public OutlineEntry getLast()
getNext method public OutlineEntry getNext(OutlineEntry entry)
getNextSibling method public OutlineEntry getNextSibling(OutlineEntry entry)
getParent method public OutlineEntry getParent(OutlineEntry entry)
getPrev method public OutlineEntry getPrev(OutlineEntry entry)
getPrevSibling method public OutlineEntry getPrevSibling(OutlineEntry entry)
moveEntry method public void moveEntry(OutlineEntry entry, OutlineEntry referenceEntry)
removeEntry method public void removeEntry(OutlineEntry entry)
save method public void save()
OutlineEntry class
Properties:
Alias property public String getAlias()
Database property public Database getDatabase()
Document property public Document getDocument()
EntryClass property public int getEntryClass()
Formula property public String getFormula()
FrameText property public String getFrameText()
HasChildren property public boolean hasChildren()
HideFormula property public String getHideFormula()
ImagesText property public String getImagesText()
IsHidden property public boolean isHidden()
IsHiddenFromNotes property public boolean isHiddenFromNotes()
IsHiddenFromWeb property public boolean isHiddenFromWeb()
IsInThisDB property public boolean isInThisDB()
IsPrivate property public boolean isPrivate()
KeepSelectionFocus property public boolean getKeepSelectionFocus()
Label property public String getLabel()
Level property public int getLevel()
NamedElement property public String getNamedElement()
Parent property public Outline getParent()
Type property public int getType()
URL property public String getURL()
UseHideFormula property public boolean getUseHideFormula()
View property public View getView()
Methods:
setAction method public boolean setAction(String formula)
setNamedElement method public boolean setNamedElement(Database db, String elementName, int entryClass)
setNoteLink method public boolean setNoteLink(Database db)
setURL method public boolean setURL(String url)
Registration class
Properties:
AltOrgUnit property public java.util.Vector getAltOrgUnit()
AltOrgUnitLang property public java.util.Vector getAltOrgUnitLang()
CertifierIDFile property public String getCertifierIDFile()
CreateMailDb property public boolean getCreateMailDb()
Expiration property public DateTime getExpiration()
IDType property public int getIDType()
IsNorthAmerican property public boolean isNorthAmerican()
MinPasswordLength property public int getMinPasswordLength()
OrgUnit property public String getOrgUnit()
RegistrationLog property public String getRegistrationLog()
RegistrationServer property public String getRegistrationServer()
UpdateAddressBook property public boolean getUpdateAddressBook()
Methods:
addCertifierToAddressBook method public boolean addCertifierToAddressBook(String idfile)
addServerToAddressBook method public boolean addServerToAddressBook(String idfile, String server, String domain)
addUserProfile method public void addUserProfile(String username, String profile)
addUserToAddressBook method public boolean addUserToAddressBook(String idfile, String fullname, String lastn)
crossCertify method public boolean crossCertify(String idfile)
deleteIDOnServer method public void deleteIDOnServer(String username, boolean isserverid)
getIDFromServer method public void getIDFromServer(String username, String filepath, boolean isserverid)
getUserInfo method public void getUserInfo(String username, StringBuffer mailserver, StringBuffer mailfile, StringBuffer maildomain, StringBuffer mailsystem, Vector profile)
recertify method public boolean recertify(String idfile)
registerNewCertifier method public boolean registerNewCertifier(String org, String idfile, String certpw)
registerNewServer method public boolean registerNewServer(String server, String idfile, String domain, String pw)
registerNewUser method public boolean registerNewUser(String lastn, String idfile, String server)
switchToID method public String switchToID(String idfile, String userpw)
property
StoreIDInAddressBook property public boolean getStoreIDInAddressBook()
Replication class
Properties:
CutoffDate property public DateTime getCutoffDate()
CutoffInterval property public long getCutoffInterval()
IsAbstract property public boolean isAbstract()
IsCutoffDelete property public boolean isCutoffDelete()
IsDisabled property public boolean isDisabled()
IsIgnoreDeletes property public boolean isIgnoreDeletes()
IsIgnoreDestDeletes property public boolean isIgnoreDestDeletes()
Priority property public int getPriority()
Methods:
clearHistory method public int clearHistory()
reset method public int reset()
save method public int save()
RichTextItem class
Properties:
EmbeddedObjects property public java.util.Vector getEmbeddedObjects()
Methods:
addNewLine method public void addNewLine()
addPageBreak method public void addPageBreak()
addTab method public void addTab()
appendDocLink method public void appendDocLink(Document doc)
appendParagraphStyle method public void appendParagraphStyle(RichTextParagraphStyle pstyle)
appendRTItem method public void appendRTItem(RichTextItem item)
appendStyle method public void appendStyle(RichTextStyle style)
appendText method public void appendText(String text)
embedObject method public EmbeddedObject embedObject(int type, String class, String source, String name)
getEmbeddedObject method public EmbeddedObject getEmbeddedObject(String name)
getFormattedText method public String getFormattedText(boolean tabstrip, int linelen, int maxlen)
RichTextParagraphStyle class
Properties:
Alignment property public int getAlignment()
FirstLineLeftMargin property public int getFirstLineLeftMargin()
InterLineSpacing property public int getInterLineSpacing()
LeftMargin property public int getLeftMargin()
Pagination property public int getPagination()
RightMargin property public int getRightMargin()
SpacingAbove property public int getSpacingAbove()
SpacingBelow property public int getSpacingBelow()
Tabs property public java.util.Vector getTabs()
Methods:
clearAllTabs method public void clearAllTabs()
setTab method public void setTab(int position, int type)
setTabs method public void setTabs(int count, int startpos, int interval)
RichTextStyle class
Properties:
Bold property public int getBold()
Color property public int getColor()
Effects property public int getEffects()
Font property public int getFont()
FontSize property public int getFontSize()
Italic property public int getItalic()
Parent property public Session getParent()
PassThruHTML property public int getPassThruHTML()
StrikeThrough property public int getStrikeThrough()
Underline property public int getUnderline()
RichTextTab class
Properties:
Position property public int getPosition()
Type property public int getType()
Methods:
clear method public void clear()
Session class
Properties:
AddressBooks property public java.util.Vector getAddressBooks()
AgentContext property public AgentContext getAgentContext()
Bytes property public int getBytes()
Charset property public String getCharset()
CommonUserName property public String getCommonUserName()
International property public International getInternational()
IsConvertMIME property public boolean isConvertMIME()
IsOnServer property public boolean isOnServer()
IsValid property public boolean isValid()
NotesVersion property public String getNotesVersion()
OrgDirectoryPath property public String getOrgDirectoryPath()
Platform property public String getPlatform()
Position property public int getPosition()
ServerName property public String getServerName()
UserGroupNameList property public java.util.Vector getUserGroupNameList()
UserName property public String getUserName()
UserNameList property public java.util.Vector getUserNameList()
UserNameObject property public Name getUserNameObject()
Methods:
createDateRange method public DateRange createDateRange()
createDateTime method public DateTime createDateTime(String date)
createLog method public Log createLog(String name)
createName method public Name createName(String name)
createNewsletter method public Newsletter createNewsletter(DocumentCollection collection)
createRegistration method public Registration createRegistration()
createRichTextParagraphStyle method public RichTextParagraphStyle createRichTextParagraphStyle()
createRichTextStyle method public RichTextStyle createRichTextStyle()
createStream method public Stream createStream()
evaluate method public java.util.Vector evaluate(String formula)
freeTimeSearch method public java.util.Vector freeTimeSearch(DateRange window, int duration, Object names, boolean firstfit)
getDatabase method public Database getDatabase(String server, String db)
getDbDirectory method public DbDirectory getDbDirectory(String server)
getEnvironmentString method public String getEnvironmentString(String vname)
getEnvironmentValue method public Object getEnvironmentValue(String vname)
getSessionToken method public String getSessionToken()
getURLDatabase method public Database getURLDatabase()
resolve method public Base resolve(String url)
setEnvironmentVar method public void setEnvironmentVar(String vname, Object value)
Stream class
Properties:
IsEOS property public boolean isEOS()
IsReadOnly property public boolean isReadOnly()
Methods:
close method public void close()
getContents method public void getContents(java.io.OutputStream )
open method public boolean open(String pathname)
read method public byte[] read()
readText method public String readText()
setContents method public void setContents(java.io.InputStream )
truncate method public void truncate()
write method public int write(byte[] buffer)
writeText method public int writeText(String text)
View class
Properties:
Aliases property public java.util.Vector getAliases()
AllEntries property public ViewEntryCollection getAllEntries()
BackgroundColor property public int getBackgroundColor()
ColumnCount property public int getColumnCount()
ColumnNames property public java.util.Vector getColumnNames()
Columns property public java.util.Vector getColumns()
Created property public DateTime getCreated()
HeaderLines property public int getHeaderLines()
IsAutoUpdate property public boolean isAutoUpdate()
IsCalendar property public boolean isCalendar()
IsCategorized property public boolean isCategorized()
IsConflict property public boolean isConflict()
IsDefaultView property public boolean isDefaultView()
IsFolder property public boolean isFolder()
IsHierarchical property public boolean isHierarchical()
IsModified property public boolean isModified()
IsPrivate property public boolean isPrivate()
IsProtectReaders property public boolean isProtectReaders()
LastModified property public DateTime getLastModified()
Name property public String getName()
Parent property public Database getParent()
Readers property public java.util.Vector getReaders()
RowLines property public int getRowLines()
Spacing property public int getSpacing()
TopLevelEntryCount property public int getTopLevelEntryCount()
UniversalID property public String getUniversalID()
Methods:
clear method public void clear()
createViewNav method public ViewNavigator createViewNav()
createViewNavFrom method public ViewNavigator createViewNavFrom(Object entry)
createViewNavFromCategory method public ViewNavigator createViewNavFromCategory(String categoryName)
createViewNavFromChildren method public ViewNavigator createViewNavFromChildren(Object entry)
createViewNavFromDescendants method public ViewNavigator createViewNavFromDescendants(Object entry)
createViewNavMaxLevel method public ViewNavigator createViewNavMaxLevel(int level)
FTSearch method public int FTSearch(String query)
getAllDocumentsByKey method public DocumentCollection getAllDocumentsByKey(java.util.Vector keys)
getAllEntriesByKey method public ViewEntryCollection getAllEntriesByKey(java.util.Vector keys)
getChild method public Document getChild(Document doc)
getColumn method public ViewColumn getColumn(int columnNumber)
getDocumentByKey method public Document getDocumentByKey(java.util.Vector keys)
getEntryByKey method public ViewEntry getEntryByKey(java.util.Vector keys)
getFirstDocument method public Document getFirstDocument()
getLastDocument method public Document getLastDocument()
getNextDocument method public Document getNextDocument(Document doc)
getNextSibling method public Document getNextSibling(Document doc)
getNthDocument method public Document getNthDocument(int n)
getParentDocument method public Document getParentDocument(Document doc)
getPrevDocument method public Document getPrevDocument(Document doc)
getPrevSibling method public Document getPrevSibling(Document doc)
refresh method public void refresh()
remove method public void remove()
ViewColumn class
Properties:
Alignment property public int getAlignment()
DateFmt property public int getDateFmt()
FontColor property public int getFontColor()
FontFace property public String getFontFace()
FontPointSize property public int getFontPointSize()
FontStyle property public int getFontStyle()
Formula property public String getFormula()
HeaderAlignment property public int getHeaderAlignment()
IsAccentSensitiveSort property public boolean isAccentSensitiveSort()
IsCaseSensitiveSort property public boolean isCaseSensitiveSort()
IsCategory property public boolean isCategory()
IsField property public boolean isField()
IsFormula property public boolean isFormula()
IsHidden property public boolean isHidden()
IsHideDetail property public boolean isHideDetail()
IsIcon property public boolean isIcon()
IsResize property public boolean isResize()
IsResortAscending property public boolean isResortAscending()
IsResortDescending property public boolean isResortDescending()
IsResortToView property public boolean isResortToView()
IsResponse property public boolean isResponse()
IsSecondaryResort property public boolean isSecondaryResort()
IsSecondaryResortDescending property public boolean isSecondaryResortDescending()
IsShowTwistie property public boolean isShowTwistie()
IsSortDescending property public boolean isSortDescending()
IsSorted property public boolean isSorted()
ItemName property public String getItemName()
ListSep property public int getListSep()
NumberAttrib property public int getNumberAttrib()
NumberDigits property public int getNumberDigits()
NumberFormat property public int getNumberFormat()
Parent property public View getParent()
Position property public int getPosition()
TimeDateFmt property public int getTimeDateFmt()
TimeFmt property public int getTimeFmt()
TimeZoneFmt property public int getTimeZoneFmt()
Title property public String getTitle()
Width property public int getWidth()
ViewEntry class
Properties:
ChildCount property public int getChildCount()
ColumnIndentLevel property public int getColumnIndentLevel()
ColumnValues property public Vector getColumnValues()
DescendantCount property public int getDescendantCount()
Document property public Document getDocument()
FTSearchScore property public int getFTSearchScore()
IndentLevel property public int getIndentLevel()
IsCategory property public boolean isCategory()
IsConflict property public boolean isConflict()
IsDocument property public boolean isDocument()
IsTotal property public boolean isTotal()
IsValid property public boolean isValid()
NoteID property public String getNoteID()
Parent property public Object getParent()
SiblingCount property public int getSiblingCount()
UniversalID property public String getUniversalID()
Methods:
getPosition method public String getPosition(char separator)
ViewEntryCollection class
Properties:
Count property public int getCount()
Parent property public View getParent()
Query property public String getQuery()
Methods:
addEntry method public void addEntry(Object obj)
deleteEntry method public void deleteEntry(ViewEntry entry)
FTSearch method public void FTSearch(String query)
getEntry method public ViewEntry getEntry(Object entry)
getFirstEntry method public ViewEntry getFirstEntry()
getLastEntry method public ViewEntry getLastEntry()
getNextEntry method public ViewEntry getNextEntry()
getNthEntry method public ViewEntry getNthEntry(int n)
getPrevEntry method public ViewEntry getPrevEntry()
putAllInFolder method public void putAllInFolder(String folderName)
removeAll method public void removeAll(boolean force)
removeAllFromFolder method public void removeAllFromFolder(String folderName)
stampAll method public void stampAll(String itemName, Object value)
updateAll method public void updateAll()
ViewNavigator class
Properties:
CacheSize property public int getCacheSize()
Count property public int getCount()
MaxLevel property public int getMaxLevel()
ParentView property public View getParentView()
Methods:
getChild method public ViewEntry getChild()
getCurrent method public ViewEntry getCurrent()
getFirst method public ViewEntry getFirst()
getFirstDocument method public ViewEntry getFirstDocument()
getLast method public ViewEntry getLast()
getLastDocument method public ViewEntry getLastDocument()
getNext method public ViewEntry getNext()
getNextCategory method public ViewEntry getNextCategory()
getNextDocument method public ViewEntry getNextDocument()
getNextSibling method public ViewEntry getNextSibling()
getNth method public ViewEntry getNth(int n)
getParent method public ViewEntry getParent()
getPos method public ViewEntry getPos(String pos, char separator)
getPrev method public ViewEntry getPrev()
getPrevCategory method public ViewEntry getPrevCategory()
getPrevDocument method public ViewEntry getPrevDocument()
getPrevSibling method public ViewEntry getPrevSibling()
gotoChild method public boolean gotoChild()
gotoEntry method public boolean gotoEntry(Object entry)
gotoFirst method public boolean gotoFirst()
gotoFirstDocument method public boolean gotoFirstDocument()
gotoLast method public boolean gotoLast()
gotoLastDocument method public boolean gotoLastDocument()
gotoNext method public boolean gotoNext()
gotoNextCategory method public boolean gotoNextCategory()
gotoNextDocument method public boolean gotoNextDocument()
gotoNextSibling method public boolean gotoNextSibling()
gotoParent method public boolean gotoParent()
gotoPos method public boolean gotoPos(String pos, char separator)
gotoPrev method public boolean gotoPrev()
gotoPrevCategory method public boolean gotoPrevCategory()
gotoPrevDocument method public boolean gotoPrevDocument()
gotoPrevSibling method public boolean gotoPrevSibling()
Supporting components
Base
NotesAppletContext
NotesError and NotesException
NotesFactory
NotesThread
XSLTResultTarget
The following methods appear in numerous classes and are documented here rather than in each class:
GetInputSource
GetInputStream
getReader
getURL
parseXML
recycle
toString
transformXML
Java constants
ACL level
ACL maximum roles
ACL type
align
color
database directory
database replication priority
effects
embedded object type
encoding
event
font
full-text serarch
ID type
item type
outline entry class
outline entry type
paginate
ruler
search
severity
spacing
stream read
style no change
style no or yes
tab
target
trigger
view column attribute
view column date format
view column font
view column number format
view column separator
view column time date format
view column time format
view column time zone format
view entry type
Use your current version of Help-Database for actual and correct references.
| Home | Notes links | Lotusscript | Domino links | News | SiteMap |