Package de.uplanet.lucy.server.rtcache

Interface PageInfo

  • All Superinterfaces:
    de.uplanet.lucy.server.rtcache.ILanguageConstant, de.uplanet.lucy.server.util.ILanguageConstantOrTitle, de.uplanet.lucy.server.rtcache.IRtInfo, de.uplanet.lucy.server.rtcache.IRtInfoWithTitle
    @Scriptable
public interface PageInfo
extends de.uplanet.lucy.server.rtcache.IRtInfo, de.uplanet.lucy.server.rtcache.IRtInfoWithTitle, de.uplanet.lucy.server.util.ILanguageConstantOrTitle
    Information about pages.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      de.uplanet.lucy.server.property.IClassProperty getActionClass()
      Gets the special action class or null if no special action class was set.
      String getAppGuid()
      Get the unique identifier of the application this page belongs to.
      String getDataGroupGuid()
      Get the data group this page belongs to.
      String getDataGroupGuidOfContainer​(String p_container)  
      String getGuid()
      Get the unique identifier of this page.
      String getName()
      Get the name of this page.
      de.uplanet.lucy.server.property.PagePropertyCollection getProperties()
      Gets the properties of the page
      de.uplanet.lucy.server.rtcache.ReadContainerDefinitionList getReadContainerDefinitions()
      Get the read containers.
      de.uplanet.lucy.server.property.IClassProperty getRenderingClass()
      Gets the special rendering class or null if no special rendering class was set.
      String getScript()
      Get the script.
      String getSysIdent()
      Get the sysIdent.
      de.uplanet.lucy.server.hop.TargetInformation getTarget()
      Gets the target .
      de.uplanet.lucy.constants.FUP_TYPE getType()
      Get the type.
      de.uplanet.lucy.server.rtcache.WriteContainerDefinitionList getWriteContainerDefinitions()
      Get the write containers.
      boolean isEditPage()
      Return if page is an edit page.
      boolean isNavigatable()
      Return if page is navigatable.

      • Methods inherited from interface de.uplanet.lucy.server.rtcache.ILanguageConstant

        getLanguageConstantAppGuid, getLanguageConstantName, getLanguageConstantType, hasLanguageConstant

      • Methods inherited from interface de.uplanet.lucy.server.util.ILanguageConstantOrTitle

        getTitles

      • Methods inherited from interface de.uplanet.lucy.server.rtcache.IRtInfoWithTitle

        getDefaultTitle, getTitle, getTitles

    • Method Detail

      • getGuid

        String getGuid()
        Get the unique identifier of this page.

        This property is never null.

        Returns:
        The unique identifier of this page (not null).

      • getAppGuid

        String getAppGuid()
        Get the unique identifier of the application this page belongs to.

        This property is never null.

        Returns:
        The unique identifier of the application.

      • getDataGroupGuid

        String getDataGroupGuid()
        Get the data group this page belongs to.
        Returns:
        The data group GUID, or null.

      • getName

        String getName()
        Get the name of this page.

        This property is never null.

        Returns:
        The name of this page.

      • getType

        de.uplanet.lucy.constants.FUP_TYPE getType()
        Get the type.
        Returns:
        The type.

      • isEditPage

        boolean isEditPage()
        Return if page is an edit page.
        Returns:
        true, if the page is an edit page, or false otherwise.

      • getSysIdent

        String getSysIdent()
        Get the sysIdent.
        Returns:
        The sysIdent.

      • getScript

        String getScript()
        Get the script.
        Returns:
        The script.

      • isNavigatable

        boolean isNavigatable()
        Return if page is navigatable.
        Returns:
        true, if page is navigatable, or false otherwise.

      • getProperties

        de.uplanet.lucy.server.property.PagePropertyCollection getProperties()
        Gets the properties of the page
        Returns:
        Collection of the page settings

      • getTarget

        de.uplanet.lucy.server.hop.TargetInformation getTarget()
        Gets the target .
        Returns:
        The target info instance.

      • getDataGroupGuidOfContainer

        String getDataGroupGuidOfContainer​(String p_container)
        Parameters:
        p_container - The container GUID
        Returns:
        Returns the data group of the given read or write container or null if not found

      • getReadContainerDefinitions

        de.uplanet.lucy.server.rtcache.ReadContainerDefinitionList getReadContainerDefinitions()
        Get the read containers.
        Returns:
        The read containers associated with the page.

      • getWriteContainerDefinitions

        de.uplanet.lucy.server.rtcache.WriteContainerDefinitionList getWriteContainerDefinitions()
        Get the write containers.
        Returns:
        The write containers associated with the page.

      • getRenderingClass

        de.uplanet.lucy.server.property.IClassProperty getRenderingClass()
        Gets the special rendering class or null if no special rendering class was set.
        Returns:
        The rendering class or null if no rendering class was set

      • getActionClass

        de.uplanet.lucy.server.property.IClassProperty getActionClass()
        Gets the special action class or null if no special action class was set.
        Returns:
        The action class or null if no action class was set