org.kuali.student.datadictionary.dto
Class DictionaryEntryInfo

java.lang.Object
  org.kuali.student.datadictionary.dto.DictionaryEntryInfo

All Implemented Interfaces:

Serializable, DictionaryEntryInfc

public class DictionaryEntryInfo
extends Object
implements DictionaryEntryInfc, Serializable

See Also:

Serialized Form

Nested Class Summary

static class

DictionaryEntryInfo.Builder

Field Summary

private List<AttributeDefinitionInfo>	attributes
private String	name
private String	objectClass
private String	objectDescription
private String	objectLabel
private List<String>	primaryKeys
private static long	serialVersionUID
private String	titleAttribute

Constructor Summary

	DictionaryEntryInfo()
private	DictionaryEntryInfo(DictionaryEntryInfc infc)

Method Summary

List<AttributeDefinitionInfo>	getAttributes() Name: Attribute Defiitions Get the definitions of the attributes (fields) on the object
String	getName() Name: Name get Name
String	getObjectClass() Name: Object Class The class of the object to which this dictionary entry refers
String	getObjectDescription() Name: Object Description The object description provides a brief description of the business object for use on help screens.
String	getObjectLabel() Name: Object Label The object label provides a short name of the business object for use on help screens.
List<String>	getPrimaryKeys() Name: Prmary Keys The primary key(s) associatd with the object.
String	getTitleAttribute() Name: Title Attribute 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

objectClass

private String objectClass

name

private String name

objectLabel

private String objectLabel

objectDescription

private String objectDescription

titleAttribute

private String titleAttribute

primaryKeys

private List<String> primaryKeys

attributes

private List<AttributeDefinitionInfo> attributes

Constructor Detail

DictionaryEntryInfo

public DictionaryEntryInfo()

DictionaryEntryInfo

private DictionaryEntryInfo(DictionaryEntryInfc infc)

Method Detail

getObjectClass

public String getObjectClass()

Description copied from interface: DictionaryEntryInfc

Name: Object Class The class of the object to which this dictionary entry refers

Specified by:

getObjectClass in interface DictionaryEntryInfc

Returns:

the objectClass

getName

public String getName()

Description copied from interface: DictionaryEntryInfc

Name: Name get Name

Specified by:

getName in interface DictionaryEntryInfc

getObjectLabel

public String getObjectLabel()

Description copied from interface: DictionaryEntryInfc

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

Specified by:

getObjectLabel in interface DictionaryEntryInfc

getObjectDescription

public String getObjectDescription()

Description copied from interface: DictionaryEntryInfc

Name: Object Description The object description provides a brief description of the business object for use on help screens.

Specified by:

getObjectDescription in interface DictionaryEntryInfc

getTitleAttribute

public String getTitleAttribute()

Description copied from interface: DictionaryEntryInfc

Name: Title Attribute 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.

Specified by:

getTitleAttribute in interface DictionaryEntryInfc

getPrimaryKeys

public List<String> getPrimaryKeys()

Description copied from interface: DictionaryEntryInfc

Name: Prmary Keys 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

Specified by:

getPrimaryKeys in interface DictionaryEntryInfc

Returns:

the primaryKeys

getAttributes

public List<AttributeDefinitionInfo> getAttributes()

Description copied from interface: DictionaryEntryInfc

Name: Attribute Defiitions Get the definitions of the attributes (fields) on the object

Specified by:

getAttributes in interface DictionaryEntryInfc