FolderClass (webclient 8.0.0-0 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

ClassicConnectorFolderClass, GenericFolderClass
```
public interface FolderClass
extends 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 and Description
`com.saperion.constants.SaFolderConstants.CLASS_TYPE`	`getClassType()` A folder class can be typed to mark special folders like eFiles, registers and so on.
`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.
`String`	`getFolderDDC()` Returns the folder DDC name for this class.
`String`	`getFormNameForType(FolderFormType type)` A folder can use several forms for different operations (like index, query, edit...).
`String`	`getName()` Returns the full name of the folder class.
`String`	`getShortName()` Returns the short name of the folder class.
`String`	`getSysRowId()` Returns the sysRowId of the folder class.
`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
```
String getSysRowId()
```
    Returns the sysRowId of the folder class.
    
    Returns:
    
    SysRowId
  - getName
```
String getName()
```
    Returns the full name of the folder class.
    
    Returns:
    
    full class name
  - getShortName
```
String getShortName()
```
    Returns the short name of the folder class.
    
    Returns:
    
    short class name
  - getFolderDDC
```
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
```
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
```
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
```
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

Interface FolderClass

Method Summary

Method Detail

getSysRowId

getName

getShortName

getFolderDDC

getFieldsToDisplay

getFormNameForType

getClassType

isEmbedded

getWorkflowName

getDocumentDDCName