EntityName

Name EntityName
Usage IdentityService
addNameToEntity updateName inactivateName
EntityDefault Entity EntityNamePrincipalName
Type Complex

Description

Copyright 2005-2012 The Kuali Foundation

Licensed under the Educational Community License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.opensource.org/licenses/ecl2.php

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Id String The unique identifier for an object. This can be null.     One No  
entityId Entity Id String Gets this {@link Entity}'s id.     One No  
nameType Name Type CodedAttribute Gets this {@link EntityNameContract}'s TypeContract.     One No  
namePrefix Name Prefix String Gets this {@link EntityNameContract}'s name prefix.
Corresponds to PESC NamePrefix.		     One No  
nameTitle Name Title String Gets this {@link EntityNameContract}'s name title.
Corresponds to PESC NameTitle.		     One No  
firstName First Name String Gets this {@link EntityNameContract}'s first name.     One No  
middleName Middle Name String Gets this {@link EntityNameContract}'s middle name.     One No  
lastName Last Name String Gets this {@link EntityNameContract}'s last name.     One No  
nameSuffix Name Suffix String Gets this {@link EntityNameContract}'s suffix.
Corresponds to PESC NameSuffix.		     One No  
compositeName Composite Name String Return the entire name as the person or system wants it displayed.
Corresponds to PESC CompositeName.		     One No  
namePrefixUnmasked Name Prefix Unmasked String Gets this {@link EntityNameContract}'s unmasked name prefix.
Corresponds to PESC NamePrefix.		     One No  
nameTitleUnmasked Name Title Unmasked String Gets this {@link EntityNameContract}'s unmasked name title.
Corresponds to PESC NameTitle.		     One No  
firstNameUnmasked First Name Unmasked String Gets this {@link EntityNameContract}'s unmasked first name.     One No  
middleNameUnmasked Middle Name Unmasked String Gets this {@link EntityNameContract}'s unmasked middle name.     One No  
lastNameUnmasked Last Name Unmasked String Gets this {@link EntityNameContract}'s unmasked last name.     One No  
nameSuffixUnmasked Name Suffix Unmasked String Gets this {@link EntityNameContract}'s unmasked suffix.
Corresponds to PESC NameSuffix.		     One No  
compositeNameUnmasked Composite Name Unmasked String Gets this {@link EntityNameContract}'s unmasked formatted name.
Corresponds to PESC CompositeName.		     One No  
noteMessage Note Message String Get the note associated with this {@link EntityNameContract}
Corresponds to PESC NoteMessage		     One No  
nameChangedDate Name Changed Date DateTime Get the name change date {@link EntityNameContract}
Corresponds to PESC name changed date		     One No  
suppressName Suppress Name boolean Returns a boolean value that determines if email fields should be suppressed.     One No  
defaultValue Default Value boolean The default value for this object.     One No  
active Active boolean The active indicator for an object.     One No  
versionNumber Version Number Long Returns the version number for this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
This version number is generally used for the purposes of optimistic locking.		     One No  
objectId Object Id String Return the globally unique object id of this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.		     One No