DbDesign (HCL Domino API 1.0.27-SNAPSHOT API)

```
public interface DbDesign
```
Provides access to a database's design elements, allowing querying, selection, and creation.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DbDesign.FolderOrView`
`static class`	`DbDesign.FormOrSubform` Deprecated.
`static interface`	`DbDesign.SignCallback` Callback interface to get notified about progress when signing

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`DesignAgent`	`createAgent(String agentName)` Creates a new, unsaved agent design element.
`Folder`	`createFolder(String folderName)` Creates a new, unsaved folder design element.
`Form`	`createForm(String formName)` Creates a new, unsaved form design element.
`Subform`	`createSubform(String subformName)` Creates a new, unsaved subform design element.
`View`	`createView(String viewName)` Creates a new, unsaved view design element.
`Optional<DesignAgent>`	`getAgent(String name)` Retrieves the named agent.
`Stream<DesignAgent>`	`getAgents()` Retrieves all agents in the database.
`DbProperties`	`getDatabaseProperties()` Retrieves the database properties.
`<T extends DesignElement> Optional<T>`	`getDesignElementByName(Class<T> type, String name)` Retrieves a single design element in the database of the provided type matching the provided title.
`<T extends DesignElement> Stream<T>`	`getDesignElements(Class<T> type)` Retrieves all design elements in the database of the provided type.
`<T extends DesignElement> Stream<T>`	`getDesignElementsByName(Class<T> type, String name)` Retrieves all design elements in the database of the provided type matching the provided title.
`Optional<FileResource>`	`getFileResource(String name)` Retrieves the named file resource.
`Stream<FileResource>`	`getFileResources()` Retrieves all file resource design elements in the database.
`<T extends GenericFolderOrView> Optional<T>`	`getFolderOrView(DbDesign.FolderOrView folderViewType, String name)` Retrieves the named folder or view.
`<T extends GenericFolderOrView> Stream<T>`	`getFoldersOrViews(DbDesign.FolderOrView folderViewType)` Retrieves all folders or views in the database.
`Optional<Form>`	`getForm(String name)` Retrieves the named form.
`default GenericFormOrSubform<?>`	`getFormOrSubform(DbDesign.FormOrSubform formSubformType, String name)` Deprecated. use `getForm(String)` or `getSubform(String)`
`Stream<Form>`	`getForms()` Retrieves all forms in the database.
`Optional<ImageResource>`	`getImageResource(String name)` Retrieves the named image resource.
`Stream<ImageResource>`	`getImageResources()` Retrieves all image resources design elements in the database.
`Stream<ScriptLibrary>`	`getScriptLibraries()` Retrieves all script library design elements in the database.
`Optional<ScriptLibrary>`	`getScriptLibrary(String name)` Retrieves the named script library.
`Optional<Subform>`	`getSubform(String name)` Retrieves the named subform.
`Stream<Subform>`	`getSubforms()` Retrieves all subforms in the database.
`<T extends DesignElement> Stream<T>`	`queryDesignElements(Class<T> type, String formula)` Queries all design elements in the database by the provided formula and restricted to the provided type.
`Stream<DesignElement>`	`queryDesignElements(String formula)` Queries all design elements in the database by the provided formula.
`void`	`signAll(Set<DocumentClass> docClass, UserId id, DbDesign.SignCallback callback)` Signs all design documents of the specified types

- Method Detail
  - queryDesignElements
```
Stream<DesignElement> queryDesignElements(String formula)
```
    Queries all design elements in the database by the provided formula.
    
    Parameters:
    
    formula - the formula query to execute
    
    Returns:
    
    a Stream of matching DesignElements
  - queryDesignElements
```
<T extends DesignElement> Stream<T> queryDesignElements(Class<T> type,
                                                        String formula)
```
    Queries all design elements in the database by the provided formula and restricted to the provided type.
    
    Type Parameters:
    
    T - the type of design element to query
    
    Parameters:
    
    type - a Class object representing <T>
    
    formula - the formula query to execute
    
    Returns:
    
    a Stream of matching DesignElements
  - getDesignElements
