Rolodex (Kuali Coeus 5.1.1 API)

java.lang.Object
- org.kuali.rice.krad.bo.BusinessObjectBase
- - org.kuali.rice.krad.bo.PersistableBusinessObjectBase
  - - org.kuali.kra.bo.KraPersistableBusinessObjectBase
    - - org.kuali.kra.bo.Rolodex

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Contactable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.active.MutableInactivatable, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

Direct Known Subclasses:

NonOrganizationalRolodex, ProtocolPersonRolodexBase
```
public class Rolodex
extends KraPersistableBusinessObjectBase
implements Contactable, org.kuali.rice.core.api.mo.common.active.MutableInactivatable
```
See Also:
Serialized Form

Field Summary
- Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase
  UPDATE_USER_LENGTH
- Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
  extension, versionNumber

Constructor Summary

Constructors
Constructor and Description

Rolodex()

Constructors
Constructor and Description
`Rolodex()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAddressLine1()`
`String`	`getAddressLine2()`
`String`	`getAddressLine3()`
`String`	`getCity()`
`String`	`getComments()`
`String`	`getContactOrganizationName()` This method returns the contact's organization name.
`String`	`getCountryCode()`
`String`	`getCounty()`
`String`	`getCreateUser()`
`Boolean`	`getDeleteFlag()`
`String`	`getEmailAddress()` This method returns the contact's e-mail address.
`String`	`getFaxNumber()`
`String`	`getFirstName()`
`String`	`getFullName()` Gets the full name is format (Last, First Middle) Will also leave out any name that does not exist.
`Serializable`	`getIdentifier()` This method returns the serializable identifier of the contact.
`String`	`getIsSponsorAddress()` Gets the isSponsorAddress attribute.
`String`	`getLastName()`
`String`	`getMiddleName()`
`String`	`getOrganization()`
`String`	`getOrganizationIdentifier()` This method returns the contact's associated unit number.
`Organization`	`getOrganizations()`
`String`	`getOwnedByUnit()`
`String`	`getPhoneNumber()` This method returns the contact's phone number.
`String`	`getPostalCode()`
`String`	`getPrefix()`
`Integer`	`getRolodexId()`
`Sponsor`	`getSponsor()` Sponsor reference referred by `getSponsorCode()`
`Boolean`	`getSponsorAddressFlag()`
`String`	`getSponsorCode()`
`String`	`getState()`
`String`	`getSuffix()`
`String`	`getTitle()`
`Unit`	`getUnit()` Unit reference referred by `getOwnedByUnit()`
`boolean`	`isActive()`
`void`	`setActive(boolean active)`
`void`	`setAddressLine1(String addressLine1)`
`void`	`setAddressLine2(String addressLine2)`
`void`	`setAddressLine3(String addressLine3)`
`void`	`setCity(String city)`
`void`	`setComments(String comments)`
`void`	`setCountryCode(String countryCode)`
`void`	`setCounty(String county)`
`void`	`setCreateUser(String createUser)`
`void`	`setDeleteFlag(Boolean deleteFlag)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setFaxNumber(String faxNumber)`
`void`	`setFirstName(String firstName)`
`void`	`setIsSponsorAddress(String isSponsorAddress)` Sets the isSponsorAddress attribute value.
`void`	`setLastName(String lastName)`
`void`	`setMiddleName(String middleName)`
`void`	`setOrganization(String organization)`
`void`	`setOrganizations(Organization organizations)`
`void`	`setOwnedByUnit(String ownedByUnit)`
`void`	`setPhoneNumber(String phoneNumber)`
`void`	`setPostalCode(String postalCode)`
`void`	`setPrefix(String prefix)`
`void`	`setRolodexId(Integer rolodexId)`
`void`	`setSponsor(Sponsor sponsor)` Sponsor reference referred by `getSponsorCode()`
`void`	`setSponsorAddressFlag(Boolean sponsorAddressFlag)`
`void`	`setSponsorCode(String sponsorCode)`
`void`	`setState(String state)`
`void`	`setSuffix(String suffix)`
`void`	`setTitle(String title)`
`void`	`setUnit(Unit unit)` Unit reference referred by `getOwnedByUnit()`
`void`	`setUpdateUser(String updateUser)` Sets the update user, making sure it is not the system user and truncating the name so it will fit.

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase
getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, setUpdateTimestamp, setUpdateUserSet

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic
toString

