com.saperion.ngc.model.navigation

Class GenericFolderClass

java.lang.Object

com.saperion.ngc.model.navigation.GenericFolderClass

All Implemented Interfaces:

FolderClass, Serializable

public class GenericFolderClass
extends Object
implements FolderClass

Author:

rbo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenericFolderClass(NavigationNode modelNode) Constructor.
GenericFolderClass(String queryMask) Constructor.

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericFolderClass

public GenericFolderClass(NavigationNode modelNode)

Constructor.

Parameters:

modelNode - Model node

GenericFolderClass

public GenericFolderClass(String queryMask)

Constructor.

Parameters:

queryMask - Query mask name

Method Detail

getSysRowId

public String getSysRowId()

Returns the sysRowId of the folder class.

Specified by:

getSysRowId in interface FolderClass

Returns:

SysRowId

See Also:

FolderClass.getSysRowId()

getName

public String getName()

Returns the full name of the folder class.

Specified by:

getName in interface FolderClass

Returns:

full class name

See Also:

FolderClass.getName()

getShortName

public String getShortName()

Returns the short name of the folder class.

Specified by:

getShortName in interface FolderClass

Returns:

short class name

See Also:

FolderClass.getShortName()

getFolderDDC

public String getFolderDDC()

Returns the folder DDC name for this class.

Specified by:

getFolderDDC in interface FolderClass

Returns:

Folder DDC

See Also:

FolderClass.getFolderDDC()

getFieldsToDisplay

public com.saperion.ngc.iform.xml.ResultType getFieldsToDisplay()

A folder class contains a list of index fields that should be displayed in the navigation view.

Specified by:

getFieldsToDisplay in interface FolderClass

Returns:

Result type for fields

See Also:

FolderClass.getFieldsToDisplay()

getFormNameForType

public String getFormNameForType(FolderFormType type)

A folder can use several forms for different operations (like index, query, edit...).

Specified by:

getFormNameForType in interface FolderClass

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

See Also:

FolderClass.getFormNameForType(FolderFormType)

getClassType

public com.saperion.constants.SaFolderConstants.CLASS_TYPE getClassType()

A folder class can be typed to mark special folders like eFiles, registers and so on.

Specified by:

getClassType in interface FolderClass

Returns:

class type

See Also:

FolderClass.getClassType()

isEmbedded

public 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.

Specified by:

isEmbedded in interface FolderClass

Returns:

embedded flag

See Also:

FolderClass.isEmbedded()

getWorkflowName

public 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.

Specified by:

getWorkflowName in interface FolderClass

Returns:

workflow name or null if not available

See Also:

FolderClass.getWorkflowName()

getDocumentDDCName

public String getDocumentDDCName()

Returns the name of the DDC that contains the documents of an eFile- or outliner-application.

Specified by:

getDocumentDDCName in interface FolderClass

Returns:

document-dcc-name or null if not set

See Also:

FolderClass.getDocumentDDCName()