Accessing view properties using Java™
The following methods access the View properties.
- getAliases returns
a vector of String values containing the aliases of the view or folder,
or null if there are no aliases; setAliases (with a
Vector parameter) sets the aliases from a vector of String values.
The method setAliases (with
a String parameter) sets the aliases from a single String value.
- getAllEntries returns a ViewEntryCollection object representing all the document entries in the view or folder.
- getBackgroundColor returns
an int value containing a color code for the background color of the
view or folder; setBackgroundColor sets
the background color.
- getColumnCount returns an int value containing the number of columns in the view or folder.
- getColumnNames returns a vector of String values containing the names of the columns in the view or folder.
- getColumns returns a vector of ViewColumn objects representing the columns in the view or folder.
- getCreated returns a DateTime object representing the creation date and time of the view or folder.
- getEntryCount returns
an int value containing the number of documents in a view.
- getHeaderLines returns an int value containing the number of lines in the header of the view or folder.
- getHTTPURL returns
a String value containing the HTTP URL of a view.
- isAutoUpdate returns true if the front-end view is updated each time a change occurs in the back-end and false if the updates occur when the program ends; setAutoUpdate causes updates to occur automatically or not.
- isCalendar returns true if this is a calendar view.
- isCategorized returns true if the view or folder is categorized.
- isConflict returns true if a calendar view is enabled for conflict checking.
- isDefaultView returns
true if this is the default view; setDefaultView set
this as the default view.
- isFolder returns true if this is a folder.
- isHierarchical returns true if a view or folder shows response documents in a hierarchy.
- isModified returns true if the view is modified.
- isProhibitDesignRefresh returns
true if a design refresh or replace cannot overwrite the view; setProhibitDesignRefresh allows
the view to be overwritten or not.
- isProtectReaders returns true if the $Readers field is protected from being overwritten during replication; setProtectReaders protects the $Readers field or not.
- getLastModified returns a DateTime object representing the modification date and time of the view or folder.
- getName returns
a String value containing the name of the view or folder; setName sets the name.
- getNotesURL returns
a String value containing the Notes® URL
of a view.
- getParent returns a Database object representing the database containing the view or folder.
- getReaders returns a vector of String values containing the contents of the $Readers field for the view or folder, or null; setReaders sets the value of the $Readers field.
- getRowLines returns an int value containing the number of lines in each row.
- getSelectionFormula returns
a String value containing the view's selection formula setSelectionFormula sets
the selection formula.
- getSpacing returns
an int value containing a code for the spacing between rows; setSpacing sets the
spacing.
- getTopLevelEntryCount returns an int value containing the number of top-level entries in a view.
- getUniversalID returns a String value containing the universal ID of the view or folder.
- getViewInheritedName returns
a String value containing the name of the view whose design this view
inherits.