```
<T extends DesignElement> Stream<T> getDesignElements(Class<T> type)
```
    Retrieves all design elements in the database of the provided type.
    
    Type Parameters:
    
    T - the type of design element to retrieve
    
    Parameters:
    
    type - a Class object representing <T>
    
    Returns:
    
    a Stream of matching DesignElements
  - getDesignElementsByName
```
<T extends DesignElement> Stream<T> getDesignElementsByName(Class<T> type,
                                                            String name)
```
    Retrieves all design elements in the database of the provided type matching the provided title.
    
    Type Parameters:
    
    T - the type of design element to retrieve
    
    Parameters:
    
    type - a Class object representing <T>
    
    name - the element name to restrict to
    
    Returns:
    
    a Stream of matching DesignElements
  - getDesignElementByName
```
<T extends DesignElement> Optional<T> getDesignElementByName(Class<T> type,
                                                             String name)
```
    Retrieves a single design element in the database of the provided type matching the provided title.
    
    Type Parameters:
    
    T - the type of design element to retrieve
    
    Parameters:
    
    type - a Class object representing <T>
    
    name - the element name to restrict to
    
    Returns:
    
    an Optional describing the requested design element, or an empty Optional if no such element exists
  - createView
```
View createView(String viewName)
```
    Creates a new, unsaved view design element.
    
    Parameters:
    
    viewName - the name of the view to create
    
    Returns:
    
    the newly-created in-memory View
  - createFolder
```
Folder createFolder(String folderName)
```
    Creates a new, unsaved folder design element.
    
    Parameters:
    
    folderName - the name of the folder to create
    
    Returns:
    
    the newly-created in-memory Folder
  - getFolderOrView
```
<T extends GenericFolderOrView> Optional<T> getFolderOrView(DbDesign.FolderOrView folderViewType,
                                                            String name)
```
    Retrieves the named folder or view.
    
    Type Parameters:
    
    T - the expected type of returned element
    
    Parameters:
    
    folderViewType - a DbDesign.FolderOrView value representing the type of element to retrieve
    
    name - the element name to restrict to
    
    Returns:
    
    an Optional describing the Folder or View, or an empty Optional if no such element exists
  - getFoldersOrViews
```
<T extends GenericFolderOrView> Stream<T> getFoldersOrViews(DbDesign.FolderOrView folderViewType)
```
    Retrieves all folders or views in the database.
    
    Type Parameters:
    
    T - the expected type of returned elements
    
    Parameters:
    
    folderViewType - a DbDesign.FolderOrView value representing the type of elements to retrieve
    
    Returns:
    
    a Stream of Folders and/or Views
  - createForm
```
Form createForm(String formName)
```
    Creates a new, unsaved form design element.
    
    Parameters:
    
    formName - the name of the form to create
    
    Returns:
    
    the newly-created in-memory Form
  - getForm
```
Optional<Form> getForm(String name)
```
    Retrieves the named form.
    
    Parameters:
    
    name - the element name to restrict to
    
    Returns:
    
    an Optional describing the Form, or an empty Optional if no such element exists
  - getForms
```
Stream<Form> getForms()
```
    Retrieves all forms in the database.
    
    Returns:
    
    a Stream of Forms
  - createSubform
```
Subform createSubform(String subformName)
```
    Creates a new, unsaved subform design element.
    
    Parameters:
    
    subformName - the name of the subform to create
    
    Returns:
    
    the newly-created in-memory Subform
  - getSubform
```
Optional<Subform> getSubform(String name)
```
    Retrieves the named subform.
    
    Parameters:
    
    name - the element name to restrict to
    
    Returns:
    
    an Optional describing the Subform, or an empty Optional if no such element exists
  - getSubforms
```
Stream<Subform> getSubforms()
```
    Retrieves all subforms in the database.
    
    Returns:
    
    a Stream of Subforms
  - getFileResource
