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

Interface FolderClass

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    ClassicConnectorFolderClass, GenericFolderClass
    public interface FolderClass
extends java.io.Serializable
    Defines a folder class that holds information about a folder like the forms used and the fields visible in the navigation view.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.saperion.constants.SaFolderConstants.CLASS_TYPE getClassType()
      A folder class can be typed to mark special folders like eFiles, registers and so on.
      java.lang.String getDocumentDDCName()
      Returns the name of the DDC that contains the documents of an eFile- or outliner-application.
      com.saperion.ngc.iform.xml.ResultType getFieldsToDisplay()
      A folder class contains a list of index fields that should be displayed in the navigation view.
      java.lang.String getFolderDDC()
      Returns the folder DDC name for this class.
      java.lang.String getFormNameForType​(FolderFormType type)
      A folder can use several forms for different operations (like index, query, edit...).
      java.lang.String getName()
      Returns the full name of the folder class.
      java.lang.String getShortName()
      Returns the short name of the folder class.
      java.lang.String getSysRowId()
      Returns the sysRowId of the folder class.
      java.lang.String getWorkflowName()
      Returns the name of the workflow definition to start when a new eFile is created.
      boolean isEmbedded()
      If this method returns true, the masks for DOCUMENT_NEW, EFILE_NEW and EFILE_QUERY need to be displayed as embedded masks in the navigation view.

    • Method Detail

      • getSysRowId

        java.lang.String getSysRowId()
        Returns the sysRowId of the folder class.
        Returns:
        SysRowId

      • getName

        java.lang.String getName()
        Returns the full name of the folder class.
        Returns:
        full class name

      • getShortName

        java.lang.String getShortName()
        Returns the short name of the folder class.
        Returns:
        short class name

      • getFolderDDC

        java.lang.String getFolderDDC()
        Returns the folder DDC name for this class.
        Returns:
        Folder DDC

      • getFieldsToDisplay

        com.saperion.ngc.iform.xml.ResultType getFieldsToDisplay()
        A folder class contains a list of index fields that should be displayed in the navigation view.
        Returns:
        Result type for fields

      • getFormNameForType

        java.lang.String getFormNameForType​(FolderFormType type)
        A folder can use several forms for different operations (like index, query, edit...).
        Parameters:
        type - operation type
        Returns:
        name of the form for the specified operation type or null if no form for the specified type is defined

      • getClassType

        com.saperion.constants.SaFolderConstants.CLASS_TYPE getClassType()
        A folder class can be typed to mark special folders like eFiles, registers and so on.
        Returns:
        class type

      • isEmbedded

        boolean isEmbedded()
        If this method returns true, the masks for DOCUMENT_NEW, EFILE_NEW and EFILE_QUERY need to be displayed as embedded masks in the navigation view.
        Returns:
        embedded flag

      • getWorkflowName

        java.lang.String getWorkflowName()
        Returns the name of the workflow definition to start when a new eFile is created. The definition will initiate the cloning of the eFile template defined in the definiton.
        Returns:
        workflow name or null if not available

      • getDocumentDDCName

        java.lang.String getDocumentDDCName()
        Returns the name of the DDC that contains the documents of an eFile- or outliner-application.
        Returns:
        document-dcc-name or null if not set