com.thingworx.resources.localization

Class RuntimeLocalizationFunctions

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.resources.Resource

com.thingworx.resources.localization.RuntimeLocalizationFunctions

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<java.lang.String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, java.io.Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class RuntimeLocalizationFunctions
extends Resource

See Also:

Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTIES

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
RuntimeLocalizationFunctions()

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document	ExportLocalizationTables(java.lang.String prefix) Service Category: Localization Service Description: Export localization tables, optionally with a token name filter.
java.lang.String	GetEffectiveToken(java.lang.String token) Service Category: Localization Service Description: Return a token based on language setting for current user.
java.lang.String	GetEffectiveTokenForLanguage(java.lang.String language, java.lang.String token) Service Category: Localization Service Description: Return a token for a specific language.
InfoTable	GetEffectiveTokens() Service Category: Localization Service Description: Return a list of effective tokens based on language setting for current user.
InfoTable	GetEffectiveTokensForLanguage(java.lang.String language) Service Category: Localization Service Description: Return a table of tokens and values, given an ordered list of language preferences.
InfoTable	GetLanguages() Service Category: Localization Service Description: Return a list of languages defined on this system. Get a list of configured languages along with useful properties of each.
InfoTable	SearchDefaultLocalizationTokens(java.lang.String searchExpression) Service Category: Localization Service Description: Return a list of Default tokens matching search expression.

Methods inherited from class com.thingworx.resources.Resource

getEntityType

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, validateConfiguration

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Constructor Detail

RuntimeLocalizationFunctions

public RuntimeLocalizationFunctions()

Method Detail

SearchDefaultLocalizationTokens

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchDefaultLocalizationTokens(java.lang.String searchExpression)
                                                                                    throws java.lang.Exception

Service Category:

Localization

Service Description:

Return a list of Default tokens matching search expression.

Parameters:

searchExpression - search pattern - STRING

Returns:

result Localization tokens - INFOTABLE - Aspects {dataShape:LocalizationToken}

Throws:

java.lang.Exception - If an error occurs

GetEffectiveTokens

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetEffectiveTokens()
                                                                       throws java.lang.Exception

Service Category:

Localization

Service Description:

Return a list of effective tokens based on language setting for current user.

Returns:

result Localization tokens - INFOTABLE - Aspects {dataShape:LocalizationToken}

Throws:

java.lang.Exception - If an error occurs

GetEffectiveTokensForLanguage

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetEffectiveTokensForLanguage(java.lang.String language)
                                                                                  throws java.lang.Exception

Service Category:

Localization

Service Description:

Return a table of tokens and values, given an ordered list of language preferences.

Parameters:

language - Language code - STRING

Returns:

result Localization tokens and values - INFOTABLE - Aspects {dataShape:LocalizationToken}

Throws:

java.lang.Exception - If an error occurs

ExportLocalizationTables

@ThingworxExtensionApiMethod(since={6,6})
public org.w3c.dom.Document ExportLocalizationTables(java.lang.String prefix)
                                                                                        throws java.lang.Exception

Service Category:

Localization

Service Description:

Export localization tables, optionally with a token name filter.

Parameters:

prefix - Token prefix - STRING

Returns:

result Localization tokens - XML

Throws:

java.lang.Exception - If an error occurs

GetEffectiveToken

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetEffectiveToken(java.lang.String token)
                                                                             throws java.lang.Exception

Service Category:

Localization

Service Description:

Return a token based on language setting for current user.

Parameters:

token - Token - STRING

Returns:

result Localization tokens - STRING

Throws:

java.lang.Exception - If an error occurs

GetEffectiveTokenForLanguage

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetEffectiveTokenForLanguage(java.lang.String language,
                                                                                               java.lang.String token)
                                                                                        throws java.lang.Exception

Service Category:

Localization

Service Description:

Return a token for a specific language.

Parameters:

language - Language code - STRING

token - Token - STRING

Returns:

result Localization tokens - STRING

Throws:

java.lang.Exception - If an error occurs

GetLanguages

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetLanguages()
                                                                 throws java.lang.Exception

Service Category:

Localization

Service Description:

Return a list of languages defined on this system.

Get a list of configured languages along with useful properties of each.

Returns:

InfoTable, one row per language, with properties name, description, avatar, common name, native name.

Throws:

java.lang.Exception