Class ServiceInterfaceInstanceConfig
- java.lang.Object
-
- lumis.portal.serviceinterfaceinstance.ServiceInterfaceInstanceConfig
-
- All Implemented Interfaces:
java.lang.Cloneable
,ICacheEntry
,ICloneableCacheEntry
,ICloneableConfig<ServiceInterfaceInstanceConfig>
@StableMinor(version="17.0", sinceVersion="4.0") public class ServiceInterfaceInstanceConfig extends java.lang.Object implements ICloneableCacheEntry, ICloneableConfig<ServiceInterfaceInstanceConfig>
Holds the data about a service interface instance.- Since:
- 4.0.0
- Version:
- $Revision$ $Date$
-
-
Field Summary
Fields Modifier and Type Field Description static int
CACHE_LEVEL_INHERIT
static int
CACHE_PERSONALIZATION_INHERIT
static int
CACHE_SERVER_SIDE_INCLUDE_INHERIT
static int
CACHE_SERVER_SIDE_INCLUDE_NO
static int
CACHE_SERVER_SIDE_INCLUDE_YES
static int
ENABLE_CACHE_INHERIT
static int
PRINT_INTERFACE_INHERIT
static int
PRINT_INTERFACE_NO
static int
PRINT_INTERFACE_YES
static int
RENDER_AS_INHERIT
static int
RENDER_DISABLED
-
Constructor Summary
Constructors Constructor Description ServiceInterfaceInstanceConfig()
ServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig copy)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ServiceInterfaceInstanceConfig
clone()
void
deserialize(org.w3c.dom.Node serviceInterfaceInstanceNode)
java.lang.String
getBaseInterfaceInstanceId()
Returns the identifier of the service interface instance this instance derives from.int
getCacheLevel()
int
getCachePersonalization()
int
getCacheServerSideInclude()
java.lang.Integer
getColspan()
java.lang.String
getDisplayName()
Returns the display name to be used for this service interface instance.int
getEnableCache()
java.lang.String
getHeight()
java.lang.Integer
getHolderPriority()
java.lang.String
getId()
IServiceInterfaceInstanceOwner
getOwner()
Returns the owner.java.lang.String
getPaddingBottom()
java.lang.String
getPaddingLeft()
java.lang.String
getPaddingRight()
java.lang.String
getPaddingTop()
java.lang.String
getPageId()
java.lang.String
getParentInterfaceInstanceId()
int
getPrintable()
int
getRenderAs()
java.lang.Integer
getRowspan()
java.lang.String
getServiceInstanceId()
java.lang.String
getServiceInterfaceId()
java.lang.String
getServiceInterfaceStyleId()
java.lang.String
getTitle()
java.lang.String
getWidth()
boolean
isCreatedRunTime()
Created Run Time indicates if the interface instance was created runtime, or if it was explicitly dragged and dropped into a page layout.boolean
isIdentical(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)
Returns true if all properties of this object are equals to the properties of the given object.boolean
isInContextEditDisabled()
boolean
isInterfaceHolder()
boolean
isShowTitleBar()
void
serialize(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, java.io.OutputStream outputStream)
void
setBaseInterfaceInstanceId(java.lang.String baseInterfaceInstanceId)
Sets the service interface instance this instance derives from.void
setCacheLevel(int cacheLevel)
void
setCachePersonalization(int cachePersonalization)
void
setCacheServerSideInclude(int cacheServerSideInclude)
void
setColspan(java.lang.Integer colspan)
void
setCreatedRunTime(boolean isCreatedRunTime)
Created Run Time indicates if the interface instance was created runtime, or if it was explicitly dragged and dropped into a page layout.void
setDisableInContextEdit(boolean disableInContextEdit)
void
setDisplayName(java.lang.String displayName)
Sets the display name for this service interface instance.void
setEnableCache(int enableCache)
void
setHeight(java.lang.String height)
void
setHolderPriority(java.lang.Integer holderPriority)
void
setId(java.lang.String id)
void
setOrphan(java.lang.Class<? extends IServiceInterfaceInstanceOwner> ownerClass)
Sets the owner for this service interface instance.void
setPaddingBottom(java.lang.String paddingBottom)
void
setPaddingLeft(java.lang.String paddingLeft)
void
setPaddingRight(java.lang.String paddingRight)
void
setPaddingTop(java.lang.String paddingTop)
void
setPageId(java.lang.String pageId)
Sets the page id for this Service Interface Instance.void
setParentInterfaceInstanceId(java.lang.String parentInterfaceInstanceId)
void
setPrintable(int printable)
void
setRenderAs(int renderAs)
void
setRowspan(java.lang.Integer rowspan)
void
setServiceInstanceId(java.lang.String serviceInstanceId)
void
setServiceInterfaceId(java.lang.String interfaceId)
void
setServiceInterfaceStyleId(java.lang.String styleId)
void
setShowTitleBar(boolean showTitleBar)
void
setTitle(java.lang.String title)
void
setWidth(java.lang.String width)
-
-
-
Field Detail
-
PRINT_INTERFACE_INHERIT
public static final int PRINT_INTERFACE_INHERIT
- See Also:
- Constant Field Values
-
PRINT_INTERFACE_YES
public static final int PRINT_INTERFACE_YES
- See Also:
- Constant Field Values
-
PRINT_INTERFACE_NO
public static final int PRINT_INTERFACE_NO
- See Also:
- Constant Field Values
-
RENDER_AS_INHERIT
public static final int RENDER_AS_INHERIT
- See Also:
- Constant Field Values
-
ENABLE_CACHE_INHERIT
public static final int ENABLE_CACHE_INHERIT
- See Also:
- Constant Field Values
-
CACHE_LEVEL_INHERIT
public static final int CACHE_LEVEL_INHERIT
- See Also:
- Constant Field Values
-
CACHE_PERSONALIZATION_INHERIT
public static final int CACHE_PERSONALIZATION_INHERIT
- See Also:
- Constant Field Values
-
CACHE_SERVER_SIDE_INCLUDE_NO
public static final int CACHE_SERVER_SIDE_INCLUDE_NO
- See Also:
- Constant Field Values
-
CACHE_SERVER_SIDE_INCLUDE_YES
public static final int CACHE_SERVER_SIDE_INCLUDE_YES
- See Also:
- Constant Field Values
-
CACHE_SERVER_SIDE_INCLUDE_INHERIT
public static final int CACHE_SERVER_SIDE_INCLUDE_INHERIT
- See Also:
- Constant Field Values
-
RENDER_DISABLED
public static final int RENDER_DISABLED
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ServiceInterfaceInstanceConfig
public ServiceInterfaceInstanceConfig()
-
ServiceInterfaceInstanceConfig
public ServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig copy) throws java.lang.Exception
- Throws:
java.lang.Exception
-
-
Method Detail
-
clone
public ServiceInterfaceInstanceConfig clone() throws java.lang.CloneNotSupportedException
- Specified by:
clone
in interfaceICloneableCacheEntry
- Specified by:
clone
in interfaceICloneableConfig<ServiceInterfaceInstanceConfig>
- Overrides:
clone
in classjava.lang.Object
- Throws:
java.lang.CloneNotSupportedException
-
getId
public java.lang.String getId()
- Returns:
- Returns the id.
-
setId
public void setId(java.lang.String id)
- Parameters:
id
- The id to set.
-
isInterfaceHolder
public boolean isInterfaceHolder()
-
getServiceInterfaceId
public java.lang.String getServiceInterfaceId()
- Returns:
- Returns the serviceInterfaceId.
-
setServiceInterfaceId
public void setServiceInterfaceId(java.lang.String interfaceId)
- Parameters:
serviceInterfaceId
- The serviceInterfaceId to set.
-
getServiceInstanceId
public java.lang.String getServiceInstanceId()
- Returns:
- Returns the serviceInstanceId.
-
setServiceInstanceId
public void setServiceInstanceId(java.lang.String serviceInstanceId)
- Parameters:
serviceInstanceId
- The serviceInstanceId to set.
-
getServiceInterfaceStyleId
public java.lang.String getServiceInterfaceStyleId()
- Returns:
- Returns the serviceInterfaceStyleId.
-
setServiceInterfaceStyleId
public void setServiceInterfaceStyleId(java.lang.String styleId)
- Parameters:
serviceInterfaceStyleId
- The serviceInterfaceStyleId to set.
-
getPageId
public java.lang.String getPageId()
- Returns:
- Returns the pageId.
-
setPageId
public void setPageId(java.lang.String pageId)
Sets the page id for this Service Interface Instance. If the service interface instance has had its owner info already set, this owner info will be discarded and the page will become it's owner. For further information, see#setOrphan(String)
.- Parameters:
pageId
- The pageId to set.
-
getParentInterfaceInstanceId
public java.lang.String getParentInterfaceInstanceId()
-
setParentInterfaceInstanceId
public void setParentInterfaceInstanceId(java.lang.String parentInterfaceInstanceId)
-
isCreatedRunTime
public boolean isCreatedRunTime()
Created Run Time indicates if the interface instance was created runtime, or if it was explicitly dragged and dropped into a page layout.- Returns:
-
setCreatedRunTime
public void setCreatedRunTime(boolean isCreatedRunTime)
Created Run Time indicates if the interface instance was created runtime, or if it was explicitly dragged and dropped into a page layout.- Parameters:
createdRunTime
-
-
getDisplayName
public java.lang.String getDisplayName()
Returns the display name to be used for this service interface instance.The display name is usually the name used for referring to the service interface instance for a developer or administrator.
- Returns:
- the display name.
- Since:
- 5.5.0
-
setDisplayName
public void setDisplayName(java.lang.String displayName)
Sets the display name for this service interface instance.- Parameters:
displayName
- the display name.- Since:
- 5.5.0
- See Also:
getDisplayName()
-
getTitle
public java.lang.String getTitle()
-
setTitle
public void setTitle(java.lang.String title)
-
getColspan
public java.lang.Integer getColspan()
-
setColspan
public void setColspan(java.lang.Integer colspan)
-
getHeight
public java.lang.String getHeight()
-
setHeight
public void setHeight(java.lang.String height)
-
getPrintable
public int getPrintable()
-
setPrintable
public void setPrintable(int printable)
-
getPaddingBottom
public java.lang.String getPaddingBottom()
-
setPaddingBottom
public void setPaddingBottom(java.lang.String paddingBottom)
-
getPaddingLeft
public java.lang.String getPaddingLeft()
-
setPaddingLeft
public void setPaddingLeft(java.lang.String paddingLeft)
-
getPaddingRight
public java.lang.String getPaddingRight()
-
setPaddingRight
public void setPaddingRight(java.lang.String paddingRight)
-
getPaddingTop
public java.lang.String getPaddingTop()
-
setPaddingTop
public void setPaddingTop(java.lang.String paddingTop)
-
getRowspan
public java.lang.Integer getRowspan()
-
setRowspan
public void setRowspan(java.lang.Integer rowspan)
-
getWidth
public java.lang.String getWidth()
-
setWidth
public void setWidth(java.lang.String width)
-
getHolderPriority
public java.lang.Integer getHolderPriority()
-
setHolderPriority
public void setHolderPriority(java.lang.Integer holderPriority)
-
getRenderAs
public int getRenderAs()
- Returns:
- Returns the renderAs.
-
setRenderAs
public void setRenderAs(int renderAs)
- Parameters:
renderAs
- The renderAs to set.
-
getEnableCache
public int getEnableCache()
- Returns:
- Returns the enableCache.
-
setEnableCache
public void setEnableCache(int 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.
-
getCacheServerSideInclude
public int getCacheServerSideInclude()
- Returns:
- Returns the cacheServerSideInclude.
-
setCacheServerSideInclude
public void setCacheServerSideInclude(int cacheServerSideInclude)
- Parameters:
cacheServerSideInclude
- The cacheServerSideInclude to set.
-
isShowTitleBar
public boolean isShowTitleBar()
-
setShowTitleBar
public void setShowTitleBar(boolean showTitleBar)
-
isInContextEditDisabled
public boolean isInContextEditDisabled()
-
setDisableInContextEdit
public void setDisableInContextEdit(boolean disableInContextEdit)
-
getBaseInterfaceInstanceId
public java.lang.String getBaseInterfaceInstanceId()
Returns the identifier of the service interface instance this instance derives from.- Returns:
- the identifier or
null
if this instance does not derives from any service interface instance. - Since:
- 10.2.0
-
setBaseInterfaceInstanceId
public void setBaseInterfaceInstanceId(java.lang.String baseInterfaceInstanceId)
Sets the service interface instance this instance derives from.- Parameters:
baseInterfaceInstanceId
- the identifier of the service interface instance this instance derives from, ornull
if this instance does not derives from any service interface instance.- Since:
- 10.2.0
-
serialize
public void serialize(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, java.io.OutputStream outputStream) throws PortalException
- Throws:
PortalException
-
deserialize
public void deserialize(org.w3c.dom.Node serviceInterfaceInstanceNode) throws PortalException
- Throws:
PortalException
-
isIdentical
public boolean isIdentical(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)
Returns true if all properties of this object are equals to the properties of the given object.- Parameters:
ServiceInterfaceInstanceConfig
- the object to compare the properties with.- Returns:
- true if the properties are equal, false otherwise.
- Since:
- 5.6.0
-
getOwner
public IServiceInterfaceInstanceOwner getOwner() throws PortalException
Returns the owner.- Returns:
- the owner
- Throws:
PortalException
- Since:
- 6.0.0
-
setOrphan
public void setOrphan(java.lang.Class<? extends IServiceInterfaceInstanceOwner> ownerClass)
Sets the owner for this service interface instance.When setting an interface instance orphan, you must set the owner for that interface instance. The page id will be set null once an interfaceInstance is set orphan.
- Parameters:
ownerClass
- the owner class of the orphan interface instance.- Throws:
java.lang.IllegalArgumentException
- in case the owner is null- Since:
- 6.0.0
- See Also:
IServiceInterfaceInstanceOwner
-
-