Package de.uplanet.lucy.server.rtcache
Interface FieldInfo
- All Superinterfaces:
de.uplanet.lucy.server.rtcache.ILanguageConstant
,de.uplanet.lucy.server.util.ILanguageConstantOrTitle
,de.uplanet.lucy.server.rtcache.IRtInfo
,de.uplanet.lucy.server.rtcache.IRtInfoWithTitle
@Scriptable
public interface FieldInfo
extends de.uplanet.lucy.server.rtcache.IRtInfo, de.uplanet.lucy.server.rtcache.IRtInfoWithTitle, de.uplanet.lucy.server.util.ILanguageConstantOrTitle
Information about data fields.
-
Method Summary
Modifier and TypeMethodDescriptionGet the application GUID the field belongs to.Get application reference GUID.Get calculated field.Get GUID of calculated field.Get the physical database column name.Get the data group GUID.Get the data handler.de.uplanet.lucy.types.UP_TYPE
Get the data type.Get the fields handler class.getGuid()
Get the field GUID.getName()
Get the name.Get parent field.Get GUID of parent field.int
The data type precision.de.uplanet.lucy.server.property.IPropertyCollection
The field propertiesGet the referenced field, if this is a reference.Get the referenced field GUID.int
getSize()
The data type scale.Get the sysIdent.Get the table name.boolean
Return, if field is plugin field.boolean
Use in file fields only.boolean
return Returnstrue
if the field should only be used in internal, not for filters or control and so on.boolean
Return, if field is NOT filtered.boolean
Return, if field is a primary key field.boolean
Return, if field is a reference key field.boolean
Returntrue
if field is a reference field or the reference key field.boolean
isSystem()
Return, if field is system field.Methods inherited from interface de.uplanet.lucy.server.rtcache.ILanguageConstant
getLanguageConstantAppGuid, getLanguageConstantName, getLanguageConstantType, hasLanguageConstant
Methods inherited from interface de.uplanet.lucy.server.util.ILanguageConstantOrTitle
getTitles
Methods inherited from interface de.uplanet.lucy.server.rtcache.IRtInfoWithTitle
getDefaultTitle, getTitle, getTitles
-
Method Details
-
getGuid
String getGuid()Get the field GUID.- Returns:
- The GUID (not
null
).
-
getAppGuid
String getAppGuid()Get the application GUID the field belongs to.- Returns:
- The application GUID (not
null
).
-
getDataGroupGuid
String getDataGroupGuid()Get the data group GUID.- Returns:
- The data group GUID. (not
null
).
-
getTableName
String getTableName()Get the table name.- Returns:
- The table name.
-
getName
String getName()Get the name.- Returns:
- The name (not
null
).
-
getColumnName
String getColumnName()Get the physical database column name.- Returns:
- The column name (not
null
).
-
getDataType
de.uplanet.lucy.types.UP_TYPE getDataType()Get the data type.- Returns:
- The data type (not
null
).
-
getPrecision
int getPrecision()The data type precision.- Returns:
- The data type precision.
-
getSize
int getSize()The data type scale.- Returns:
- The data type scale.
-
getDataHandler
String getDataHandler()Get the data handler.- Returns:
- the data handler (not
null
).
-
getSysIdent
String getSysIdent()Get the sysIdent.- Returns:
- the sysIdent (could be
null
).
-
isSystem
boolean isSystem()Return, if field is system field.- Returns:
true
orfalse
.
-
isReference
boolean isReference()Return, if field is a reference key field.- Returns:
true
orfalse
.
-
isReferenceField
boolean isReferenceField()Returntrue
if field is a reference field or the reference key field. (Same as isReference() || getReferenceKey() != null- Returns:
true
orfalse
.
-
isPrimaryKey
boolean isPrimaryKey()Return, if field is a primary key field.- Returns:
true
orfalse
.
-
isNotFiltered
boolean isNotFiltered()Return, if field is NOT filtered.- Returns:
true
if not filtered,false
otherwise.
-
getParentFieldGuid
String getParentFieldGuid()Get GUID of parent field.- Returns:
- Parent GUID (could be
null
).
-
getParentField
FieldInfo getParentField()Get parent field.- Returns:
- Parent field (could be
null
).
-
getAppRefGuid
String getAppRefGuid()Get application reference GUID.- Returns:
- The reference GUID (could be
null
).
-
getReferenceFieldGuid
String getReferenceFieldGuid()Get the referenced field GUID.- Returns:
- The referenced field GUID (could be
null
).
-
getReferencedField
FieldInfo getReferencedField()Get the referenced field, if this is a reference.- Returns:
- The referenced field, or
null
if this field is not a reference field.
-
getCalcFieldGuid
String getCalcFieldGuid()Get GUID of calculated field.- Returns:
- The calculated field GUID (could be
null
).
-
getCalcField
FieldInfo getCalcField()Get calculated field.- Returns:
FieldInfo
of calculated field (could benull
).
-
isFileField
boolean isFileField()Return, if field is plugin field.- Returns:
true
orfalse
.
-
getFileHandler
String getFileHandler()Get the fields handler class.- Returns:
- The field handler class (could be
null
).
-
getProperties
de.uplanet.lucy.server.property.IPropertyCollection getProperties()The field properties- Returns:
- The field properties (not
null
).
-
isInheritPermission
boolean isInheritPermission()Use in file fields only. return Returnstrue
if the permissions will be inherit from the data group. -
isInternalField
boolean isInternalField()return Returnstrue
if the field should only be used in internal, not for filters or control and so on.
-