@NotFinalAPI public interface ViewDefinition<T extends ViewDefinition> extends BundledResource<ViewDefinition>, SupportsClientProperties<ViewDefinition>
Modifier and Type | Method and Description |
---|---|
PerspectiveBasedViewReferenceDefinition |
asPerspectiveBasedViewReferenceDefinition()
Returns this interface as a PerspectiveBasedViewReferenceDefinition.
|
RuleBasedViewDefinition |
asRuleBasedViewDefinition()
Returns this interface as a RuleBasedViewDefinition.
|
SingleViewReferenceDefinition |
asSingleViewReference()
Returns this interface as a SingleViewReference.
|
ViewWithFoldingDefinition |
asViewWithFoldingDefinition()
Returns this interface as a ViewWithFoldingDefinition.
|
CmViewDefinition |
cmViewDefinition()
Returns CM definitions for the view
|
String |
description()
Returns a human-readable description of the view purpose.
|
String |
name()
The name fo the view.
|
String |
queryName()
Returns the name of the query this view is based on.
|
View |
toView()
Return an object that can be executed using the
ViewService methods. |
ViewType |
viewType()
The type of the view.
|
T |
withCmViewDefinition(CmViewDefinition cmViewDefinition) |
T |
withDescription(String description)
Changes the human-readable description of the view.
|
bundleNames, withBundles
clientProperties, clientProperty, usedNamespaces, withClientProperty
String name()
String description()
T withDescription(String description)
description
- the new description.View toView()
ViewService
methods.ViewService
methods.ViewType viewType()
String queryName()
ViewWithFoldingDefinition
,
SingleViewReferenceDefinition
or
PerspectiveBasedViewReferenceDefinition
,
according to the viewType()
).CmViewDefinition cmViewDefinition()
T withCmViewDefinition(CmViewDefinition cmViewDefinition)
ViewWithFoldingDefinition asViewWithFoldingDefinition() throws ClassCastException
ClassCastException
- if viewType()
is not ViewType.VIEW_WITH_FOLDING_DEFINITION.SingleViewReferenceDefinition asSingleViewReference() throws ClassCastException
ClassCastException
- if viewType()
is not ViewType.SINGLE_VIEW_REFERENCE_DEFINITION.PerspectiveBasedViewReferenceDefinition asPerspectiveBasedViewReferenceDefinition() throws ClassCastException
ClassCastException
- if viewType()
is not ViewType.PERSPECTIVES_BASED_VIEW_REFERENCE_DEFINITION.RuleBasedViewDefinition asRuleBasedViewDefinition() throws ClassCastException
ClassCastException
- if viewType()
is not ViewType.RULE_BASED_VIEW. Documentation Feedback
Copyright 2011 - 2018 Micro Focus or one of its affiliates.