EntityTypeContactInfo

Name EntityTypeContactInfo
Usage IdentityService
addEntityTypeContactInfoToEntity updateEntityTypeContactInfo inactivateEntityTypeContactInfo
Entity
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
entityId Entity Id String Gets the id of the parent identity object. Required   One No  
entityTypeCode Entity Type Code String Gets this entityTypeCode of the {@link EntityAddressContract}'s object. Required   One No  
entityType Entity Type CodedAttributeContract Gets this identity Type of the {@link EntityTypeContactInfoContract}'s object.     One No  
addresses Addresses EntityAddressList Gets this {@link EntityTypeContactInfoContract}'s List of {@link org.kuali.rice.kim.api.identity.address.EntityAddress}S.     Many No  
emailAddresses Email Addresses EntityEmailList Gets this {@link EntityTypeContactInfoContract}'s List of {@link org.kuali.rice.kim.api.identity.email.EntityEmailContract}S.     Many No  
phoneNumbers Phone Numbers EntityPhoneList Gets this {@link EntityTypeContactInfoContract}'s List of {@link org.kuali.rice.kim.api.identity.phone.EntityPhone}S.     Many No  
defaultAddress Default Address EntityAddressContract Returns the default address record for the identity. If no default is defined, then
it returns the first one found. If none are defined, it returns null.
    One No  
defaultEmailAddress Default Email Address EntityEmail Returns the default email record for the identity. If no default is defined, then
it returns the first one found. If none are defined, it returns null.
    One No  
defaultPhoneNumber Default Phone Number EntityPhoneContract Returns the default phone record for the identity. If no default is defined, then
it returns the first one found. If none are defined, it returns null.
    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  
active Active boolean The active indicator for an object.     One No