Class ClassicConnectorFolderInfo
- java.lang.Object
-
- com.saperion.ngc.model.navigation.ClassicConnectorFolderInfo
-
- All Implemented Interfaces:
FolderInfo
public class ClassicConnectorFolderInfo extends java.lang.Object implements FolderInfo
Implementation of FolderInfo for ClassicConnector.
-
-
Constructor Summary
Constructors Constructor Description ClassicConnectorFolderInfo(com.saperion.intf.SaDocumentInfo saDocumentInfo)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getFolderClassName()
Returns the name of the folder class of this folder or null if the folder does not have a class.FolderId
getFolderId()
java.lang.String
getFolderName()
java.lang.String
getFolderPath()
java.lang.String
getPropertyAsString(java.lang.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(java.lang.String valueName)
Returns the value with the specified name.com.saperion.intf.SaPropertyValue[]
getValues()
Returns all index values of the folder.boolean
hasValue(java.lang.String valueName)
Returns true if the folder has an index value with the specified name.
-
-
-
Method Detail
-
getPropertyAsString
public java.lang.String getPropertyAsString(java.lang.String propertyName)
Returns the specified propertie's value as a string or null if the value is not available.- Specified by:
getPropertyAsString
in interfaceFolderInfo
- Parameters:
propertyName
- property name- Returns:
- value as string or null
- See Also:
FolderInfo.getPropertyAsString(java.lang.String)
-
getFolderClassName
public java.lang.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 interfaceFolderInfo
- Returns:
- folder class name
- See Also:
FolderInfo.getFolderClassName()
-
hasValue
public boolean hasValue(java.lang.String valueName)
Returns true if the folder has an index value with the specified name.- Specified by:
hasValue
in interfaceFolderInfo
- 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(java.lang.String valueName)
Returns the value with the specified name.- Specified by:
getValue
in interfaceFolderInfo
- 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 interfaceFolderInfo
- Returns:
- array with index values
- See Also:
FolderInfo.getValues()
-
getFolderName
public java.lang.String getFolderName()
- Specified by:
getFolderName
in interfaceFolderInfo
- Returns:
- the name of the folder
- See Also:
FolderInfo.getFolderName()
-
getFolderPath
public java.lang.String getFolderPath()
- Specified by:
getFolderPath
in interfaceFolderInfo
- Returns:
- the path of the folder
- See Also:
FolderInfo.getFolderPath()
-
getFolderId
public FolderId getFolderId() throws DocumentIdentificationException
- Specified by:
getFolderId
in interfaceFolderInfo
- 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 interfaceFolderInfo
- Returns:
- the type of the folder
- Throws:
UnknownFolderTypeException
- if the type of the folder can not be retrieved- See Also:
FolderInfo.getType()
-
-