Package lumis.util

Interface IResource

All Known Implementing Classes:

AnalyticsStringResource, ContentStringResource, ContentWizardStringResource, ControllerStringResource, ControlStringResource, DaoStringResource, DeploymentStringResource, DouiStringResource, FileStringResource, GenericStringResource, ImportPrincipalStringResource, InContextEditResource, LuceneSearchStringResource, ManagerStringResource, PortalAclStringResource, PortalStringResource, PortletStringResource, ProgressStringResource, PublishToSocialNetworksStringResource, SearchStringResource, SerializationStringResource, ServiceContainerStringResource, ServiceStringResource, SocialNetworkIntegrationStringResource, UFrameStringResource, UpdateStringResource, VirtualAssistantStringResource, WorkflowStringResource

@StableMinor(version="17.0",
             sinceVersion="4.0")
public interface IResource

Since:

4.0.0

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method	Description
void	addResourcePath(java.lang.String resourcePath)
java.util.Enumeration<java.lang.String>	getResourcePaths()
default java.lang.String	localize(java.lang.String stringId)	Localizes a string using this string resource.
default java.lang.String	localize(java.lang.String stringId, PageWebResource pageWebResource)	Localizes a string using this string resource.

Method Detail

addResourcePath

void addResourcePath(java.lang.String resourcePath)

getResourcePaths

java.util.Enumeration<java.lang.String> getResourcePaths()

localize

default java.lang.String localize(java.lang.String stringId)
                           throws PortalException

Localizes a string using this string resource.

This is the same as ILocalizationManager.localize(String, IResource).

Parameters:

stringId - the string id to localize.

Returns:

the localized string, or given the received string id when no localization was found. If the given id is null, null is returned.

Throws:

PortalException

Since:

17.0.0

localize

default java.lang.String localize(java.lang.String stringId,
                                  PageWebResource pageWebResource)
                           throws PortalException

Localizes a string using this string resource.

This is the same as ILocalizationManager.localize(String, IResource, PageWebResource).

Parameters:

stringId - the string id to localize.

pageWebResource - the PageWebResource used to search for localizations within themes.

Returns:

the localized string, or given the received string id when no localization was found. If the given id is null, null is returned.

Throws:

PortalException

Since:

17.0.0