public class NSFView extends NSFDesignNoteBase
Constructor and Description |
---|
NSFView(NSFDatabase parent,
int noteId) |
Modifier and Type | Method and Description |
---|---|
NSFFolder |
asFolder()
If the current object is a folder, returns an
NSFFolder view of it with
specialized operations. |
protected void |
doFree()
This method is called when the final reference to this object is freed.
|
NSFViewEntryCollection |
getAllEntries() |
NSFViewEntryCollection |
getAllEntriesByKey(Object key,
boolean exactMatch) |
COLLECTIONDATA |
getCollectionData() |
short |
getCollectionHandle() |
int |
getDocCount() |
NSFViewEntryCollection |
getEntries(int start,
int count)
|
int |
getEntryCount() |
int |
getEntrySize() |
NSFNote |
getFirstNoteByKey(Object key,
boolean exactMatch)
Returns the first note in the view by the provided key with the current collation, or
null if the key does not match any entries. |
NSFViewFormat |
getFormat()
Retrieves the visual and data format of the view, as a
NSFViewFormat object. |
NSFFormula |
getSelectionFormula()
Retrieves the compiled selection formula of the view.
|
boolean |
isFolder() |
boolean |
isRefValid()
Checks whether the object's inner reference is valid.
|
void |
refresh()
Attempts to update the view to match changes to the database (
NIFUpdateCollection ). |
_getInternalNote, getAliases, getFlagsString, getNote, getNoteID, getParent, getProgrammaticTitle, getTitle
_checkRefValidity, addChild, addChildStruct, debugPrintChildHierarchy, finalize, free, free, free, getAPI, getChildObjectCount, getChildObjectCount, getChildStructCount, isFreed, isTraceCreation, removeChild, removeChildStruct, removeFromParent, retain, setNeedsFree, setTraceCreation, toString
public NSFView(NSFDatabase parent, int noteId) throws DominoException
DominoException
public short getCollectionHandle() throws DominoException
DominoException
public boolean isFolder() throws DominoException
DominoException
public int getDocCount() throws DominoException
DominoException
public int getEntrySize() throws DominoException
DominoException
public int getEntryCount() throws DominoException
DominoException
public NSFViewEntryCollection getAllEntries() throws DominoException
DominoException
public NSFViewEntryCollection getEntries(int start, int count) throws DominoException
NSFViewEntryCollection
for the specified entry count
, starting at
the offset start
.
This method deals only with the first tumbler level.
start
- the 0-based index of the first entry to retrievecount
- the number of entries to retrieveNIFViewEntryCollection
of the specified entriesDominoException
- if there is a problem retrieving the entriespublic NSFViewEntryCollection getAllEntriesByKey(Object key, boolean exactMatch) throws DominoException
DominoException
public NSFNote getFirstNoteByKey(Object key, boolean exactMatch) throws DominoException
null
if the key does not match any entries.key
- an object, Collection
, or array to use as a key.exactMatch
- whether the lookup should match the key exactly or allow for partial matchesnull
if the key
does not match any entries.DominoException
public NSFFolder asFolder() throws DominoException
NSFFolder
view of it with
specialized operations. Otherwise, returns null
NSFFolder
view of this folder, or null
if it is
not a folderDominoException
- if there is a lower-level-API problem retrieving the folderprotected void doFree()
NSFBase
Implemented classes are expected to release any memory or network resources they have open. They are also expected to write this defensively, allowing the method to be called multiple times on the same object without problem.
doFree
in class NSFDesignNoteBase
public COLLECTIONDATA getCollectionData() throws DominoException
DominoException
public void refresh() throws DominoException
NIFUpdateCollection
).
Calling this will possibly render open positions or collections invalid.DominoException
public NSFFormula getSelectionFormula() throws DominoException
DominoException
- if there is an API problem reading the selection formulaIllegalStateException
- if the view note's DominoAPI.VIEW_FORMULA_ITEM
item is invalidpublic NSFViewFormat getFormat() throws DominoException
NSFViewFormat
object.null
if the DominoAPI.VIEW_VIEW_FORMAT_ITEM
item does not existDominoException
- if there is an API problem reading the view formatIllegalStateException
- if the view note's DominoAPI.VIEW_VIEW_FORMAT_ITEM
item is invalidpublic boolean isRefValid()
NSFBase
isRefValid
in class NSFDesignNoteBase
Copyright © 2014–2018. All rights reserved.