EntityName.Builder (Rice 2.0.0-m7-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

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)`
`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`	`getFormattedName()` Return the entire name as the person or system wants it displayed.
`String`	`getFormattedNameUnmasked()` Gets this `EntityNameContract`'s unmasked formatted 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.
`Type.Builder`	`getNameType()` Gets this `EntityNameContract`'s TypeContract.
`String`	`getObjectId()` Return the globally unique object id of this object.
`String`	`getSuffix()` Gets this `EntityNameContract`'s suffix.
`String`	`getSuffixUnmasked()` Gets this `EntityNameContract`'s unmasked suffix.
`String`	`getTitle()` Gets this `EntityNameContract`'s title.
`String`	`getTitleUnmasked()` Gets this `EntityNameContract`'s unmasked title.
`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`	`setDefaultValue(boolean defaultValue)`
`void`	`setEntityId(String entityId)`
`void`	`setFirstName(String firstName)`
`void`	`setId(String id)`
`void`	`setLastName(String lastName)`
`void`	`setMiddleName(String middleName)`
`void`	`setNameType(Type.Builder nameType)`
`void`	`setObjectId(String objectId)`
`void`	`setSuffix(String suffix)`
`void`	`setTitle(String title)`
`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(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