- Constructor Detail
  - Rolodex
```
public Rolodex()
```
- Method Detail
  - getCreateUser
```
public String getCreateUser()
```
  - setCreateUser
```
public void setCreateUser(String createUser)
```
  - setUpdateUser
```
public void setUpdateUser(String updateUser)
```
    Description copied from class: KraPersistableBusinessObjectBase
    
    Sets the update user, making sure it is not the system user and truncating the name so it will fit.
    
    Overrides:
    
    setUpdateUser in class KraPersistableBusinessObjectBase
    
    Parameters:
    updateUser - the user who updated this object
  - getRolodexId
```
public Integer getRolodexId()
```
  - setRolodexId
```
public void setRolodexId(Integer rolodexId)
```
  - getAddressLine1
```
public String getAddressLine1()
```
  - setAddressLine1
```
public void setAddressLine1(String addressLine1)
```
  - getAddressLine2
```
public String getAddressLine2()
```
  - setAddressLine2
```
public void setAddressLine2(String addressLine2)
```
  - getAddressLine3
```
public String getAddressLine3()
```
  - setAddressLine3
```
public void setAddressLine3(String addressLine3)
```
  - getCity
```
public String getCity()
```
  - setCity
```
public void setCity(String city)
```
  - getComments
```
public String getComments()
```
  - setComments
```
public void setComments(String comments)
```
  - getCountryCode
```
public String getCountryCode()
```
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
  - getCounty
```
public String getCounty()
```
  - setCounty
```
public void setCounty(String county)
```
  - getDeleteFlag
```
public Boolean getDeleteFlag()
```
  - setDeleteFlag
```
public void setDeleteFlag(Boolean deleteFlag)
```
  - getEmailAddress
```
public String getEmailAddress()
```
    Description copied from interface: Contactable
    
    This method returns the contact's e-mail address. May return null.
    
    Specified by:
    
    getEmailAddress in interface Contactable
    
    Returns:
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
  - getFaxNumber
```
public String getFaxNumber()
```
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
  - getFirstName
```
public String getFirstName()
```
    Specified by:
    
    getFirstName in interface Contactable
    
    Returns:
  - setFirstName
```
public void setFirstName(String firstName)
```
  - getLastName
```
public String getLastName()
```
    Specified by:
    
    getLastName in interface Contactable
    
    Returns:
  - setLastName
```
public void setLastName(String lastName)
```
  - getMiddleName
```
public String getMiddleName()
```
  - setMiddleName
```
public void setMiddleName(String middleName)
```
  - getOrganization
```
public String getOrganization()
```
  - setOrganization
```
public void setOrganization(String organization)
```
  - getOwnedByUnit
```
public String getOwnedByUnit()
```
  - setOwnedByUnit
```
public void setOwnedByUnit(String ownedByUnit)
```
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Description copied from interface: Contactable
    
    This method returns the contact's phone number. May return null.
    
    Specified by:
    
    getPhoneNumber in interface Contactable
    
    Returns:
  - setPhoneNumber
```
public void setPhoneNumber(String phoneNumber)
```
  - getPostalCode
```
public String getPostalCode()
```
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
  - getPrefix
```
public String getPrefix()
```
  - setPrefix
```
public void setPrefix(String prefix)
```
  - getSponsorAddressFlag
```
public Boolean getSponsorAddressFlag()
```
  - setSponsorAddressFlag
```
public void setSponsorAddressFlag(Boolean sponsorAddressFlag)
```
  - getIsSponsorAddress
```
public String getIsSponsorAddress()
```
    Gets the isSponsorAddress attribute.
    
    Returns:
    Returns the isSponsorAddress.
  - setIsSponsorAddress
