EntityEmail

Name EntityEmail
Usage IdentityService
addEmailToEntity updateEmail inactivateEmail
EntityTypeContactInfoDefault EntityTypeContactInfo
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  
entityTypeCode Entity Type Code String Gets this entityTypeCode of the {@link EntityEmailContract}'s object.     One No  
entityId Entity Id String Gets this id of the parent identity object.     One No  
emailType Email Type CodedAttribute Gets this {@link org.kuali.rice.kim.api.identity.email.EntityEmail}'s type code.     One No  
emailAddress Email Address String Gets this {@link EntityEmail}'s email address.     One No  
emailAddressUnmasked Email Address Unmasked String Gets this {@link EntityEmail}'s unmasked email address.     One No  
suppressEmail Suppress Email 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