EntityAddress

Name EntityAddress
Usage IdentityService
addAddressToEntity updateAddress inactivateAddress
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 EntityAddressContract}'s object.     One No  
entityId Entity Id String Gets this id of the parent identity object.     One No  
addressType Address Type CodedAttribute Gets this {@link EntityAddressContract}'s address type code.     One No  
attentionLine Attention Line String Returns the attention line for this {@link EntityAddressContract}
Corresponds to PESC AttentionLine		     One No  
line1 Line1 String Gets this {@link EntityAddressContract}'s first line.     One No  
line2 Line2 String Gets this {@link EntityAddressContract}'s second line.     One No  
line3 Line3 String Gets this {@link EntityAddressContract}'s third line.     One No  
city City String Gets this {@link EntityAddressContract}'s city name.
Corresponds to PESC City.		     One No  
stateProvinceCode State Province Code String Gets this {@link EntityAddressContract}'s state code.
Corresponds to PESC StateProvinceCode.		     One No  
postalCode Postal Code String Gets this {@link EntityAddressContract}'s postal code.     One No  
countryCode Country Code String Gets this {@link EntityAddressContract}'s country code.     One No  
attentionLineUnmasked Attention Line Unmasked String Returns the unmasked attention line for this {@link EntityAddressContract}     One No  
line1Unmasked Line1 Unmasked String Gets this {@link EntityAddressContract}'s unmasked first line.     One No  
line2Unmasked Line2 Unmasked String Gets this {@link EntityAddressContract}'s unmasked second line.     One No  
line3Unmasked Line3 Unmasked String Gets this {@link EntityAddressContract}'s unmasked third line.     One No  
cityUnmasked City Unmasked String Gets this {@link EntityAddressContract}'s unmasked city name.     One No  
stateProvinceCodeUnmasked State Province Code Unmasked String Gets this {@link EntityAddressContract}'s unmasked state code.     One No  
postalCodeUnmasked Postal Code Unmasked String Gets this {@link EntityAddressContract}'s unmasked postal code.     One No  
countryCodeUnmasked Country Code Unmasked String Gets this {@link EntityAddressContract}'s unmasked country code.     One No  
addressFormat Address Format String Returns the {@link EntityAddressContract}'s address format
Corresponds to PESC AddressFormat		     One No  
modifiedDate Modified Date DateTime Returns the {@link EntityAddressContract}'s modification date
Corresponds to PESC ModifiedDate		     One No  
validatedDate Validated Date DateTime Returns the {@link EntityAddressContract}'s validation date
Corresponds to PESC ValidatedDate		     One No  
validated Validated boolean Returns whether the {@link EntityAddressContract} is validated
Corresponds to PESC Validated		     One No  
noteMessage Note Message String Returns the {@link EntityAddressContract}'s note/message
Corresponds to PESC NoteMessage		     One No  
suppressAddress Suppress Address boolean Returns a boolean value that determines if address 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