Package sk.ipesoft.d2000.d2japi
Interface D2ObjectInfo
-
- All Superinterfaces:
java.io.Serializable
- All Known Subinterfaces:
D2StructureDefinitionInfo
public interface D2ObjectInfo extends java.io.Serializable
Data describing certain object from D2000 DODM.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description int
getCols()
Deprecated.As of R39, replaced bygetColumnCount()
.int
getColumnCount()
Get number of column in case of structured value, zero otherwise.java.lang.String
getDescription()
Get human-readable description of the object.int
getHobj()
Get HOBJ - immutable unique identifier in D2000 DODM - of the object.int
getHOBJ()
Deprecated.As of R39, replaced bygetHobj()
.java.lang.String
getName()
Get name of the object - mutable unique identifier in D2000 DODM.int
getParent()
Deprecated.As of R39, replaced bygetParentHobj()
.int
getParentHobj()
Get HOBJ of the object's parent.int
getRowCount()
Get number of rows in case of structured value, zero otherwise.int
getRows()
Deprecated.As of R39, replaced bygetRowCount()
.int
getStateTextHobj()
Get HOBJ ofStateTextDefinition
object, which should be used when value of the object is to be displayed, or zero if not used.int
getStrucDefinitionID()
Deprecated.As of R39, replaced bygetStructureDefinitionHobj()
.int
getStructureDefinitionHobj()
Get HOBJ of associated structure definition object in case of structured value object, zero otherwise.java.lang.String
getTechnicalUnit()
Deprecated.As of R39, replaced withgetTechnicalUnits()
.java.lang.String
getTechnicalUnits()
Get human-readable representation of technical units.int
getTextPalID()
Deprecated.As of R39, replaced bygetStateTextHobj()
.int
getTransformationPaletteIndex()
Get one-based index of transformation palette, that should be used when value of the object is to be displayed, or zero if not used.int
getTransPalID()
Deprecated.As of R39, replaced bygetTransformationPaletteIndex()
.sk.ipesoft.d2000.base.ObjectType
getType()
Get type of the object./java.lang.String
getUuid()
Get UUID identifier of the object.sk.ipesoft.d2000.base.UnivalValue<?>
getValue()
Get current snapshot of object value.
-
-
-
Method Detail
-
getCols
@Deprecated int getCols()
Deprecated. As of R39, replaced bygetColumnCount()
.Get number of column in case of structured value, zero otherwise.- Returns:
- number of columns of structured value
-
getColumnCount
int getColumnCount()
Get number of column in case of structured value, zero otherwise.- Returns:
- number of columns of structured value
-
getDescription
java.lang.String getDescription()
Get human-readable description of the object. Description is translatable with system dictionary.- Returns:
- human-readable description of the object
-
getHOBJ
@Deprecated int getHOBJ()
Deprecated. As of R39, replaced bygetHobj()
.Get HOBJ - immutable unique identifier in D2000 DODM - of the object.- Returns:
- HOBJ
-
getHobj
int getHobj()
Get HOBJ - immutable unique identifier in D2000 DODM - of the object.- Returns:
- HOBJ
-
getName
java.lang.String getName()
Get name of the object - mutable unique identifier in D2000 DODM.- Returns:
- name of the object
-
getParent
@Deprecated int getParent()
Deprecated. As of R39, replaced bygetParentHobj()
.Get HOBJ of the object's parent.- Returns:
- HOBJ of the object's parent
-
getParentHobj
int getParentHobj()
Get HOBJ of the object's parent.- Returns:
- HOBJ of the object's parent
-
getRowCount
int getRowCount()
Get number of rows in case of structured value, zero otherwise.- Returns:
- number of rows of structured value
-
getRows
@Deprecated int getRows()
Deprecated. As of R39, replaced bygetRowCount()
.Get number of rows in case of structured value, zero otherwise.- Returns:
- number of rows of structured value
-
getStateTextHobj
int getStateTextHobj()
Get HOBJ ofStateTextDefinition
object, which should be used when value of the object is to be displayed, or zero if not used. In case that transformation palette and state text are used, state text takes precedence.- Returns:
- HOBJ of associated
StateTextDefinition
-
getStrucDefinitionID
@Deprecated int getStrucDefinitionID()
Deprecated. As of R39, replaced bygetStructureDefinitionHobj()
.Get HOBJ of associated structure definition object in case of structured value object, zero otherwise.- Returns:
- HOBJ of associated structure definition
-
getStructureDefinitionHobj
int getStructureDefinitionHobj()
Get HOBJ of associated structure definition object in case of structured value object, zero otherwise.- Returns:
- HOBJ of associated structure definition
-
getTechnicalUnit
@Deprecated java.lang.String getTechnicalUnit()
Deprecated. As of R39, replaced withgetTechnicalUnits()
.Get human-readable representation of technical units. Technical units are translatable with system dictionary. It is often appropriate to display value of the object with translated technical units. This value has no meaning in the system, its purpose is sorely for being displayed.- Returns:
- human-readable representation of technical units
-
getTechnicalUnits
java.lang.String getTechnicalUnits()
Get human-readable representation of technical units. Technical units are translatable with system dictionary. It is often appropriate to display value of the object with translated technical units. This value has no meaning in the system, its purpose is sorely for being displayed.- Returns:
- human-readable representation of technical units
-
getTextPalID
@Deprecated int getTextPalID()
Deprecated. As of R39, replaced bygetStateTextHobj()
.Get HOBJ ofStateTextDefinition
object, which should be used when value of the object is to be displayed, or zero if not used. In case that transformation palette and state text are used, state text takes precedence.- Returns:
- HOBJ of associated
StateTextDefinition
-
getTransPalID
@Deprecated int getTransPalID()
Deprecated. As of R39, replaced bygetTransformationPaletteIndex()
.Get one-based index of transformation palette, that should be used when value of the object is to be displayed, or zero if not used. In case that buth transformation palette and state text are assigned, state text takes precedence.- Returns:
- one-based index of transformation palette
-
getTransformationPaletteIndex
int getTransformationPaletteIndex()
Get one-based index of transformation palette, that should be used when value of the object is to be displayed, or zero if not used. In case that both transformation palette and state text are assigned, state text takes precedence.- Returns:
- one-based index of transformation palette
-
getType
sk.ipesoft.d2000.base.ObjectType getType()
Get type of the object./- Returns:
- type of the object
-
getUuid
java.lang.String getUuid()
Get UUID identifier of the object.- Returns:
- UUID of the object
-
getValue
sk.ipesoft.d2000.base.UnivalValue<?> getValue()
Get current snapshot of object value.- Returns:
- snapshot of object value
-
-