com.hp.ucmdb.api.topology
Interface QueryFolder


public interface QueryFolder

Represents a folder in the queries folder structure.

Since:
UCMDB 9.0

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

Method Detail

getName

java.lang.String getName()
The name of the folder.


getChildFolders

java.util.Collection<QueryFolder> getChildFolders()
Returns an unmodifiable collection of the immediate child folders of this folder.


getChildQueries

java.util.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(java.lang.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.


Documentation Feedback
Copyright 2010 Hewlett-Packard Development Company, L.P.