SaFolderClass (JCS Classic Connector Module 8.2.0-0 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

SaFolderClassImpl
```
public interface SaFolderClass
extends Serializable
```
Folder class interface.

Author:

rbo

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getApplicationFormName(SaApplicationInfo.ApplicationType type)` Reads the application form name for the given type.
`Map<SaApplicationInfo.ApplicationType,SaApplicationInfo>`	`getApplicationInfos()` Reads all application informations.
`SaFolderClassBean`	`getBean()` Reads the folder class bean.
`SaFolderConstants.CLASS_TYPE`	`getClassType()` Reads the folder class type.
`String`	`getDocumentDDCName()` Returns the name of the document DDC.
`String`	`getFolderDDCName()` Reads the folder name for this class.
`String`	`getName()`
`ResultType`	`getNaviDisplayFields()` Reads the navigation display fields.
`String`	`getNaviDisplayFieldsXML()` Reads the navigation display fields.
`String`	`getShortName()`
`String`	`getSysRowId()`
`String`	`getWorkflowName()` Returns the name of the workflow to be started when a new eFile is created.
`boolean`	`isEmbedded()` If true, the masks used for `DOCUMENT_NEW`, `EFILE_NEW` and `EFILE_QUERY` have to be displayed as embedded masks in the navigation view.
`boolean`	`isInherited(SaApplicationInfo.ApplicationType type)` Reads, if the application type is inherited.

- Method Detail
  - getSysRowId
```
String getSysRowId()
```
    Returns:
    
    SysRowId
  - getShortName
```
String getShortName()
```
    Returns:
    
    Class short name
  - getName
```
String getName()
```
    Returns:
    
    Class name
  - getApplicationFormName
```
String getApplicationFormName(SaApplicationInfo.ApplicationType type)
```
    Reads the application form name for the given type.
    
    Parameters:
    
    type - Application type
    
    Returns:
    
    Form name
  - isInherited
```
boolean isInherited(SaApplicationInfo.ApplicationType type)
```
    Reads, if the application type is inherited.
    
    Parameters:
    
    type - Application type
    
    Returns:
    
    True, if it is inherited
  - getApplicationInfos
```
Map<SaApplicationInfo.ApplicationType,SaApplicationInfo> getApplicationInfos()
```
    Reads all application informations.
    
    Returns:
    
    Application infos
  - getNaviDisplayFieldsXML
```
String getNaviDisplayFieldsXML()
```
    Reads the navigation display fields.
    
    Returns:
    
    Navigation display fields XML
  - getNaviDisplayFields
```
ResultType getNaviDisplayFields()
```
    Reads the navigation display fields.
    
    Returns:
    
    Navigation display fields result type
  - getFolderDDCName
```
String getFolderDDCName()
```
    Reads the folder name for this class.
    
    Returns:
    
    Folder name
  - getDocumentDDCName
```
String getDocumentDDCName()
```
    Returns the name of the document DDC.
    
    Returns:
    
    name of the document ddc
  - getWorkflowName
```
String getWorkflowName()
```
    Returns the name of the workflow to be started when a new eFile is created.
    
    Returns:
    
    workflow name for new eFiles
  - getBean
```
SaFolderClassBean getBean()
```
    Reads the folder class bean.
    
    Returns:
    
    Folder class bean
  - getClassType
```
SaFolderConstants.CLASS_TYPE getClassType()
```
    Reads the folder class type.
    
    Returns:
    
    Folder class type
  - isEmbedded
```
boolean isEmbedded()
```
    If true, the masks used for DOCUMENT_NEW, EFILE_NEW and EFILE_QUERY have to be displayed as embedded masks in the navigation view.
    
    Returns:
    
    true, if embedded flag is set

Interface SaFolderClass

Method Summary

Method Detail

getSysRowId

getShortName

getName

getApplicationFormName

isInherited

getApplicationInfos

getNaviDisplayFieldsXML

getNaviDisplayFields

getFolderDDCName

getDocumentDDCName

getWorkflowName

getBean

getClassType

isEmbedded