Package wt.vc.views

Class ViewHelper

java.lang.Object

wt.vc.views.ViewHelper

All Implemented Interfaces:

Externalizable, Serializable

public final class ViewHelper
extends Object
implements Externalizable

This standard helper for ViewService has helper methods and accesses API functionality via ViewHelper.service.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ViewService	service	Supported API: true

Method Summary

Modifier and Type	Method	Description
static void	assignToView(ViewManageable version, View view)	Assigns the view to a version.
static View	getView(ViewManageable version)	Returns the view the version is assigned to.
static String	getViewName(ViewManageable version)	Returns the name of the view this object is assigned to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

service

public static final ViewService service

Supported API: true

Method Details

getViewName

public static String getViewName(ViewManageable version)

Returns the name of the view this object is assigned to. If the version is not assigned to a view, returns null.

Supported API: true

Parameters:

version -

Returns:

String

getView

public static View getView(ViewManageable version)

Returns the view the version is assigned to. If the version is not assigned to a view, returns null.

Supported API: true

Parameters:

version -

Returns:

View

assignToView

public static void assignToView(ViewManageable version,
 View view)
                         throws ViewException

Assigns the view to a version. This method will throw a ViewException if the version has been persisted or has been created from another version. View-independent versions can not be assigned to versions and can not be branched into a view.

Supported API: true

Parameters:

version - The ViewManageable version to assign to a view.

view - The view to assign the version to.

Throws:

ViewException