EntityName.Builder (Rice 2.4.0-M5-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.rice.kim.api.identity.name
Class EntityName.Builder

java.lang.Object
  org.kuali.rice.kim.api.identity.name.EntityName.Builder

All Implemented Interfaces:: Serializable, Inactivatable, Defaultable, GloballyUnique, Identifiable, Versioned, ModelBuilder, EntityNameContract

Enclosing class:: EntityName

public static final class EntityName.Builder
extends Object
implements Serializable, ModelBuilder, EntityNameContract
extends Object
implements Serializable, ModelBuilder, EntityNameContract

A builder which can be used to construct EntityName instances. Enforces the constraints of the EntityNameContract.

See Also:: Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.kim.api.identity.name.EntityNameContract
`NAME_CHANGED_DATE_FORMAT`

Method Summary
`EntityName`	`build()` Returns an instance of the object being built by this builder based on the current state of the builder.
`static EntityName.Builder`	`create()`
`static EntityName.Builder`	`create(EntityNameContract contract)`
`static EntityName.Builder`	`create(String id, String entityId, String firstName, String lastName, boolean suppressName)`
`String`	`getCompositeName()` Return the entire name as the person or system wants it displayed.
`String`	`getCompositeNameUnmasked()` Gets this `EntityNameContract`'s unmasked formatted name.
`String`	`getEntityId()` Gets this `Entity`'s id.
`String`	`getFirstName()` Gets this `EntityNameContract`'s first name.
`String`	`getFirstNameUnmasked()` Gets this `EntityNameContract`'s unmasked first name.
`String`	`getId()` The unique identifier for an object.
`String`	`getLastName()` Gets this `EntityNameContract`'s last name.
`String`	`getLastNameUnmasked()` Gets this `EntityNameContract`'s unmasked last name.
`String`	`getMiddleName()` Gets this `EntityNameContract`'s middle name.
`String`	`getMiddleNameUnmasked()` Gets this `EntityNameContract`'s unmasked middle name.
`org.joda.time.DateTime`	`getNameChangedDate()` Get the name change date `EntityNameContract` Corresponds to PESC name changed date
`String`	`getNamePrefix()` Gets this `EntityNameContract`'s name prefix.
`String`	`getNamePrefixUnmasked()` Gets this `EntityNameContract`'s unmasked name prefix.
`String`	`getNameSuffix()` Gets this `EntityNameContract`'s suffix.
`String`	`getNameSuffixUnmasked()` Gets this `EntityNameContract`'s unmasked suffix.
`String`	`getNameTitle()` Gets this `EntityNameContract`'s name title.
`String`	`getNameTitleUnmasked()` Gets this `EntityNameContract`'s unmasked name title.
`CodedAttribute.Builder`	`getNameType()` Gets this `EntityNameContract`'s TypeContract.
`String`	`getNoteMessage()` Get the note associated with this `EntityNameContract` Corresponds to PESC NoteMessage
`String`	`getObjectId()` Return the globally unique object id of this object.
`Long`	`getVersionNumber()` Returns the version number for this object.
`boolean`	`isActive()` The active indicator for an object.
`boolean`	`isDefaultValue()` The default value for this object.
`boolean`	`isSuppressName()` Returns a boolean value that determines if email fields should be suppressed.
`void`	`setActive(boolean active)`
`void`	`setCompositeName(String compositeName)`
`void`	`setDefaultValue(boolean defaultValue)`
`void`	`setEntityId(String entityId)`
`void`	`setFirstName(String firstName)`
`void`	`setId(String id)`
`void`	`setLastName(String lastName)`
`void`	`setMiddleName(String middleName)`
`void`	`setNameChangedDate(org.joda.time.DateTime nameChangedDate)`
`void`	`setNamePrefix(String namePrefix)`
`void`	`setNameSuffix(String nameSuffix)`
`void`	`setNameTitle(String nameTitle)`
`void`	`setNameType(CodedAttribute.Builder nameType)`
`void`	`setNoteMessage(String noteMessage)`
`void`	`setObjectId(String objectId)`
`void`	`setVersionNumber(Long versionNumber)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

create

public static EntityName.Builder create()

create

public static EntityName.Builder create(String id,
                                        String entityId,
                                        String firstName,
                                        String lastName,
                                        boolean suppressName)

create

public static EntityName.Builder create(EntityNameContract contract)

build

public EntityName build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:: build in interface ModelBuilder

Returns:: an instance of the object being built by this builder, should never return null