public class NSFDatabaseDesign extends Object
NSFDatabase
with convenience methods to access
design elements.Constructor and Description |
---|
NSFDatabaseDesign(NSFDatabase database) |
Modifier and Type | Method and Description |
---|---|
int |
findDesignNote(short noteClass,
String pattern,
String name,
boolean partialMatch)
Queries the design collection for a single design note.
|
List<Integer> |
findDesignNotes(short noteClass,
String pattern)
Queries the design collection of the database for design notes.
|
NSFFileResource |
getFileResource(String name)
Returns the named file resource.
|
List<NSFFileResource> |
getFileResources()
Returns a
List of the file resources in the database. |
NSFForm |
getForm(String formName)
Returns the
NSFForm matching the provided name or alias. |
List<NSFForm> |
getForms()
Returns a
List of the forms in the database. |
List<NSFOutline> |
getOutlines()
Returns a
List of the outlines in the database. |
NSFFormField |
getSharedField(String sharedFieldName) |
NSFForm |
getSubform(String subformName)
Returns the
NSFForm matching the provided name or alias, if it is a subform. |
public NSFDatabaseDesign(NSFDatabase database)
public List<NSFOutline> getOutlines() throws DominoException
List
of the outlines in the database.
The caller is responsible for freeing the returned objects.
List
of NSFOutline
objectsDominoException
- if there is a lower-level-API problem retrieving the outlinespublic List<NSFForm> getForms() throws DominoException
List
of the forms in the database.
The caller is responsible for freeing the returned objects.
List
of NSFForm
objectsDominoException
- if there is a lower-level-API problem retrieving the formspublic List<NSFFileResource> getFileResources() throws DominoException
List
of the file resources in the database.
The caller is responsible for freeing the returned objects.
List
of NSFFileResource
objectsDominoException
- if there is a lower-level-API problem retrieving the file resourcespublic NSFFileResource getFileResource(String name) throws DominoException
name
- the name or alias of the file resource to retrieveFileResource
object, or null
if no file resource matched the nameDominoException
- if there is a lower-level-API problem retrieving the file resourcepublic NSFForm getForm(String formName) throws DominoException
NSFForm
matching the provided name or alias.formName
- the name to match against the form name or aliasnull
if not foundDominoException
- if there is a lower-level-API problem finding the formpublic NSFForm getSubform(String subformName) throws DominoException
NSFForm
matching the provided name or alias, if it is a subform.formName
- the name to match against the subform name or aliasnull
if not found or is not a subformDominoException
- if there is a lower-level-API problem finding the formpublic NSFFormField getSharedField(String sharedFieldName) throws DominoException
DominoException
public int findDesignNote(short noteClass, String pattern, String name, boolean partialMatch) throws DominoException
noteClass
- the class of note to query (see NOTE_CLASS_*
in DominoAPI
)pattern
- the note flag pattern to query (see DFLAGPAT_*
in DominoAPI
)name
- the name or alias of the design notepartialMatch
- whether partial matches are allowed0
if the note was not foundDominoException
- if there is a lower-level-API problem querying the design collectionpublic List<Integer> findDesignNotes(short noteClass, String pattern) throws DominoException
noteClass
- the class of note to query (see NOTE_CLASS_*
in DominoAPI
)pattern
- the note flag pattern to query (see DFLAGPAT_*
in DominoAPI
)List
of note IDs matching the queryDominoException
- if there is a lower-level-API problem querying the design collectionCopyright © 2014–2018. All rights reserved.