```
Optional<FileResource> getFileResource(String name)
```
    Retrieves the named file resource.
    Note: this method uses the value of the "$TITLE" field of the design element, not the "$FileNames" of the file resource. These may diverge, such as when a file resource has an alias assigned to it.
    
    Parameters:
    
    name - the name of the resource to restrict to
    
    Returns:
    
    an Optional describing the FileResource, or an empty one if no such element exists
    
    Since:
    
    1.0.24
  - getFileResources
```
Stream<FileResource> getFileResources()
```
    Retrieves all file resource design elements in the database.
    
    Returns:
    
    a Stream of FileResources
    
    Since:
    
    1.0.24
  - getScriptLibrary
```
Optional<ScriptLibrary> getScriptLibrary(String name)
```
    Retrieves the named script library. This library will be of a specific subtype based on its language.
    
    Parameters:
    
    name - the name of the library to restrict to
    
    Returns:
    
    an Optional describing the ScriptLibrary, or an empty one if no such element exists
    
    Since:
    
    1.0.24
    
    See Also:
    
    JavaLibrary, JavaScriptLibrary, ServerJavaScriptLibrary, LotusScriptLibrary
  - getScriptLibraries
```
Stream<ScriptLibrary> getScriptLibraries()
```
    Retrieves all script library design elements in the database. These libraries will be of a specific subtype based on their language.
    
    Returns:
    
    a Stream of ScriptLibrary subclass elements
    
    Since:
    
    1.0.24
    
    See Also:
    
    JavaLibrary, JavaScriptLibrary, ServerJavaScriptLibrary, LotusScriptLibrary
  - getImageResource
```
Optional<ImageResource> getImageResource(String name)
```
    Retrieves the named image resource.
    
    Parameters:
    
    name - the name of the resource to restrict to
    
    Returns:
    
    an Optional describing the ImageResource, or an empty one if no such element exists
    
    Since:
    
    1.0.24
  - getImageResources
```
Stream<ImageResource> getImageResources()
```
    Retrieves all image resources design elements in the database.
    
    Returns:
    
    a Stream of ImageResource elements
    
    Since:
    
    1.0.24
  - getFormOrSubform
```
@Deprecated
default GenericFormOrSubform<?> getFormOrSubform(DbDesign.FormOrSubform formSubformType,
                                                             String name)
```
    Deprecated. use getForm(String) or getSubform(String)
    
    Parameters:
    
    formSubformType - the type of element to select
    
    name - the name of the design element to select
    
    Returns:
    
    the form or subform element, or null if no element exists
  - createAgent
```
DesignAgent createAgent(String agentName)
```
    Creates a new, unsaved agent design element.
    
    Parameters:
    
    agentName - the name of the agent to create
    
    Returns:
    
    the newly-created in-memory DesignAgent
  - getAgent
```
Optional<DesignAgent> getAgent(String name)
```
    Retrieves the named agent.
    
    Parameters:
    
    name - the element name to restrict to
    
    Returns:
    
    an Optional describing the DesignAgent, or an empty Optional if no such element exists
  - getAgents
```
Stream<DesignAgent> getAgents()
```
    Retrieves all agents in the database.
    
    Returns:
    
    a Stream of DesignAgents
  - getDatabaseProperties
```
DbProperties getDatabaseProperties()
```
    Retrieves the database properties. This is, for implementation reasons, also known as the icon note.
    
    Returns:
    
    the DB properties element for this database
  - signAll
```
void signAll(Set<DocumentClass> docClass,
             UserId id,
             DbDesign.SignCallback callback)
```
    Signs all design documents of the specified types
    
    Parameters:
    
    docClass - doc classes to sign
    
    id - id to sign or null for active Notes ID
    
    callback - optional sign callback to control with document to sign

Interface DbDesign

Nested Class Summary

Method Summary

Method Detail

queryDesignElements

queryDesignElements

getDesignElements

getDesignElementsByName

getDesignElementByName

createView

createFolder

getFolderOrView

getFoldersOrViews

createForm

getForm

getForms

createSubform

getSubform

getSubforms

getFileResource

getFileResources

getScriptLibrary

getScriptLibraries

getImageResource

getImageResources

getFormOrSubform

createAgent

getAgent

getAgents

getDatabaseProperties

signAll