|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object lumis.portal.serviceinterfaceinstance.ServiceInterfaceInstanceConfig
@StableMinor(version="6.2", sinceVersion="4.0") public class ServiceInterfaceInstanceConfig
Holds the data about a service interface instance.
Field Summary | |
---|---|
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
|
Constructor Summary | |
---|---|
ServiceInterfaceInstanceConfig()
|
|
ServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig copy)
|
Method Summary | |
---|---|
ServiceInterfaceInstanceConfig |
clone()
|
void |
deserialize(Node serviceInterfaceInstanceNode)
|
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 |
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 |
---|
public static final int PRINT_INTERFACE_INHERIT
public static final int PRINT_INTERFACE_YES
public static final int PRINT_INTERFACE_NO
public static final int RENDER_AS_INHERIT
public static final int ENABLE_CACHE_INHERIT
public static final int CACHE_LEVEL_INHERIT
public static final int CACHE_PERSONALIZATION_INHERIT
public static final int CACHE_SERVER_SIDE_INCLUDE_NO
public static final int CACHE_SERVER_SIDE_INCLUDE_YES
public static final int CACHE_SERVER_SIDE_INCLUDE_INHERIT
Constructor Detail |
---|
public ServiceInterfaceInstanceConfig()
public ServiceInterfaceInstanceConfig(ServiceInterfaceInstanceConfig copy) throws Exception
Exception
Method Detail |
---|
public ServiceInterfaceInstanceConfig clone() throws CloneNotSupportedException
clone
in interface ICloneableCacheEntry
clone
in interface ICloneableConfig<ServiceInterfaceInstanceConfig>
clone
in class Object
CloneNotSupportedException
public String getId()
public void setId(String id)
id
- The id to set.public boolean isInterfaceHolder()
public String getServiceInterfaceId()
public void setServiceInterfaceId(String interfaceId)
serviceInterfaceId
- The serviceInterfaceId to set.public String getServiceInstanceId()
public void setServiceInstanceId(String serviceInstanceId)
serviceInstanceId
- The serviceInstanceId to set.public String getServiceInterfaceStyleId()
public void setServiceInterfaceStyleId(String styleId)
serviceInterfaceStyleId
- The serviceInterfaceStyleId to set.public String getPageId()
public void setPageId(String pageId)
#setOrphan(String)
.
pageId
- The pageId to set.public String getParentInterfaceInstanceId()
public void setParentInterfaceInstanceId(String parentInterfaceInstanceId)
public boolean isCreatedRunTime()
public void setCreatedRunTime(boolean isCreatedRunTime)
createdRunTime
- public String getDisplayName()
The display name is usually the name used for referring to the service interface instance for a developer or administrator.
public void setDisplayName(String displayName)
displayName
- the display name.getDisplayName()
public String getTitle()
public void setTitle(String title)
public Integer getColspan()
public void setColspan(Integer colspan)
public String getHeight()
public void setHeight(String height)
public int getPrintable()
public void setPrintable(int printable)
public String getPaddingBottom()
public void setPaddingBottom(String paddingBottom)
public String getPaddingLeft()
public void setPaddingLeft(String paddingLeft)
public String getPaddingRight()
public void setPaddingRight(String paddingRight)
public String getPaddingTop()
public void setPaddingTop(String paddingTop)
public Integer getRowspan()
public void setRowspan(Integer rowspan)
public String getWidth()
public void setWidth(String width)
public Integer getHolderPriority()
public void setHolderPriority(Integer holderPriority)
public int getRenderAs()
public void setRenderAs(int renderAs)
renderAs
- The renderAs to set.public int getEnableCache()
public void setEnableCache(int enableCache)
enableCache
- The enableCache to set.public int getCacheLevel()
public void setCacheLevel(int cacheLevel)
cacheLevel
- The cacheLevel to set.public int getCachePersonalization()
public void setCachePersonalization(int cachePersonalization)
cachePersonalization
- The cachePersonalization to set.public int getCacheServerSideInclude()
public void setCacheServerSideInclude(int cacheServerSideInclude)
cacheServerSideInclude
- The cacheServerSideInclude to set.public boolean isShowTitleBar()
public void setShowTitleBar(boolean showTitleBar)
public boolean isInContextEditDisabled()
public void setDisableInContextEdit(boolean disableInContextEdit)
public void serialize(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, OutputStream outputStream) throws PortalException
PortalException
public void deserialize(Node serviceInterfaceInstanceNode) throws PortalException
PortalException
public boolean isIdentical(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)
ServiceInterfaceInstanceConfig
- the object to compare the properties with.
public IServiceInterfaceInstanceOwner getOwner() throws PortalException
PortalException
public void setOrphan(Class<? extends IServiceInterfaceInstanceOwner> ownerClass)
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.
ownerClass
- the owner class of the orphan interface instance.
IllegalArgumentException
- in case the owner is nullIServiceInterfaceInstanceOwner
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |