filenet.vw.api

Class VWLanguagePack

java.lang.Object

filenet.vw.api.VWLanguagePack

All Implemented Interfaces:

java.io.Serializable

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

This class encapsulates a language pack, which contains information the PE server uses to generate e-mail notification messages.

Since:

PE 5.2.0.0

See Also:

VWSystemAdministration.createLanguagePack(Locale), VWSystemAdministration.getLanguagePack(Locale), VWSystemAdministration.getLanguagePacks(), Serialized Form

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCharacterSetName() Get the character set name
java.lang.String	getDateTimePattern() Gets the date/time pattern.
java.lang.String	getLocaleName() Gets the locale name.
java.lang.String	getNumberFormatPattern() Gets the number format pattern.
VWAppNotificationTemplateList[]	getTemplateFiles() Gets the e-mail notification templates that were loaded by a call to VWLanguagePack.updateTemplateFiles(String).
boolean	hasChanged() Returns a boolean value indicating whether or not this language pack has changed.
void	setCharacterSetName(java.lang.String theCharacterSetName) Sets the character set name.
void	setDateTimePattern(java.lang.String theDateTimePattern) Sets the date/time pattern
void	setNumberFormatPattern(java.lang.String theNumberFormatPattern) Sets the number format pattern.
void	updateTemplateFiles(java.lang.String theDirectoryPath) Loads the e-mail notification template files from the specified directory.

Methods inherited from class java.lang.Object

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

Method Detail

getLocaleName

public java.lang.String getLocaleName()
                               throws VWException

Gets the locale name.

Returns:

The locale name.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

Locale.toString()

getDateTimePattern

public java.lang.String getDateTimePattern()
                                    throws VWException

Gets the date/time pattern.

Returns:

The date/time pattern.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

SimpleDateFormat

setDateTimePattern

public void setDateTimePattern(java.lang.String theDateTimePattern)
                        throws VWException

Sets the date/time pattern

Parameters:

theDateTimePattern - A valid date/time pattern. See SimpleDateFormat for format information.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getNumberFormatPattern

public java.lang.String getNumberFormatPattern()
                                        throws VWException

Gets the number format pattern.

Returns:

The number format pattern.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

DecimalFormat

setNumberFormatPattern

public void setNumberFormatPattern(java.lang.String theNumberFormatPattern)
                            throws VWException

Sets the number format pattern.

Parameters:

theNumberFormatPattern - A valid data/time pattern. See DecimalFormat for format information.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getCharacterSetName

public java.lang.String getCharacterSetName()
                                     throws VWException

Get the character set name

Returns:

the character set name

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

Charset

setCharacterSetName

public void setCharacterSetName(java.lang.String theCharacterSetName)
                         throws VWException

Sets the character set name.

Parameters:

theCharacterSetName - A valid character set name. See Charset for information on the available character sets.

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 language pack has changed.

Returns:

A value of true if this language pack has changed; false otherwise.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

updateTemplateFiles

public void updateTemplateFiles(java.lang.String theDirectoryPath)
                         throws VWException

Loads the e-mail notification template files from the specified directory.

Parameters:

theDirectoryPath - The directory containing the e-mail notification template files.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWLanguagePack.getTemplateFiles()

getTemplateFiles

public VWAppNotificationTemplateList[] getTemplateFiles()
                                                 throws VWException

Gets the e-mail notification templates that were loaded by a call to VWLanguagePack.updateTemplateFiles(String).

Returns:

An array containing VWAppNotificationTemplateList objects.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWAppNotificationTemplateList