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

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static ViewService	service Supported API: true

Constructor Summary

ViewHelper()

Method Summary

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.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ViewHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

service

public static final ViewService service

Supported API: true

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ViewHelper

public ViewHelper()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ViewHelper thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

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