Package org.opencms.ade.sitemap.shared

Class CmsClientSitemapEntry

java.lang.Object
org.opencms.ade.sitemap.shared.CmsClientSitemapEntry
All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
public class CmsClientSitemapEntry extends Object implements com.google.gwt.user.client.rpc.IsSerializable
Sitemap entry data.

Since:
8.0.0

  • Field Details

  • Constructor Details

  • Method Details

    • addSubEntry

      public void addSubEntry(CmsClientSitemapEntry entry, I_CmsSitemapController controller)
      Adds the given entry to the children.

      Parameters:
      entry - the entry to add
      controller - a sitemap controller instance

    • getAliases

      public List<String> getAliases()
      Returns the aliases.

      Returns:
      the aliases

    • getChildrenLoadedInitially

      public boolean getChildrenLoadedInitially()
      Returns true if this item's children have been loaded initially.

      Returns:
      true if this item's children have been loaded initially

    • getDateExpired

      public String getDateExpired()
      Returns the expiration date.

      Returns:
      the expiration date

    • getDateReleased

      public String getDateReleased()
      Returns the release date.

      Returns:
      the release date

    • getDefaultFileId

      public CmsUUID getDefaultFileId()
      Gets the default file id.

      Returns:
      the default file id, or null if there is no detail page

    • getDefaultFileProperties

      public Map<String,CmsClientProperty> getDefaultFileProperties()
      Returns the properties for the default file.

      Returns:
      the properties for the default file

    • getDefaultFileType

      public String getDefaultFileType()
      Returns the default file resource type name.

      Returns:
      the default file resource type name

    • getDetailpageTypeName

      public String getDetailpageTypeName()
      Returns the detail resource type name.

      Returns:
      the detail resource type name

    • getEntryType

      public CmsClientSitemapEntry.EntryType getEntryType()
      Returns the entry type.

      Returns:
      the entry type

    • getExportName

      public String getExportName()
      Returns the cached export name for this entry.

      Returns:
      the cached export name for this entry

    • getId

      public CmsUUID getId()
      Returns the id.

      Returns:
      the id

    • getLock

      public CmsClientLock getLock()
      Returns the lock of the entry resource.

      Returns:
      the lock of the entry resource

    • getName

      public String getName()
      Returns the name.

      Returns:
      the name

    • getNavModeIcon

      public String getNavModeIcon()
      Returns the nav mode icon style classes.

      Returns:
      the nav mode icon style classes

    • getNoEditReason

      public String getNoEditReason()
      Returns the no edit reason.

      Returns:
      the no edit reason

    • getOwnProperties

      public Map<String,CmsClientProperty> getOwnProperties()
      Returns the properties for the entry itself.

      Returns:
      the properties for the entry itself

    • getPosition

      public int getPosition()
      Returns the position.

      Returns:
      the position

    • getPropertyValue

      public String getPropertyValue(String propertyName)
      Returns the property value or null if not set.

      Parameters:
      propertyName - the property name
      Returns:
      the property value

    • getRedirectTarget

      public String getRedirectTarget()
      Returns the redirect target.

      Returns:
      the redirect target

    • getResourceState

      public CmsResourceState getResourceState()
      Returns the resource state.

      Returns:
      the resource state

    • getResourceTypeId

      public int getResourceTypeId()
      Returns the resource type id.

      Returns:
      the resource type id

    • getResourceTypeName

      public String getResourceTypeName()
      Returns the resource type name.

      Returns:
      the resource type name

    • getSitePath

      public String getSitePath()
      Returns the sitemap path.

      Returns:
      the sitemap path

    • getSubEntries

      public List<CmsClientSitemapEntry> getSubEntries()
      Returns the children.

      Returns:
      the children

    • getTitle

      public String getTitle()
      Returns the title.

      Returns:
      the title

    • getVfsModeIcon

      public String getVfsModeIcon()
      Returns the vfs mode icon style classes.

      Returns:
      the vfs mode icon style classes

    • getVfsPath

      public String getVfsPath()
      Returns the vfs path.

      Returns:
      the vfs path

    • hasBlockingLockedChildren

      public boolean hasBlockingLockedChildren()
      Returns if this entry has blocking locked children.

      Returns:
      true if this entry has blocking locked children

    • hasForeignFolderLock

      public boolean hasForeignFolderLock()
      Returns if the entry folder is locked by another user.

      Returns:
      true if the entry folder is locked by another user

    • initialize

      public void initialize(I_CmsSitemapController controller)
      Initializes this sitemap entry.

      Parameters:
      controller - a sitemap controller instance

    • initializeAll

      public void initializeAll(I_CmsSitemapController controller)
      Initializes this sitemap entry and its descendants.

      Parameters:
      controller - the controller instance with which to initialize the entries

    • insertSubEntry

      public void insertSubEntry(CmsClientSitemapEntry entry, int position, I_CmsSitemapController controller)
      Inserts the given entry at the given position.

      Parameters:
      entry - the entry to insert
      position - the position
      controller - a sitemap controller instance

    • isDefaultFileReleased

      public boolean isDefaultFileReleased()
      Returns the default file is released and not expired flag.

      Returns:
      the default file is released and not expired flag

    • isEditable

      public boolean isEditable()
      Returns if the current lock state allows editing.

      Returns:
      true if the resource is editable

    • isFolderDefaultPage

      public boolean isFolderDefaultPage()
      Returns if the entry is the folder default page.

      Returns:
      if the entry is the folder default page

    • isFolderType

      public boolean isFolderType()
      Returns if this entry is of type folder.

      Returns:
      true if this entry is of type folder

    • isHiddenNavigationEntry

      public boolean isHiddenNavigationEntry()
      Returns if this is a hidden navigation entry.

      Returns:
      true if this is a hidden navigation entry

    • isInNavigation

      public boolean isInNavigation()
      Returns if the entry is visible in navigation.

      Returns:
      true if the entry is visible in navigation

    • isLeafType

      public boolean isLeafType()
      Returns if this entry is of type leaf.

      Returns:
      true if this entry is of type leaf

    • isNavigationLevelType

      public boolean isNavigationLevelType()
      Returns if this entry is of type folder.

      Returns:
      true if this entry is of type folder

    • isNew

      public boolean isNew()
      Returns the "new" flag of the sitemap entry.

      Returns:
      the "new" flag

    • isResleasedAndNotExpired

      public boolean isResleasedAndNotExpired()
      Returns if the resource is released and not expired.

      Returns:
      true if the resource is released and not expired

    • isRoot

      public boolean isRoot()
      Returns true if this entry is the root entry of the sitemap.

      Returns:
      true if this entry is the root entry of the sitemap

    • isSubSitemapType

      public boolean isSubSitemapType()
      Returns if this entry is of type sub-sitemap.

      Returns:
      true if this entry is of type sub-sitemap

    • normalizeProperties

      public void normalizeProperties()
      Removes empty properties.

    • removeSubEntry

      public CmsClientSitemapEntry removeSubEntry(CmsUUID entryId)
      Removes the child at the given position.

      Parameters:
      entryId - the id of the child to remove
      Returns:
      the removed child

    • removeSubEntry

      public CmsClientSitemapEntry removeSubEntry(int position)
      Removes the child at the given position.

      Parameters:
      position - the index of the child to remove
      Returns:
      the removed child

    • setAliases

      public void setAliases(List<String> aliases)
      Sets the aliases.

      Parameters:
      aliases - the aliases to set

    • setBlockingLockedChildren

      public void setBlockingLockedChildren(boolean hasBlockingLockedChildren)
      Sets if the entry resource has blocking locked children that can not be locked by the current user.

      Parameters:
      hasBlockingLockedChildren - true if the entry resource has blocking locked children

    • setChildrenLoadedInitially

      public void setChildrenLoadedInitially(boolean childrenLoaded)
      Sets the 'children loaded initially' flag.

      Parameters:
      childrenLoaded - true if children are loaded initially

    • setDateExpired

      public void setDateExpired(String dateExpired)
      Sets the expiration date.

      Parameters:
      dateExpired - the expiration date to set

    • setDateReleased

      public void setDateReleased(String dateReleased)
      Sets the release date.

      Parameters:
      dateReleased - the release date to set

    • setDefaultFileId

      public void setDefaultFileId(CmsUUID defaultFileId)
      Sets the default file id.
      Parameters:
      defaultFileId - the new default file id

    • setDefaultFileProperties

      public void setDefaultFileProperties(Map<String,CmsClientProperty> properties)
      Sets the properties for the default file.

      Parameters:
      properties - the properties for the default file

    • setDefaultFileReleased

      public void setDefaultFileReleased(boolean defaultFileReleased)
      Sets the default file is released and not expired flag.

      Parameters:
      defaultFileReleased - the default file is released and not expired flag to set

    • setDefaultFileType

      public void setDefaultFileType(String defaultFileType)
      Sets the default file resource type name.

      Parameters:
      defaultFileType - the default file resource type name to set

    • setDetailpageTypeName

      public void setDetailpageTypeName(String detailpageTypeName)
      Sets the detail resource type name.

      Parameters:
      detailpageTypeName - the detail resource type name

    • setEntryType

      public void setEntryType(CmsClientSitemapEntry.EntryType entryType)
      Sets the entry type.

      Parameters:
      entryType - the entry type to set

    • setExportName

      public void setExportName(String exportName)
      Sets the export name for this entry.

      Parameters:
      exportName - the export name for this entry

    • setFolderDefaultPage

      public void setFolderDefaultPage(boolean isFolderDefaultPage)
      Sets if the entry is the folder default page.

      Parameters:
      isFolderDefaultPage - the isFolderDefaultPage to set

    • setHasForeignFolderLock

      public void setHasForeignFolderLock(boolean hasForeignFolderLock)
      Sets if the entry folder is locked by another user.

      Parameters:
      hasForeignFolderLock - set true if the entry folder is locked by another user

    • setId

      public void setId(CmsUUID id)
      Sets the id.

      Parameters:
      id - the id to set

    • setInNavigation

      public void setInNavigation(boolean inNavigation)
      Sets the entry visibility in navigation.

      Parameters:
      inNavigation - set true for entries visible in navigation

    • setLock

      public void setLock(CmsClientLock lock)
      Sets the lock of the entry resource.

      Parameters:
      lock - the lock of the entry resource to set

    • setName

      public void setName(String name)
      Sets the name.

      Parameters:
      name - the name to set

    • setNavModeIcon

      public void setNavModeIcon(String iconClasses)
      Sets the nav mode icon style classes.

      Parameters:
      iconClasses - the nav mode icon style classes to set

    • setNew

      public void setNew(boolean isNew)
      Sets the "new" flag of the client sitemap entry.

      Parameters:
      isNew - the new new

    • setOwnProperties

      public void setOwnProperties(Map<String,CmsClientProperty> properties)
      Sets the properties for the entry itself.

      Parameters:
      properties - the properties for the entry itself

    • setPermissionInfo

      public void setPermissionInfo(CmsPermissionInfo permissionInfo)
      Sets the permission info.

      Parameters:
      permissionInfo - the permission info to set

    • setPosition

      public void setPosition(int position)
      Sets the position.

      Parameters:
      position - the position to set

    • setRedirectTarget

      public void setRedirectTarget(String redirectTarget)
      Sets the redirect target.

      Parameters:
      redirectTarget - the redirect target to set

    • setResleasedAndNotExpired

      public void setResleasedAndNotExpired(boolean isResleasedAndNotExpired)
      Sets the resource is released and not expired flag.

      Parameters:
      isResleasedAndNotExpired - the resource is released and not expired flag

    • setResourceState

      public void setResourceState(CmsResourceState resourceState)
      Sets the resource state.

      Parameters:
      resourceState - the resource state to set

    • setResourceTypeId

      public void setResourceTypeId(int resourceTypeId)
      Sets the resource type id.

      Parameters:
      resourceTypeId - the resource type id

    • setResourceTypeName

      public void setResourceTypeName(String typeName)
      Sets the resource type name.

      Parameters:
      typeName - the resource type name

    • setSitePath

      public void setSitePath(String sitepath)
      Sets the site path.

      Parameters:
      sitepath - the site path to set

    • setSubEntries

      public void setSubEntries(List<CmsClientSitemapEntry> children, I_CmsSitemapController controller)
      Sets the children.

      Parameters:
      children - the children to set
      controller - a sitemap controller instance

    • setVfsModeIcon

      public void setVfsModeIcon(String iconClasses)
      Sets the vfs mode icon style classes.

      Parameters:
      iconClasses - the vfs mode icon style classes to set

    • setVfsPath

      public void setVfsPath(String path)
      Sets the VFS path.

      Parameters:
      path - the path to set

    • toString

      public String toString()
      To string.
      Overrides:
      toString in class Object
      Returns:
      the string
      See Also:

    • update

      public void update(CmsClientSitemapEntry source)
      Updates all entry properties apart from it's position-info and sub-entries.

      Parameters:
      source - the source entry to update from

    • updateSitePath

      public void updateSitePath(String sitepath, I_CmsSitemapController controller)
      Updates the entry's site path and the name accordingly.

      Parameters:
      sitepath - the new site path to set
      controller - a sitemap controller instance