com.saperion.ngc.model.navigation.intf

Interface FolderInfo

All Known Implementing Classes:

ClassicConnectorFolderInfo

public interface FolderInfo

Defines a class that holds information about a folder (metadata).

Method Summary

Modifier and Type	Method and 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.

Method Detail

getPropertyAsString

String getPropertyAsString(String propertyName)

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

Parameters:

propertyName - property name

Returns:

value as string or null

getFolderClassName

String getFolderClassName()

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

Returns:

folder class name

hasValue

boolean hasValue(String valueName)

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

Parameters:

valueName - value name

Returns:

true if value is present, otherwise false

getValue

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

Returns the value with the specified name.

Parameters:

valueName - value name

Returns:

the value

getValues

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

Returns all index values of the folder.

Returns:

array with index values

getFolderName

String getFolderName()

Returns:

the name of the folder

getFolderPath

String getFolderPath()

Returns:

the path of the folder

getFolderId

FolderId getFolderId()
              throws DocumentIdentificationException

Returns:

id of the folder

Throws:

DocumentIdentificationException - when the folder does not contain a unique id

getType

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

Returns:

the type of the folder

Throws:

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