ServiceInterfaceInstanceConfig

java.lang.Object
- lumis.portal.serviceinterfaceinstance.ServiceInterfaceInstanceConfig

All Implemented Interfaces:

Cloneable, ICacheEntry, ICloneableCacheEntry, ICloneableConfig<ServiceInterfaceInstanceConfig>
```
@StableMinor(version="12.4",
             sinceVersion="4.0")
public class ServiceInterfaceInstanceConfig
extends Object
implements ICloneableCacheEntry, ICloneableConfig<ServiceInterfaceInstanceConfig>
```
Holds the data about a service interface instance.

Since:

4.0.0

Version:

$Revision: 23904 $ $Date: 2020-06-16 15:23:44 +0000 (Tue, 16 Jun 2020) $

Field Summary

Fields
Modifier and Type	Field and 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 and Description

ServiceInterfaceInstanceConfig()

ServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig copy)

Constructors
Constructor and Description
`ServiceInterfaceInstanceConfig()`
`ServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig copy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceInterfaceInstanceConfig`	`clone()`
`void`	`deserialize(Node serviceInterfaceInstanceNode)`
`String`	`getBaseInterfaceInstanceId()` Returns the identifier of the service interface instance this instance derives from.
`int`	`getCacheLevel()`
`int`	`getCachePersonalization()`
`int`	`getCacheServerSideInclude()`
`Integer`	`getColspan()`
`String`	`getDisplayName()` Returns the display name to be used for this service interface instance.
`int`	`getEnableCache()`
`String`	`getHeight()`
`Integer`	`getHolderPriority()`
`String`	`getId()`
`IServiceInterfaceInstanceOwner`	`getOwner()` Returns the owner.
`String`	`getPaddingBottom()`
`String`	`getPaddingLeft()`
`String`	`getPaddingRight()`
`String`	`getPaddingTop()`
`String`	`getPageId()`
`String`	`getParentInterfaceInstanceId()`
`int`	`getPrintable()`
`int`	`getRenderAs()`
`Integer`	`getRowspan()`
`String`	`getServiceInstanceId()`
`String`	`getServiceInterfaceId()`
`String`	`getServiceInterfaceStyleId()`
`String`	`getTitle()`
`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, OutputStream outputStream)`
`void`	`setBaseInterfaceInstanceId(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(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(String displayName)` Sets the display name for this service interface instance.
`void`	`setEnableCache(int enableCache)`
`void`	`setHeight(String height)`
`void`	`setHolderPriority(Integer holderPriority)`
`void`	`setId(String id)`
`void`	`setOrphan(Class<? extends IServiceInterfaceInstanceOwner> ownerClass)` Sets the owner for this service interface instance.
`void`	`setPaddingBottom(String paddingBottom)`
`void`	`setPaddingLeft(String paddingLeft)`
`void`	`setPaddingRight(String paddingRight)`
`void`	`setPaddingTop(String paddingTop)`
`void`	`setPageId(String pageId)` Sets the page id for this Service Interface Instance.
`void`	`setParentInterfaceInstanceId(String parentInterfaceInstanceId)`
`void`	`setPrintable(int printable)`
`void`	`setRenderAs(int renderAs)`
`void`	`setRowspan(Integer rowspan)`
`void`	`setServiceInstanceId(String serviceInstanceId)`
`void`	`setServiceInterfaceId(String interfaceId)`
`void`	`setServiceInterfaceStyleId(String styleId)`
`void`	`setShowTitleBar(boolean showTitleBar)`
`void`	`setTitle(String title)`
`void`	`setWidth(String width)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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 Exception
```
    Throws:
    
    Exception
- Method Detail
  - clone
```
public ServiceInterfaceInstanceConfig clone()
                                     throws CloneNotSupportedException
```
    Specified by:
    
    clone in interface ICloneableCacheEntry
    
    Specified by:
    
    clone in interface ICloneableConfig<ServiceInterfaceInstanceConfig>
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - getId
```
public String getId()
```
    Returns:
    
    Returns the id.
  - setId
```
public void setId(String id)
```
    Parameters:
    
    id - The id to set.
  - isInterfaceHolder
```
public boolean isInterfaceHolder()
```
  - getServiceInterfaceId
```
public String getServiceInterfaceId()
```
    Returns:
    
    Returns the serviceInterfaceId.
  - setServiceInterfaceId
```
public void setServiceInterfaceId(String interfaceId)
```
    Parameters:
    
    serviceInterfaceId - The serviceInterfaceId to set.
  - getServiceInstanceId
```
public String getServiceInstanceId()
```
    Returns:
    
    Returns the serviceInstanceId.
  - setServiceInstanceId
