com.hp.ucmdb.api.view

Interface ViewFactory

public interface ViewFactory

The factory for creating viewing system related structures.

Since:

8.0

Method Summary

Modifier and Type	Method and Description
CmViewDefinition	createCmViewDefinition() Creates a new object that holds CM properties for a view
View	createNewView(String viewName) Deprecated. will be removed soon, use createViewWithFoldingDefinition(String).
ViewExecutionOptions	createOptions() Creates an execution options object that may be used to change the view execution behavior.
PerspectiveBasedViewReferenceDefinition	createPerspectiveBasedViewReferenceDefinition(String viewName) Creates a perspective based view with the given name.
RuleBasedViewDefinition	createRuleBasedViewDefinition(String viewName, String queryName)
SingleViewReferenceDefinition	createSingleViewReferenceDefinition(String viewName, String queryName, String baseViewName)
ViewValidationBulk	createValidationBulk()
View	createView(String viewName) Creates a client representation of a view stored in the UCMDB.
View	createView(ViewDefinition viewDefinition) Creates a client representation of a view stored in the UCMDB.
ViewManagementListenerFilter	createViewManagementListenerFilter() Creates a new filter for view management listener
ViewResultVersion	createViewResultVersion(String viewResultVersionAsString)
ViewVersion	createViewVersion(String viewVersionAsString)
ViewWithFoldingDefinition	createViewWithFoldingDefinition(String viewName) Creates a new view definition based on a folding definition (see FoldingDefinition).

Method Detail

createView

View createView(String viewName)

Creates a client representation of a view stored in the UCMDB. No verification is done to check if the view exists at the server side. This view can executed or updated and saved to the UCMDB.

Parameters:

viewName - The view identifier in the UCMDB.

Returns:

a client representation of a server-side view

createView

View createView(ViewDefinition viewDefinition)

Creates a client representation of a view stored in the UCMDB. No verification is done to check if the view exists at the server side. This view can executed or updated and saved to the UCMDB.

Parameters:

viewDefinition - A view definition instance.

Returns:

a client representation of a server-side view

createNewView

@Deprecated
View createNewView(String viewName)

Deprecated. will be removed soon, use createViewWithFoldingDefinition(String).

createViewWithFoldingDefinition

@NotFinalAPI
ViewWithFoldingDefinition createViewWithFoldingDefinition(String viewName)

Creates a new view definition based on a folding definition (see FoldingDefinition). The folding definition, query name, and other information can then be completed.

When the view definition is complete, it can be sent for execution using ViewService.executeView(java.lang.String) or saved for later reference using ViewService.saveView(com.hp.ucmdb.api.view.ViewDefinition).

No check is done for an already existing view with the same name at creation time.

Parameters:

viewName - the view name (identifier).

Returns:

an empty view definition, ready to be changed.

createSingleViewReferenceDefinition

@NotFinalAPI
SingleViewReferenceDefinition createSingleViewReferenceDefinition(String viewName,
                                                                               String queryName,
                                                                               String baseViewName)

createPerspectiveBasedViewReferenceDefinition

@NotFinalAPI
PerspectiveBasedViewReferenceDefinition createPerspectiveBasedViewReferenceDefinition(String viewName)

Creates a perspective based view with the given name. Perspectives, seed IDs or query name and other parameters can be set from the PerspectiveBasedViewReferenceDefinition interface.

When the view definition is complete, it can be sent for execution using ViewService.executeView(java.lang.String) or saved for later reference using ViewService.saveView(com.hp.ucmdb.api.view.ViewDefinition).

No check is done for an already existing view with the same name at creation time.

Parameters:

viewName - the view name (identifier).

Returns:

an empty view definition, ready to be changed.

createRuleBasedViewDefinition

@NotFinalAPI
RuleBasedViewDefinition createRuleBasedViewDefinition(String viewName,
                                                                   String queryName)

createOptions

@NotFinalAPI
ViewExecutionOptions createOptions()

Creates an execution options object that may be used to change the view execution behavior.

Returns:

the new options object.

createViewManagementListenerFilter

ViewManagementListenerFilter createViewManagementListenerFilter()

Creates a new filter for view management listener

Returns:

new filter for view management listener

Since:

9.0

createViewVersion

@NotFinalAPI
ViewVersion createViewVersion(String viewVersionAsString)

createViewResultVersion

@NotFinalAPI
ViewResultVersion createViewResultVersion(String viewResultVersionAsString)

createValidationBulk

@NotFinalAPI
ViewValidationBulk createValidationBulk()

createCmViewDefinition

CmViewDefinition createCmViewDefinition()

Creates a new object that holds CM properties for a view

Returns:

new CmViewDefinition with default values

Since:

10.01