Package com.axemble.vdoc.sdk.interfaces

Interface ITopic

All Superinterfaces:
IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport, ISeoSupport, IUriSupport, Serializable
All Known Subinterfaces:
IPlugin
All Known Implementing Classes:
EzsPlugin, EzsTopic
public interface ITopic extends IElement, IDeletionSupport, ISecuritySupport, IUriSupport, IProtocolSupport, ISeoSupport
This class represents a topic.
Since:
2.1
Version:
1.0, 16/06/2009
Author:
vlygeros

  • Method Details

    • getName

      String getName()
      Returns:
      The system name of the topic.

    • getLabel

      String getLabel()
      Returns:
      The label of the topic.

    • isRoot

      boolean isRoot()
      Checks if the current topic is the root.
      Returns:
      true if the topic is the root, otherwise false.

    • isSystem

      boolean isSystem()
      Checks if the current topic is a system topic.
      Returns:
      true if the topic is a system topic, otherwise false.

    • getSite

      ISite getSite()
      Retrieves the site of the topic.
      Returns:
      a ISite object.

    • getActivatedDate

      Date getActivatedDate()
      Gets the activated date.
      Returns:
      A Date object.

    • getExpiredDate

      Date getExpiredDate()
      Gets the expired date.
      Returns:
      A Date object.

    • isActive

      boolean isActive()
      Checks if the topic is active.
      Returns:
      true if the topic is active, false otherwise.

    • setActive

      void setActive(boolean active)
      Allows to activate the topic.
      Parameters:
      active - The active parameter.

    • isIncludedToIndex

      boolean isIncludedToIndex()
      Checks if the topic is included to the index.
      Returns:
      true if the topic is included to the index, false otherwise.

    • includeToIndex

      void includeToIndex(boolean include)
      Allows to include the topic to the index.
      Parameters:
      include - The include parameter.

    • isIncludedToStats

      boolean isIncludedToStats()
      Checks if the topic is included to the statistics.
      Returns:
      true if the topic is included to the statistics, false otherwise.

    • includeToStats

      void includeToStats(boolean include)
      Allows to include the topic to the statistics.
      Parameters:
      include - The include parameter.

    • getParent

      Object getParent()
      Gets the parent object.
      Returns:
      a ISite object if the topic is a root topic, a IFolder object otherwise.