Package com.axemble.vdoc.sdk.interfaces

Interface IContentContainer

All Superinterfaces:
IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport, IUriSupport, Serializable
All Known Subinterfaces:
IBlockTemplateContainer, IPageContainer, ISharedBlockContainer
All Known Implementing Classes:
com.axemble.vdoc.sdk.impl.base.BaseContentContainer, EzsBlockTemplateContainer, EzsPageContainer, EzsSharedBlockContainer
public interface IContentContainer extends IElement, ISecuritySupport, IDeletionSupport, IUriSupport, IProtocolSupport
This interface represents the base content container.
Since:
2.1
Version:
1.0, 16/06/2009
Author:
vlygeros

  • Method Details

    • getName

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

    • getLabel

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

    • setLabel

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

    • getDescription

      String getDescription()
      Gets the description of the container.
      Returns:
      a String of the container.

    • setDescription

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

    • getStatus

      int getStatus()
      Gets the status of the content container.
      Returns:
      An int value.

    • getContents

      Collection getContents()
      Retrieves the available contents.
      Returns:
      A java.util.Collection of IContent objects.

    • getContent

      IContent getContent(int status)
      Retrieves a IContent by the IContentContainer.IStatus.
      Parameters:
      status - The status to search with.
      Returns:
      A IContent object.

    • getSite

      ISite getSite()
      Gets the site of the content.
      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 content container is active.
      Returns:
      true if the content container is active, false otherwise.

    • setActive

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

    • isIncludedToIndex

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

    • includeToIndex

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

    • isIncludedToStats

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

    • includeToStats

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