Package com.saperion.ngc.model.navigation

Class ClassicConnectorFolderInfo

java.lang.Object

com.saperion.ngc.model.navigation.ClassicConnectorFolderInfo

All Implemented Interfaces:

FolderInfo

public class ClassicConnectorFolderInfo
extends Object
implements FolderInfo

Implementation of FolderInfo for ClassicConnector.

Constructor Summary

Constructors

Constructor	Description
ClassicConnectorFolderInfo(com.saperion.intf.SaDocumentInfo saDocumentInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getFolderClassName()	Returns the name of the folder class of this folder or null if the folder does not have a class.
FolderId	getFolderId()
String	getFolderName()
String	getFolderPath()
String	getPropertyAsString(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(String valueName)	Returns the value with the specified name.
com.saperion.intf.SaPropertyValue[]	getValues()	Returns all index values of the folder.
boolean	hasValue(String valueName)	Returns true if the folder has an index value with the specified name.

Methods inherited from class java.lang.Object

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

Constructor Details

ClassicConnectorFolderInfo

public ClassicConnectorFolderInfo(com.saperion.intf.SaDocumentInfo saDocumentInfo)

Constructor.

Parameters:

saDocumentInfo - document info retrieved from backend

Method Details

getPropertyAsString

public String getPropertyAsString(String propertyName)

Returns the specified propertie's value as a string or null if the value is not available.

Specified by:

getPropertyAsString in interface FolderInfo

Parameters:

propertyName - property name

Returns:

value as string or null

See Also:

• FolderInfo.getPropertyAsString(java.lang.String)

getFolderClassName

public String getFolderClassName()

Returns the name of the folder class of this folder or null if the folder does not have a class.

Specified by:

getFolderClassName in interface FolderInfo

Returns:

folder class name

See Also:

• FolderInfo.getFolderClassName()

hasValue

public boolean hasValue(String valueName)

Returns true if the folder has an index value with the specified name.

Specified by:

hasValue in interface FolderInfo

Parameters:

valueName - value name

Returns:

true if value is present, otherwise false

See Also:

• FolderInfo.hasValue(java.lang.String)

getValue

public com.saperion.intf.SaPropertyValue getValue(String valueName)

Returns the value with the specified name.

Specified by:

getValue in interface FolderInfo

Parameters:

valueName - value name

Returns:

the value

See Also:

• FolderInfo.getValue(java.lang.String)

getValues

public com.saperion.intf.SaPropertyValue[] getValues()

Returns all index values of the folder.

Specified by:

getValues in interface FolderInfo

Returns:

array with index values

See Also:

• FolderInfo.getValues()

getFolderName

public String getFolderName()

Specified by:

getFolderName in interface FolderInfo

Returns:

the name of the folder

See Also:

• FolderInfo.getFolderName()

getFolderPath

public String getFolderPath()

Specified by:

getFolderPath in interface FolderInfo

Returns:

the path of the folder

See Also:

• FolderInfo.getFolderPath()

getFolderId

public FolderId getFolderId()
                     throws DocumentIdentificationException

Specified by:

getFolderId in interface FolderInfo

Returns:

id of the folder

Throws:

DocumentIdentificationException - when the folder does not contain a unique id

See Also:

• FolderInfo.getFolderId()

getType

public com.saperion.constants.SaFolderConstants.FOLDER_TYPE getType()
                                                             throws UnknownFolderTypeException

Specified by:

getType in interface FolderInfo

Returns:

the type of the folder

Throws:

UnknownFolderTypeException - if the type of the folder can not be retrieved

See Also:

• FolderInfo.getType()