lumis.portal.serviceinterface
Class ServiceInterfaceConfig

java.lang.Object
  lumis.portal.serviceinterface.ServiceInterfaceConfig

@StableMinor(version="6.2",
             sinceVersion="4.0")
public class ServiceInterfaceConfig
extends Object

Holds information about a service interface.

Since:

4.0.0

Field Summary

static String	CACHE_LEVEL_LOCAL_DEFINITION_VALUE
static int	CACHE_LEVEL_LOCAL_VALUE
static String	CACHE_LEVEL_PAGE_TEMPLATE_DEFINITION_VALUE
static int	CACHE_LEVEL_PAGE_TEMPLATE_VALUE
static String	CACHE_PERSONALIZATION_GUEST_ONLY_DEFINITION_VALUE
static int	CACHE_PERSONALIZATION_GUEST_ONLY_VALUE
static String	CACHE_PERSONALIZATION_NONE_DEFINITION_VALUE
static int	CACHE_PERSONALIZATION_NONE_VALUE
static String	CACHE_PERSONALIZATION_PER_USER_DEFINITION_VALUE
static int	CACHE_PERSONALIZATION_PER_USER_VALUE
static String	RENDER_AS_CLIENT_SIDE_SCRIPT_DEFINITION_VALUE
static int	RENDER_AS_CLIENT_SIDE_SCRIPT_VALUE
static String	RENDER_AS_INLINE_DEFINITION_VALUE
static int	RENDER_AS_INLINE_VALUE

Constructor Summary

ServiceInterfaceConfig()

Method Summary

String	getBaseUrl()
int	getCacheLevel()
int	getCachePersonalization()
String	getDefinition()
Node	getDefinitionNode()
String	getDescription()
Enumeration	getExtendedProperties(String name)
String	getExtendedProperty(String name)
Enumeration	getExtendedPropertyNames()
String	getId()
String	getImplementationClass()
String	getInterfaceType()
boolean	getIsWidget() Returns the isWidget.
String	getName()
String	getPopupWindowProperties()
Enumeration	getProperties(String name)
String	getProperty(String name)
Enumeration	getPropertyNames()
String	getRelativeId()
int	getRenderAs()
IResource	getResource()
String	getServiceId()
String	getStringsUrlPrefix()
List<String>	getStringsUrlPrefixes()
List<PortletMode>	getSupportedModes() Returns a unmodifiable list with the supported modes for this interface.
String	getTitle()
boolean	getUsesSocialProfileInformation() Returns whether this interface uses social profile information.
boolean	isAdministration()
boolean	isCacheServerSideInclude()
boolean	isDetails()
boolean	isEnableCache()
boolean	isInContextEditSupported()
boolean	isList()
void	isList(boolean isList)
boolean	isPreviewSupported()
boolean	isPrintable()
boolean	isRestEnabled() Returns whether Rest API is enabled for the interface.
boolean	isRuntimeOnly()
boolean	isServiceInstanceRequired() Returns whether this interface requires or not a service instance to be executed.
void	setAdministration(boolean isAdministration)
void	setBaseUrl(String baseUrl)
void	setCacheLevel(int cacheLevel)
void	setCachePersonalization(int cachePersonalization)
void	setCacheServerSideInclude(boolean cacheServerSideInclude)
void	setDefinition(String interfaceDefinition)
void	setDefinitionNode(Node interfaceXmlNode)
void	setDescription(String description)
void	setDetails(boolean isDetails)
void	setEnableCache(boolean enableCache)
void	setId(String id)
void	setIsWidget(boolean isWidget) Sets the isWidget.
void	setName(String name)
void	setPreviewSupported(boolean previewSupported)
void	setPrintable(boolean isPrintable)
void	setRenderAs(int renderAs)
void	setRuntimeOnly(boolean isRuntimeOnly)
void	setServiceId(String serviceId)
void	setServiceInstanceRequired(boolean serviceInstanceRequired) Indicates whether this interface requires or not a service instance to be executed.
void	setStringsUrlPrefix(String stringsUrlPrefix)
void	setTitle(String title)
void	setUsesSocialProfileInformation(boolean usesSocialProfileInformation) Sets whether this interface uses social profile information.

Methods inherited from class java.lang.Object

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

Field Detail

RENDER_AS_INLINE_DEFINITION_VALUE

