Entity

Name Entity
Usage IdentityService
getEntity getEntityByPrincipalId getEntityByPrincipalName getEntityByEmployeeId createEntity updateEntity inactivateEntity
EntityQueryResults
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  
principals Principals PrincipalList Gets this {@link EntityContract}'s principals     Many No  
entityTypeContactInfos Entity Type Contact Infos EntityTypeContactInfoList Gets this {@link EntityContract}'s identity types     Many No  
externalIdentifiers External Identifiers EntityExternalIdentifierList Gets this {@link EntityContract}'s external identifiers     Many No  
affiliations Affiliations EntityAffiliationList Gets this {@link EntityContract}'s affiliations     Many No  
names Names EntityNameList Gets this {@link EntityContract}'s names     Many No  
employmentInformation Employment Information EntityEmploymentList Gets this {@link EntityContract}'s employment information List     Many No  
privacyPreferences Privacy Preferences EntityPrivacyPreferences Gets this {@link EntityContract}'s privacy preferences     One No  
bioDemographics Bio Demographics EntityBioDemographics Gets this {@link EntityContract}'s demographic information     One No  
citizenships Citizenships EntityCitizenshipList Gets this {@link EntityContract}'s citizenship information     Many No  
primaryEmployment Primary Employment EntityEmployment Gets this {@link EntityContract}'s employment information     One No  
defaultAffiliation Default Affiliation EntityAffiliation Gets this {@link EntityContract}'s default affiliation     One No  
defaultName Default Name EntityNameContract Gets this {@link EntityContract}'s default name     One No  
ethnicities Ethnicities EntityEthnicityList Gets this {@link EntityContract}'s ethnicities     Many No  
residencies Residencies EntityResidencyList Gets this {@link EntityContract}'s residencies     Many No  
visas Visas EntityVisaList Gets this {@link EntityContract}'s visas     Many 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