com.wrq.vhi.sconfig
Interface IMvlBrowser

public interface IMvlBrowser

Interface class for working with model variable lists from a VHI Server. Use the ServerConfig.newMvlBrowser() methods to create instances of this interface.

Method Summary

java.util.List	getConfigurationLock() Obtain the configuration lock from a VHI server or domain.
VhiMvl	getMvl(java.lang.String name) Obtain a copy of a model variable list by name.
java.util.List	getMvlNames() Return a list of model variable name strings obtained by a call to the readConfiguration() method.
java.util.List	readConfiguration() Read model variable lists from a VHI server.
java.util.List	releaseConfigurationLock() Release the configuration lock from a VHI server or domain.
void	setMvl(VhiMvl item) Update the contents of an existing model variable list.
java.util.List	updateConfiguration() Update the model variable lists on a VHI server.

Method Detail

getConfigurationLock

java.util.List getConfigurationLock()

Obtain the configuration lock from a VHI server or domain.

Returns:

List of SCStatus container objects detailing errors, or null of the operation has fully succeeded.

releaseConfigurationLock

java.util.List releaseConfigurationLock()

Release the configuration lock from a VHI server or domain.

Returns:

List of SCStatus container objects detailing errors, or null of the operation has fully succeeded.

readConfiguration

java.util.List readConfiguration()

Read model variable lists from a VHI server.

Returns:

List of SCStatus container objects detailing errors, or null of the operation has fully succeeded.

updateConfiguration

java.util.List updateConfiguration()

Update the model variable lists on a VHI server.

Returns:

List of SCStatus container objects detailing errors, or null of the operation has fully succeeded.

getMvlNames

java.util.List getMvlNames()

Return a list of model variable name strings obtained by a call to the readConfiguration() method.

Returns:

List of model variable names.

getMvl

VhiMvl getMvl(java.lang.String name)

Obtain a copy of a model variable list by name.

Parameters:

name - of the model variable list of interest/

Returns:

A VhiMvl instance containing the model variable list data, or null if the item is not found.

setMvl

void setMvl(VhiMvl item)
            throws SCException

Update the contents of an existing model variable list.

Parameters:

item - VhiMvl instance containing modified variable values.

Throws:

SCException - if the existing MVL is not found.