de.uplanet.lucy.server.rtcache
Interface FieldInfo


@Scriptable
public interface FieldInfo

Information about data fields.

Version:
$Revision: 76967 $

Method Summary
 java.lang.String getAppGuid()
          Get the application GUID the field belongs to.
 java.lang.String getAppRefGuid()
          Get application reference GUID.
 FieldInfo getCalcField()
          Get calculated field.
 java.lang.String getCalcFieldGuid()
          Get GUID of calculated field.
 java.lang.String getColumnName()
          Get the column name.
 java.lang.String getDataGroupGuid()
          Get the data group GUID.
 java.lang.String getDataHandler()
          Get the data handler.
 de.uplanet.lucy.types.UP_TYPE getDataType()
          Get the data type.
 java.lang.String getDefaultTitle()
          Get the field's default title.
 java.lang.String getFileDataGroupGuid()
          Get the fields plugin data group.
 java.lang.String getGuid()
          Get the field GUID.
 java.lang.String getName()
          Get the name.
 FieldInfo getParentField()
          Get parent field.
 java.lang.String getParentFieldGuid()
          Get GUID of parent field.
 de.uplanet.lucy.property.IPropertyCollection getProperties()
          The field properties
 FieldInfo getReferencedField()
          Get the referenced field, if this is a reference.
 java.lang.String getReferenceFieldGuid()
          Get the referenced field GUID.
 java.lang.String getSysIdent()
          Get the sysIdent.
 java.lang.String getTableName()
          Get the table name.
 java.lang.String getTitle(java.lang.String p_strLang)
          Get the field title for the given language.
 java.util.Map<java.lang.String,java.lang.String> getTitles()
          Get the field's language specific titles.
 boolean isFileField()
          Return, if field is plugin field.
 boolean isNotFiltered()
          Return, if field is NOT filtered.
 boolean isPrimaryKey()
          Return, if field is a primary key field.
 boolean isReference()
          Return, if field is a reference field.
 boolean isSystem()
          Return, if field is system field.
 

Method Detail

getGuid

java.lang.String getGuid()
Get the field GUID.

Returns:
the GUID (not null)

getAppGuid

java.lang.String getAppGuid()
Get the application GUID the field belongs to.

Returns:
the appGuid (not null)

getDataGroupGuid

java.lang.String getDataGroupGuid()
Get the data group GUID.

Returns:
the data group GUID. (not null)

getTableName

java.lang.String getTableName()
Get the table name.

Returns:
the table name.

getName

java.lang.String getName()
Get the name.

Returns:
The name (not null).

getColumnName

java.lang.String getColumnName()
Get the 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)

getDataHandler

java.lang.String getDataHandler()
Get the data handler.

Returns:
the data handler (not null)

getSysIdent

java.lang.String getSysIdent()
Get the sysIdent.

Returns:
the sysIdent (could be null)

isSystem

boolean isSystem()
Return, if field is system field.

Returns:
True or false.

isReference

boolean isReference()
Return, if field is a reference field.

Returns:
True or false.

isPrimaryKey

boolean isPrimaryKey()
Return, if field is a primary key field.

Returns:
True or false.

isNotFiltered

boolean isNotFiltered()
Return, if field is NOT filtered.

Returns:
True if not filtered,false otherwise.

getParentFieldGuid

java.lang.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

java.lang.String getAppRefGuid()
Get application reference GUID.

Returns:
The reference GUID (could be null).

getReferenceFieldGuid

java.lang.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

java.lang.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 be null).

isFileField

boolean isFileField()
Return, if field is plugin field.

Returns:
True or false.

getFileDataGroupGuid

java.lang.String getFileDataGroupGuid()
Get the fields plugin data group.

Returns:
The plugin data group (could be null).

getProperties

de.uplanet.lucy.property.IPropertyCollection getProperties()
The field properties

Returns:
The field properties (not null).

getDefaultTitle

java.lang.String getDefaultTitle()
Get the field's default title.

Returns:
The default title of this field (could be null).

getTitles

java.util.Map<java.lang.String,java.lang.String> getTitles()
Get the field's language specific titles.

Returns:
The titles (not null).

getTitle

java.lang.String getTitle(java.lang.String p_strLang)
Get the field title for the given language.

Parameters:
p_strLang - A language identifier.
Returns:
The language-specific field title, or the default title if the requested title does not exist (could be null).


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.