Class ServiceInterfaceInstanceConfig

    • Constructor Detail

      • ServiceInterfaceInstanceConfig

        public ServiceInterfaceInstanceConfig()
      • ServiceInterfaceInstanceConfig

        public ServiceInterfaceInstanceConfig​(ServiceInterfaceInstanceConfig copy)
                                       throws java.lang.Exception
        Throws:
        java.lang.Exception
    • Method Detail

      • 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, or null if this instance does not derives from any service interface instance.
        Since:
        10.2.0
      • 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
      • 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