Modifier and Type | Class and Description |
---|---|
static class |
NSFFolder.FolderChanges |
Modifier and Type | Method and Description |
---|---|
void |
add(int noteId) |
void |
add(NSFNote note) |
void |
addAll(NSFNoteIDCollection notes) |
void |
clear() |
boolean |
contains(int noteId) |
boolean |
contains(NSFNote note) |
NSFView |
copy(String name) |
void |
delete()
Deletes the folder.
|
NSFFolder.FolderChanges |
getChanges(NSFDateTime since) |
NSFNoteIDCollection |
getContents()
Returns a
NSFNoteIDCollection of the notes contained within this folder. |
int |
getNoteCount()
Returns the number of notes contained in this folder.
|
NSFView |
getParent() |
void |
move(NSFView parent) |
void |
remove(int noteId) |
void |
remove(NSFNote note) |
void |
removeAll(NSFNoteIDCollection notes) |
void |
rename(String name) |
int |
size()
Returns the number of entries in this folder's index.
|
public NSFFolder(NSFView parent)
public NSFNoteIDCollection getContents() throws DominoException
NSFNoteIDCollection
of the notes contained within this folder.NSFNoteIDCollection
of the folder contentsDominoException
- if there is a lower-level-API problem retrieving the contentspublic int size() throws DominoException
To retrieve the count of document specifically, use getNoteCount()
.
DominoException
- if there is a lower-level-API problem retrieving the entry countpublic int getNoteCount() throws DominoException
This is equivalent to calling getContents()
and calling
NSFNoteIDCollection.size()
on that.
DominoException
- if there is a lower-level-API problem retrieving the entry countpublic void add(int noteId) throws DominoException
DominoException
public void add(NSFNote note) throws DominoException
DominoException
- if there is a lower-level-API problem adding the IDIllegalArgumentException
- if note
is nullpublic void addAll(NSFNoteIDCollection notes) throws DominoException
DominoException
- if there is a lower-level-API problem adding the IDsIllegalArgumentException
- if notes
is nullpublic void remove(int noteId) throws DominoException
DominoException
- if there is a lower-level-API problem removing the IDpublic void remove(NSFNote note) throws DominoException
DominoException
- if there is a lower-level-API problem removing the IDIllegalArgumentException
- if note
is nullpublic void removeAll(NSFNoteIDCollection notes) throws DominoException
DominoException
- if there is a lower-level-API problem removing the IDsIllegalArgumentException
- if notes
is nullpublic void clear() throws DominoException
DominoException
public boolean contains(int noteId) throws DominoException
DominoException
public boolean contains(NSFNote note) throws DominoException
DominoException
- if there is a lower-level-API problem checking the folder contentsIllegalArgumentException
- if note
is nullpublic void move(NSFView parent) throws DominoException
DominoException
- if there is a lower-level-API problem moving the folderIllegalArgumentException
- if parent
is null or not a folderpublic void rename(String name) throws DominoException
DominoException
- if there is a lower-level-API problem renaming the viewIllegalArgumentException
- if name
is null or emptypublic NSFView copy(String name) throws DominoException
DominoException
- if there is a lower-level-API problem copying the viewIllegalArgumentException
- if name
is null or emptypublic NSFFolder.FolderChanges getChanges(NSFDateTime since) throws DominoException
since
- the starting time for the change list, or null
to retrieve
all historical changesDominoException
- if there is a lower-level-API problem retrieving the changespublic void delete() throws DominoException
DominoException
- if there is a lower-level-API problem deleting the folderpublic NSFView getParent()
Copyright © 2014–2018. All rights reserved.