org.kuali.student.r2.common.datadictionary.infc

Interface DictionaryEntry

All Known Implementing Classes:

DictionaryEntryInfo, DictionaryEntryInfo.Builder

public interface DictionaryEntry

This is an info ojbect that contains the dictionary information about an object known to the system.

Author:

nwright

Method Summary

Methods

Modifier and Type	Method and Description
List<? extends AttributeDefinitionInfc>	getAttributes() Get the definitions of the attributes (fields) on the object
String	getName() The name of this entry.
String	getObjectClass() The class of the object to which this dictionary entry refers.
String	getObjectDescription() The object description provides a brief description of the business object for use on help screens.
String	getObjectLabel() The object label provides a short name of the business object for use on help screens.
List<String>	getPrimaryKeys() The primary key(s) associatd with the object.
String	getTitleAttribute() The titleAttribute element is the name of the attribute that will be used as an inquiry field when the lookup search results fields are displayed.

Method Detail

getObjectClass

String getObjectClass()

The class of the object to which this dictionary entry refers.

getName

String getName()

The name of this entry.

getObjectLabel

String getObjectLabel()

The object label provides a short name of the business object for use on help screens.

getObjectDescription

String getObjectDescription()

The object description provides a brief description of the business object for use on help screens.

getTitleAttribute

String getTitleAttribute()

The titleAttribute element is the name of the attribute that will be used as an inquiry field when the lookup search results fields are displayed. For some business objects, there is no obvious field to serve as the inquiry field. in that case a special field may be required for inquiry purposes.

getPrimaryKeys

List<String> getPrimaryKeys()

The primary key(s) associatd with the object. TODO: determine how/if this works with the than the "unique" flag on attribute definition TODO: determine how/if this works with the id

getAttributes

List<? extends AttributeDefinitionInfc> getAttributes()

Get the definitions of the attributes (fields) on the object