filenet.vw.api

Class VWServerInstanceSettings

java.lang.Object

filenet.vw.api.VWServerInstanceSettings

All Implemented Interfaces:

java.io.Serializable

public final class VWServerInstanceSettings
extends java.lang.Object
implements java.io.Serializable

This class contains the custom settings for a PE server instance.

Since:

PE 5.2.0.0

See Also:

VWSystemAdministration.getServerInstanceSettingsItem(String), VWSystemAdministration.getServerInstanceSettingsItems(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_INSTANCE_NAME The default instance name, "<default>" which is localized.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInstanceName() Gets the server instance name.
java.lang.String[]	getSettingNames(boolean bIncludeNullValues) Gets a String array containing the names of the current settings.
java.lang.String	getValue(java.lang.String theKey) Gets a value using the specified key.
boolean	hasChanged() Returns a boolean value indicating whether or not this server instance settings object has changed.
boolean	isDefault() Returns a boolean value indicating whether or not this is the default server instance settings object.
boolean	isEmpty() Returns true if no settings are defined for this server or all of the setting values are null.
void	removeAll() Sets the value of all of the settings that are defined for this server to null.
void	setValue(java.lang.String theKey, java.lang.String theValue) Sets a value using the specified key.
java.lang.String	toString() Gets a string representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_INSTANCE_NAME

public static final java.lang.String DEFAULT_INSTANCE_NAME

The default instance name, "<default>" which is localized. Used for the VWServerInstanceSettings object containing the default settings.

See Also:

VWSystemAdministration.getServerInstanceSettingsItem(String theInstanceName)

Method Detail

getInstanceName

public java.lang.String getInstanceName()
                                 throws VWException

Gets the server instance name.

Returns:

The server instance name.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getValue

public java.lang.String getValue(java.lang.String theKey)
                          throws VWException

Gets a value using the specified key.

Parameters:

theKey - The setting name.

Returns:

The value for the given key, if found; null otherwise.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

setValue

public void setValue(java.lang.String theKey,
            java.lang.String theValue)
              throws VWException

Sets a value using the specified key.

Parameters:

theKey - The setting name.

theValue - The value to set. Specify null to remove the item from the list.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getSettingNames

public java.lang.String[] getSettingNames(boolean bIncludeNullValues)
                                   throws VWException

Gets a String array containing the names of the current settings.

Parameters:

bIncludeNullValues - If true the names of items with null values are included.

Returns:

a String array containing the names of the current settings.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

isDefault

public boolean isDefault()
                  throws VWException

Returns a boolean value indicating whether or not this is the default server instance settings object.

Returns:

A value of true if this this is the default server instance settings object; false otherwise.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

isEmpty

public boolean isEmpty()
                throws VWException

Returns true if no settings are defined for this server or all of the setting values are null.

Returns:

A value of true if there will not be any settings defined for this server after this item is saved to the server; false otherwise.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

hasChanged

public boolean hasChanged()
                   throws VWException

Returns a boolean value indicating whether or not this server instance settings object has changed.

Returns:

A value of true if this server instance settings object has changed; false otherwise.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

removeAll

public void removeAll()
               throws VWException

Sets the value of all of the settings that are defined for this server to null.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

toString

public java.lang.String toString()

Gets a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

The instance name.

Since:

PE 5.2.0.0

See Also:

VWServerInstanceSettings.getInstanceName()