de.uplanet.lucy.server.rtcache
Interface ReferenceInfo


@Scriptable
public interface ReferenceInfo

Information about data field references.

Version:
$Revision: 78032 $

Method Summary
 java.lang.String getDefaultTitle()
          Get the reference's default title.
 java.lang.String getForeignAppGuid()
          Get the application GUID.
 java.lang.String getForeignDataGroupGuid()
          Get the data group GUID.
 java.util.List<java.lang.String> getForeignKeyFieldGuids()
          List with the field GUID's of the foreign key fields.
 java.lang.String getGuid()
          Get the reference GUID.
 java.lang.String getReferencedDataGroupGuid()
          Get the GUID of the referenced data group.
 java.util.List<de.uplanet.lucy.server.rtcache.ReferenceParameterInfo> getReferenceParameters()
          Get the reference parameters.
 java.util.List<java.lang.String> getReferencingFieldGuids()
          Get the fields that belong to the reference.
 int getStatus()
          Get the reference status.
 java.lang.String getTitle(java.lang.String p_strLang)
          Get the reference title for the given language.
 java.util.Map<java.lang.String,java.lang.String> getTitles()
          Get the reference's language specific titles.
 java.lang.String getView()
          Get the view field.
 

Method Detail

getGuid

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

Returns:
The reference GUID (not null).

getForeignAppGuid

java.lang.String getForeignAppGuid()
Get the application GUID.

Returns:
The foreign application GUID (not null).

getForeignDataGroupGuid

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

Returns:
The foreign data group GUID (not null).

getReferencedDataGroupGuid

java.lang.String getReferencedDataGroupGuid()
Get the GUID of the referenced data group.

Returns:
the GUID of the referenced data group (not null).

getStatus

int getStatus()
Get the reference status.

Returns:
The reference status

getView

java.lang.String getView()
Get the view field.

Returns:
The view (could be null).

getReferencingFieldGuids

java.util.List<java.lang.String> getReferencingFieldGuids()
Get the fields that belong to the reference.

Returns:
List with referenced field GUIDs (not null and at least one element).

getForeignKeyFieldGuids

java.util.List<java.lang.String> getForeignKeyFieldGuids()
List with the field GUID's of the foreign key fields.

Returns:
List with the foreign key field GUIDs (not null).

getReferenceParameters

java.util.List<de.uplanet.lucy.server.rtcache.ReferenceParameterInfo> getReferenceParameters()
Get the reference parameters.

Returns:
The reference parameters (not null).

getDefaultTitle

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

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

getTitles

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

Returns:
The titles (not null).

getTitle

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

Parameters:
p_strLang - A language identifier.
Returns:
The language-specific reference 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.