```
public void setIsSponsorAddress(String isSponsorAddress)
```
    Sets the isSponsorAddress attribute value.
    
    Parameters:
    isSponsorAddress - The isSponsorAddress to set.
  - getSponsorCode
```
public String getSponsorCode()
```
  - setSponsorCode
```
public void setSponsorCode(String sponsorCode)
```
  - getState
```
public String getState()
```
  - setState
```
public void setState(String state)
```
  - getSuffix
```
public String getSuffix()
```
  - setSuffix
```
public void setSuffix(String suffix)
```
  - getTitle
```
public String getTitle()
```
  - setTitle
```
public void setTitle(String title)
```
  - setUnit
```
public void setUnit(Unit unit)
```
    Unit reference referred by getOwnedByUnit()
    
    Parameters:
    unit -
  - getUnit
```
public Unit getUnit()
```
    Unit reference referred by getOwnedByUnit()
    
    Specified by:
    
    getUnit in interface Contactable
    
    Returns:
    unit
  - setSponsor
```
public void setSponsor(Sponsor sponsor)
```
    Sponsor reference referred by getSponsorCode()
    
    Parameters:
    sponsor -
  - getSponsor
```
public Sponsor getSponsor()
```
    Sponsor reference referred by getSponsorCode()
    
    Returns:
    Sponsor
  - setOrganizations
```
public void setOrganizations(Organization organizations)
```
  - getOrganizations
```
public Organization getOrganizations()
```
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable
  - setActive
```
public void setActive(boolean active)
```
    Specified by:
    
    setActive in interface org.kuali.rice.core.api.mo.common.active.MutableInactivatable
  - getFullName
```
public String getFullName()
```
    Gets the full name is format (Last, First Middle) Will also leave out any name that does not exist. For example: (Last, First) will be returned when no middle name exists. Will return null if no full name exists.
    
    Specified by:
    
    getFullName in interface Contactable
    
    Returns:
    full name.
  - getContactOrganizationName
```
public String getContactOrganizationName()
```
    This method returns the contact's organization name. May be the unit name or something different. Also, may return null.
    
    Specified by:
    
    getContactOrganizationName in interface Contactable
    
    Returns:
  - getIdentifier
```
public Serializable getIdentifier()
```
    This method returns the serializable identifier of the contact. May return null if no identifier has yet been assigned.
    
    Specified by:
    
    getIdentifier in interface Contactable
    
    Returns:
  - getOrganizationIdentifier
```
public String getOrganizationIdentifier()
```
    This method returns the contact's associated unit number. This is commonly referred to as homeUnit is many places in KC.
    
    Specified by:
    
    getOrganizationIdentifier in interface Contactable
    
    Returns:

Class Rolodex

Field Summary

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

Constructor Summary

Method Summary

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

Constructor Detail

Rolodex

Method Detail

getCreateUser

setCreateUser

setUpdateUser

getRolodexId

setRolodexId

getAddressLine1

setAddressLine1

getAddressLine2

setAddressLine2

getAddressLine3

setAddressLine3

getCity

setCity

getComments

setComments

getCountryCode

setCountryCode

getCounty

setCounty

getDeleteFlag

setDeleteFlag

getEmailAddress

setEmailAddress

getFaxNumber

setFaxNumber

getFirstName

setFirstName

getLastName

setLastName

getMiddleName

setMiddleName

getOrganization

setOrganization

getOwnedByUnit

setOwnedByUnit

getPhoneNumber

setPhoneNumber

getPostalCode

setPostalCode

getPrefix

setPrefix

getSponsorAddressFlag

setSponsorAddressFlag

getIsSponsorAddress

setIsSponsorAddress

getSponsorCode

setSponsorCode

getState

setState

getSuffix

setSuffix

getTitle

setTitle

setUnit

getUnit

setSponsor

getSponsor

setOrganizations

getOrganizations

isActive

setActive

getFullName

getContactOrganizationName

getIdentifier

getOrganizationIdentifier