com.hp.ucmdb.api.view

Interface ViewFolder

public interface ViewFolder

Represents a folder in views folder structure.

Since:

8.0

Method Summary

Modifier and Type	Method and Description
View	findViewByName(String name) Convenience function that gets a view name and returns the view with that name that is a descendant of this folder.
Collection<ViewFolder>	getChildFolders() Returns an unmodifiable collection of immediate child folders of this folder.
Collection<View>	getChildViews() Returns an unmodifiable collection of views residing in this folder.
String	getFolderId() Returns a unique folder ID
String	getName() The name of the folder.
void	visitChildren(ViewTreeVisitor visitor) Visits the view folder's children using a visitor.

Method Detail

getName

String getName()

The name of the folder.

getChildFolders

Collection<ViewFolder> getChildFolders()

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

getChildViews

Collection<View> getChildViews()

Returns an unmodifiable collection of views residing in this folder.

visitChildren

void visitChildren(ViewTreeVisitor visitor)

Visits the view folder's children using a visitor. The visitor can be client-based.

This method can receive client implementations of ViewTreeVisitor

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

Parameters:

visitor - a client implementation of the ViewTreeVisitor interface.

findViewByName

View findViewByName(String name)

Convenience function that gets a view name and returns the view 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: