Interface IFileStructureElement

  • All Superinterfaces:
    IFileElement
    All Known Implementing Classes:
    Channel, ChannelResume, Page, ServiceInstance

    public interface IFileStructureElement
    extends IFileElement
    A structure element that is the root of a structure file.
    Since:
    6.2.0
    Version:
    $Revision: 14187 $ $Date: 2012-04-02 11:44:41 -0300 (Mon, 02 Apr 2012) $
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDirectoryChannelId()
      Returns the identifier of the channel that corresponds to the directory this element's file resides in.
      java.lang.String getId()
      Returns the element's identifier.
      java.lang.String getStructureFileName()
      Returns the name of the structure file for this element.
      void setFriendlyId​(java.lang.String friendlyId)
      Sets the friendly identifier for this structure element.
    • Method Detail

      • getId

        java.lang.String getId()
        Returns the element's identifier.
        Returns:
        the element's identifier.
        Since:
        6.2.0
      • getDirectoryChannelId

        java.lang.String getDirectoryChannelId()
        Returns the identifier of the channel that corresponds to the directory this element's file resides in.
        Returns:
        the identifier of the channel.
        Since:
        6.2.0
      • getStructureFileName

        java.lang.String getStructureFileName()
        Returns the name of the structure file for this element.
        Returns:
        the structure file name (only the file's name, does not include any path).
        Since:
        6.2.0
      • setFriendlyId

        void setFriendlyId​(java.lang.String friendlyId)
        Sets the friendly identifier for this structure element.
        Parameters:
        friendlyId - the friendly identifier.
        Since:
        6.2.0