```
public void setServiceInstanceId(String serviceInstanceId)
```
    Parameters:
    
    serviceInstanceId - The serviceInstanceId to set.
  - getServiceInterfaceStyleId
```
public String getServiceInterfaceStyleId()
```
    Returns:
    
    Returns the serviceInterfaceStyleId.
  - setServiceInterfaceStyleId
```
public void setServiceInterfaceStyleId(String styleId)
```
    Parameters:
    
    serviceInterfaceStyleId - The serviceInterfaceStyleId to set.
  - getPageId
```
public String getPageId()
```
    Returns:
    
    Returns the pageId.
  - setPageId
```
public void setPageId(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 String getParentInterfaceInstanceId()
```
  - setParentInterfaceInstanceId
```
public void setParentInterfaceInstanceId(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 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(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 String getTitle()
```
  - setTitle
```
public void setTitle(String title)
```
  - getColspan
```
public Integer getColspan()
```
  - setColspan
```
public void setColspan(Integer colspan)
```
  - getHeight
```
public String getHeight()
```
  - setHeight
```
public void setHeight(String height)
```
  - getPrintable
```
public int getPrintable()
```
  - setPrintable
```
public void setPrintable(int printable)
```
  - getPaddingBottom
```
public String getPaddingBottom()
```
  - setPaddingBottom
```
public void setPaddingBottom(String paddingBottom)
```
  - getPaddingLeft
```
public String getPaddingLeft()
```
  - setPaddingLeft
```
public void setPaddingLeft(String paddingLeft)
```
  - getPaddingRight
```
public String getPaddingRight()
```
  - setPaddingRight
```
public void setPaddingRight(String paddingRight)
```
  - getPaddingTop
```
public String getPaddingTop()
```
  - setPaddingTop
```
public void setPaddingTop(String paddingTop)
```
  - getRowspan
```
public Integer getRowspan()
```
  - setRowspan
```
public void setRowspan(Integer rowspan)
```
  - getWidth
```
public String getWidth()
```
  - setWidth
```
public void setWidth(String width)
```
  - getHolderPriority
```
public Integer getHolderPriority()
```
  - setHolderPriority
```
public void setHolderPriority(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 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(String baseInterfaceInstanceId)
```
    Sets the service interface instance this instance derives from.
    
    Parameters:
    
    baseInterfaceInstanceId - the identifier of the service interface instance this instance derives from, or null if this instance does not derives from any service interface instance.
    
    Since:
    
    10.2.0
  - serialize
```
public void serialize(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                      OutputStream outputStream)
               throws PortalException
```
    Throws:
    
    PortalException
  - deserialize
```
public void deserialize(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(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:
    
    IllegalArgumentException - in case the owner is null
    
    Since:
    
    6.0.0
    
    See Also:
    
    IServiceInterfaceInstanceOwner

Class ServiceInterfaceInstanceConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRINT_INTERFACE_INHERIT

PRINT_INTERFACE_YES

PRINT_INTERFACE_NO

RENDER_AS_INHERIT

ENABLE_CACHE_INHERIT

CACHE_LEVEL_INHERIT

CACHE_PERSONALIZATION_INHERIT

CACHE_SERVER_SIDE_INCLUDE_NO

CACHE_SERVER_SIDE_INCLUDE_YES

CACHE_SERVER_SIDE_INCLUDE_INHERIT

RENDER_DISABLED

Constructor Detail

ServiceInterfaceInstanceConfig

ServiceInterfaceInstanceConfig

Method Detail

clone

getId

setId

isInterfaceHolder

getServiceInterfaceId

setServiceInterfaceId

getServiceInstanceId

setServiceInstanceId

getServiceInterfaceStyleId

setServiceInterfaceStyleId

getPageId

setPageId

getParentInterfaceInstanceId

setParentInterfaceInstanceId

isCreatedRunTime

setCreatedRunTime

getDisplayName

setDisplayName

getTitle

setTitle

getColspan

setColspan

getHeight

setHeight

getPrintable

setPrintable

getPaddingBottom

setPaddingBottom

getPaddingLeft

setPaddingLeft

getPaddingRight

setPaddingRight

getPaddingTop

setPaddingTop

getRowspan

setRowspan

getWidth

setWidth

getHolderPriority

setHolderPriority

getRenderAs

setRenderAs

getEnableCache

setEnableCache

getCacheLevel

setCacheLevel

getCachePersonalization

setCachePersonalization

getCacheServerSideInclude

setCacheServerSideInclude

isShowTitleBar

setShowTitleBar

isInContextEditDisabled

setDisableInContextEdit

getBaseInterfaceInstanceId

setBaseInterfaceInstanceId

serialize

deserialize

isIdentical