com.hcl.domino.design

Interface DbDesignCatalog

public interface DbDesignCatalog

Access to database design information on the server

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DbDesignCatalog.DatabaseDesignAnalysis Result of the template inheritance scan
static interface	DbDesignCatalog.DesignRefreshBreakHandler

Method Summary

Modifier and Type	Method and Description
List<DatabaseData>	findAllDatabaseInheritingTemplate(String server, String templateName) Scans the server data directory to find all databases that inherit their design from the specified template
DbDesign	readDatabaseDesign(Database db)
void	refreshDesign(Database db, String serverWithTemplate) Refresh the design of a database
void	refreshDesign(Database db, String serverWithTemplate, boolean force, boolean errIfTemplateNotFound, DbDesignCatalog.DesignRefreshBreakHandler breakHandler) Refresh the design of a database with advanced options
DbDesignCatalog.DatabaseDesignAnalysis	scanTemplateInheritanceOnServer(String server, String directory) Fast scan of the server directory to get information about template inheritance

Method Detail

findAllDatabaseInheritingTemplate

List<DatabaseData> findAllDatabaseInheritingTemplate(String server,
                                                     String templateName)

Scans the server data directory to find all databases that inherit their design from the specified template

Parameters:

server - server

templateName - template name

Returns:

list of databases

scanTemplateInheritanceOnServer

DbDesignCatalog.DatabaseDesignAnalysis scanTemplateInheritanceOnServer(String server,
                                                                       String directory)

Fast scan of the server directory to get information about template inheritance

Parameters:

server - server to scan

directory - restrict scan to a subdirectory or use empty string to scan the whole server

Returns:

scan result

refreshDesign

void refreshDesign(Database db,
                   String serverWithTemplate)

Refresh the design of a database

Parameters:

db - database

serverWithTemplate - server containing the template

refreshDesign

void refreshDesign(Database db,
                   String serverWithTemplate,
                   boolean force,
                   boolean errIfTemplateNotFound,
                   DbDesignCatalog.DesignRefreshBreakHandler breakHandler)

Refresh the design of a database with advanced options

Parameters:

db - database

serverWithTemplate - server containing the template

force - true to force operation, even if destination "up to date"

errIfTemplateNotFound - true to return an error if the template is not found

breakHandler - optional break handler to abort the operation (e.g. for graphical user interfaces) or null

readDatabaseDesign

DbDesign readDatabaseDesign(Database db)