Package com.axemble.vdoc.sdk.interfaces

Interface IAlias

All Superinterfaces:
IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport, ISeoSupport, IUriSupport, Serializable
All Known Implementing Classes:
EzsAlias
public interface IAlias extends IElement, IDeletionSupport, ISecuritySupport, IUriSupport, IProtocolSupport, ISeoSupport
This interface represents an alias on any element.
Since:
2.1
Version:
1.0, 16/06/2009
Author:
vlygeros

  • Method Details

    • getName

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

    • setName

      void setName(String name)
      Sets the name of the alias.
      Parameters:
      name - The name to set the alias with.

    • getLabel

      String getLabel()
      Gets the label of the alias.
      Returns:
      The label of the alias.

    • setLabel

      void setLabel(String label)
      Sets the label of the alias.
      Parameters:
      label - the new label to set.

    • getDescription

      String getDescription()
      Gets the description of the alias.
      Returns:
      a java.lang.String of the alias.

    • setDescription

      void setDescription(String description)
      Sets the description of the alias.
      Parameters:
      description - the new description to set.

    • getDigest

      String getDigest()
      Gets the digest of the alias.
      Returns:
      A java.lang.String value.

    • setDigest

      void setDigest(String digest)
      Sets the digest of the alias.
      Parameters:
      digest - The digest of the alias to set.

    • getTarget

      IElement getTarget()
      Gets the target as an IElement object.
      Returns:
      A IElement 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 alias is active.
      Returns:
      true if the alias is active, false otherwise.

    • setActive

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

    • isIncludedToIndex

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

    • includeToIndex

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

    • isIncludedToStats

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

    • includeToStats

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