public static final String RENDER_AS_INLINE_DEFINITION_VALUE

See Also:

Constant Field Values

RENDER_AS_INLINE_VALUE

public static final int RENDER_AS_INLINE_VALUE

See Also:

Constant Field Values

RENDER_AS_CLIENT_SIDE_SCRIPT_DEFINITION_VALUE

public static final String RENDER_AS_CLIENT_SIDE_SCRIPT_DEFINITION_VALUE

See Also:

Constant Field Values

RENDER_AS_CLIENT_SIDE_SCRIPT_VALUE

public static final int RENDER_AS_CLIENT_SIDE_SCRIPT_VALUE

See Also:

Constant Field Values

CACHE_LEVEL_LOCAL_DEFINITION_VALUE

public static final String CACHE_LEVEL_LOCAL_DEFINITION_VALUE

See Also:

Constant Field Values

CACHE_LEVEL_LOCAL_VALUE

public static final int CACHE_LEVEL_LOCAL_VALUE

See Also:

Constant Field Values

CACHE_LEVEL_PAGE_TEMPLATE_DEFINITION_VALUE

public static final String CACHE_LEVEL_PAGE_TEMPLATE_DEFINITION_VALUE

See Also:

Constant Field Values

CACHE_LEVEL_PAGE_TEMPLATE_VALUE

public static final int CACHE_LEVEL_PAGE_TEMPLATE_VALUE

See Also:

Constant Field Values

CACHE_PERSONALIZATION_NONE_DEFINITION_VALUE

public static final String CACHE_PERSONALIZATION_NONE_DEFINITION_VALUE

See Also:

Constant Field Values

CACHE_PERSONALIZATION_NONE_VALUE

public static final int CACHE_PERSONALIZATION_NONE_VALUE

See Also:

Constant Field Values

CACHE_PERSONALIZATION_GUEST_ONLY_DEFINITION_VALUE

public static final String CACHE_PERSONALIZATION_GUEST_ONLY_DEFINITION_VALUE

See Also:

Constant Field Values

CACHE_PERSONALIZATION_GUEST_ONLY_VALUE

public static final int CACHE_PERSONALIZATION_GUEST_ONLY_VALUE

See Also:

Constant Field Values

CACHE_PERSONALIZATION_PER_USER_DEFINITION_VALUE

public static final String CACHE_PERSONALIZATION_PER_USER_DEFINITION_VALUE

See Also:

Constant Field Values

CACHE_PERSONALIZATION_PER_USER_VALUE

public static final int CACHE_PERSONALIZATION_PER_USER_VALUE

See Also:

Constant Field Values

Constructor Detail

ServiceInterfaceConfig

public ServiceInterfaceConfig()

Method Detail

getDefinitionNode

public Node getDefinitionNode()
                       throws PortalException

Returns:

Returns the definition.

Throws:

PortalException

getDefinition

public String getDefinition()
                     throws PortalException

Returns:

Returns the definition Node

Throws:

PortalException

setDefinition

public void setDefinition(String interfaceDefinition)
                   throws PortalException

Parameters:

definition - The definition to set.

Throws:

PortalException

setDefinitionNode

public void setDefinitionNode(Node interfaceXmlNode)
                       throws PortalException

Parameters:

definition - The definition to set.

Throws:

PortalException

getId

public String getId()

Returns:

Returns the id.

setId

public void setId(String id)

getRelativeId

public String getRelativeId()

getBaseUrl

public String getBaseUrl()

Returns:

Returns the id.

setBaseUrl

public void setBaseUrl(String baseUrl)

getStringsUrlPrefixes

public List<String> getStringsUrlPrefixes()

Returns:

Returns the stringsUrlPrefix array.

getStringsUrlPrefix

public String getStringsUrlPrefix()

Returns:

Returns the first (main) stringsUrlPrefix.

setStringsUrlPrefix

public void setStringsUrlPrefix(String stringsUrlPrefix)

getName

public String getName()

Returns:

Returns the name.

setName

public void setName(String name)

getDescription

public String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(String description)

getServiceId

public String getServiceId()

Returns:

Returns the serviceId.

setServiceId

public void setServiceId(String serviceId)

getProperty

public String getProperty(String name)

getProperties

public Enumeration getProperties(String name)

getPropertyNames

public Enumeration getPropertyNames()

getExtendedProperty

public String getExtendedProperty(String name)

