org.kuali.student.r2.common.datadictionary.dto

Class DictionaryEntryInfo.Builder

java.lang.Object

org.kuali.student.r2.common.datadictionary.dto.DictionaryEntryInfo.Builder

All Implemented Interfaces:

DictionaryEntry

Enclosing class:

DictionaryEntryInfo

public static class DictionaryEntryInfo.Builder
extends Object
implements DictionaryEntry

Constructor Summary

Constructors

Constructor and Description
DictionaryEntryInfo.Builder()
DictionaryEntryInfo.Builder(DictionaryEntry entry)

Method Summary

Methods

Modifier and Type	Method and Description
DictionaryEntryInfo	build()
List<AttributeDefinitionInfo>	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.
DictionaryEntryInfo.Builder	setAttributes(List<AttributeDefinitionInfo> attributes)
DictionaryEntryInfo.Builder	setName(String name)
DictionaryEntryInfo.Builder	setObjectClass(String objectClass)
DictionaryEntryInfo.Builder	setObjectDescription(String objectDescription)
DictionaryEntryInfo.Builder	setObjectLabel(String objectLabel)
DictionaryEntryInfo.Builder	setPrimaryKeys(List<String> primaryKeys)
DictionaryEntryInfo.Builder	setTitleAttribute(String titleAttribute)

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryEntryInfo.Builder

public DictionaryEntryInfo.Builder()

DictionaryEntryInfo.Builder

public DictionaryEntryInfo.Builder(DictionaryEntry entry)

Method Detail

build

public DictionaryEntryInfo build()

getAttributes

public List<AttributeDefinitionInfo> getAttributes()

Description copied from interface: DictionaryEntry

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

Specified by:

getAttributes in interface DictionaryEntry

setAttributes

public DictionaryEntryInfo.Builder setAttributes(List<AttributeDefinitionInfo> attributes)

getName

public String getName()

Description copied from interface: DictionaryEntry

The name of this entry.

Specified by:

getName in interface DictionaryEntry

setName

public DictionaryEntryInfo.Builder setName(String name)

getObjectClass

public String getObjectClass()

Description copied from interface: DictionaryEntry

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

Specified by:

getObjectClass in interface DictionaryEntry

setObjectClass

public DictionaryEntryInfo.Builder setObjectClass(String objectClass)

getObjectDescription

public String getObjectDescription()

Description copied from interface: DictionaryEntry

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

Specified by:

getObjectDescription in interface DictionaryEntry

setObjectDescription

public DictionaryEntryInfo.Builder setObjectDescription(String objectDescription)

getObjectLabel

public String getObjectLabel()

Description copied from interface: DictionaryEntry

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

Specified by:

getObjectLabel in interface DictionaryEntry

setObjectLabel

public DictionaryEntryInfo.Builder setObjectLabel(String objectLabel)

getPrimaryKeys

public List<String> getPrimaryKeys()

Description copied from interface: DictionaryEntry

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 DictionaryEntry

setPrimaryKeys

public DictionaryEntryInfo.Builder setPrimaryKeys(List<String> primaryKeys)

getTitleAttribute

public String getTitleAttribute()

Description copied from interface: DictionaryEntry

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 DictionaryEntry

setTitleAttribute

public DictionaryEntryInfo.Builder setTitleAttribute(String titleAttribute)