Package com.saperion.ngc.model.navigation.intf

Interface FolderInfo

  • All Known Implementing Classes:
    ClassicConnectorFolderInfo
    public interface FolderInfo
    Defines a class that holds information about a folder (metadata).

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getFolderClassName()
      Returns the name of the folder class of this folder or null if the folder does not have a class.
      FolderId getFolderId()  
      java.lang.String getFolderName()  
      java.lang.String getFolderPath()  
      java.lang.String getPropertyAsString​(java.lang.String propertyName)
      Returns the specified propertie's value as a string or null if the value is not available.
      com.saperion.constants.SaFolderConstants.FOLDER_TYPE getType()  
      com.saperion.intf.SaPropertyValue getValue​(java.lang.String valueName)
      Returns the value with the specified name.
      com.saperion.intf.SaPropertyValue[] getValues()
      Returns all index values of the folder.
      boolean hasValue​(java.lang.String valueName)
      Returns true if the folder has an index value with the specified name.

    • Method Detail

      • getPropertyAsString

        java.lang.String getPropertyAsString​(java.lang.String propertyName)
        Returns the specified propertie's value as a string or null if the value is not available.
        Parameters:
        propertyName - property name
        Returns:
        value as string or null

      • getFolderClassName

        java.lang.String getFolderClassName()
        Returns the name of the folder class of this folder or null if the folder does not have a class.
        Returns:
        folder class name

      • hasValue

        boolean hasValue​(java.lang.String valueName)
        Returns true if the folder has an index value with the specified name.
        Parameters:
        valueName - value name
        Returns:
        true if value is present, otherwise false

      • getValue

        com.saperion.intf.SaPropertyValue getValue​(java.lang.String valueName)
        Returns the value with the specified name.
        Parameters:
        valueName - value name
        Returns:
        the value

      • getValues

        com.saperion.intf.SaPropertyValue[] getValues()
        Returns all index values of the folder.
        Returns:
        array with index values

      • getFolderName

        java.lang.String getFolderName()
        Returns:
        the name of the folder

      • getFolderPath

        java.lang.String getFolderPath()
        Returns:
        the path of the folder