getExtendedProperties

public Enumeration getExtendedProperties(String name)

getExtendedPropertyNames

public Enumeration getExtendedPropertyNames()

getImplementationClass

public String getImplementationClass()

getInterfaceType

public String getInterfaceType()

getResource

public IResource getResource()
                      throws PortalException

Throws:

PortalException

getPopupWindowProperties

public String getPopupWindowProperties()
                                throws PortalException

Throws:

PortalException

isRuntimeOnly

public boolean isRuntimeOnly()

Returns:

Returns the isRuntimeOnly.

setRuntimeOnly

public void setRuntimeOnly(boolean isRuntimeOnly)

Parameters:

isRuntimeOnly - The isRuntimeOnly to set.

isAdministration

public boolean isAdministration()

Returns:

Returns the isAdministration.

setAdministration

public void setAdministration(boolean isAdministration)

Parameters:

isAdministration - The isAdministration to set.

isDetails

public boolean isDetails()

setDetails

public void setDetails(boolean isDetails)

isList

public boolean isList()

isList

public void isList(boolean isList)

isPrintable

public boolean isPrintable()

Returns:

Returns the isPrintable.

setPrintable

public void setPrintable(boolean isPrintable)

Parameters:

isPrintable - The isPrintable to set.

getRenderAs

public int getRenderAs()

Returns:

Returns the renderAs.

setRenderAs

public void setRenderAs(int renderAs)

Parameters:

renderAs - The renderAs to set.

isEnableCache

public boolean isEnableCache()

Returns:

Returns the enableCache.

setEnableCache

public void setEnableCache(boolean enableCache)

Parameters:

enableCache - The enableCache to set.

getCacheLevel

public int getCacheLevel()

Returns:

Returns the cacheLevel.

setCacheLevel

public void setCacheLevel(int cacheLevel)

Parameters:

cacheLevel - The cacheLevel to set.

getCachePersonalization

public int getCachePersonalization()

Returns:

Returns the cachePersonalization.

setCachePersonalization

public void setCachePersonalization(int cachePersonalization)

Parameters:

cachePersonalization - The cachePersonalization to set.

isCacheServerSideInclude

public boolean isCacheServerSideInclude()

Returns:

Returns the cacheServerSideInclude.

setCacheServerSideInclude

public void setCacheServerSideInclude(boolean cacheServerSideInclude)

Parameters:

cacheServerSideInclude - The cacheServerSideInclude to set.

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

isPreviewSupported

public boolean isPreviewSupported()

setPreviewSupported

public void setPreviewSupported(boolean previewSupported)

isInContextEditSupported

public boolean isInContextEditSupported()

setServiceInstanceRequired

public void setServiceInstanceRequired(boolean serviceInstanceRequired)

Indicates whether this interface requires or not a service instance to be executed.

Parameters:

serviceInstanceRequired - Indicates whether this interface requires or not a service instance to be executed.

Since:

5.6.0

isServiceInstanceRequired

public boolean isServiceInstanceRequired()

Returns whether this interface requires or not a service instance to be executed.

Returns:

whether this interface requires or not a service instance to be executed.

Since:

5.6.0

getSupportedModes

public List<PortletMode> getSupportedModes()

Returns a unmodifiable list with the supported modes for this interface. The list contains the modes in the same order they were defined in the interface definition.

Returns:

a unmodifiable list with the supported modes for this interface.

Since:

4.0.7

setIsWidget

public void setIsWidget(boolean isWidget)

Sets the isWidget.

Parameters:

isWidget - the isWidget value to set.

Since:

6.0.0

getIsWidget

public boolean getIsWidget()

Returns the isWidget.

Returns:

the isWidget

Since:

6.0.0

getUsesSocialProfileInformation

public boolean getUsesSocialProfileInformation()

Returns whether this interface uses social profile information.

Returns:

whether this interface uses social profile information.

Since:

6.1.0

setUsesSocialProfileInformation

public void setUsesSocialProfileInformation(boolean usesSocialProfileInformation)

Sets whether this interface uses social profile information.

Parameters:

usesSocialProfileInformation - whether this interface uses social profile information.

Since:

6.1.0

isRestEnabled

public boolean isRestEnabled()
                      throws PortalException

Returns whether Rest API is enabled for the interface.

Returns:

true if enabled.

Throws:

PortalException