com.hp.ucmdb.api.topology

Interface QueryFolder

public interface QueryFolder

Represents a folder in the queries folder structure.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
Query	findQueryByName(String name) Convenience function that recieves a query name and returns the query with that name that is a descendant of this folder.
Collection<QueryFolder>	getChildFolders() Returns an unmodifiable collection of the immediate child folders of this folder.
Collection<Query>	getChildQueries() Returns an unmodifiable collection of the queries in this folder.
String	getFolderId() Returns a unique folder ID
String	getName() The name of the folder.
void	visitChildren(QueryTreeVisitor visitor) Visits the query folder's children visitor.

Method Detail

getName

String getName()

The name of the folder.

getChildFolders

Collection<QueryFolder> getChildFolders()

Returns an unmodifiable collection of the immediate child folders of this folder.

getChildQueries

Collection<Query> getChildQueries()

Returns an unmodifiable collection of the queries in this folder.

visitChildren

void visitChildren(QueryTreeVisitor visitor)

Visits the query folder's children visitor. Can use a client-based visitor.

This method can receive client implementations of QueryTreeVisitor

This method visits the only current folder. If traversing is needed, it is the client's responsability to call the visit methods for the child folders, if they exist.

Parameters:

visitor - a client implementation of the QueryTreeVisitor interface.

findQueryByName

Query findQueryByName(String name)

Convenience function that recieves a query name and returns the query with that name that is a descendant of this folder.

Parameters:

name - the name to search.

Returns:

the query or null if query not found.

getFolderId

String getFolderId()

Returns a unique folder ID

Returns: