org.opencrx.kernel.account1.cci
Interface Contact

All Superinterfaces:

AbstractAccount, Account, AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, CrxObject, ExtentCapable, GenericAccount, Importer, Indexed, Pictured, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, SubscriptionTarget, ViewCapable, XmlExporter

All Known Implementing Classes:

ContactImpl

public interface Contact
extends Account, Pictured

Method Summary

void	addContactRelationship(ContactRelationship newValue)
void	addContactRelationship(String id, ContactRelationship newValue)
ExportResult	exportVCard(ExportVCardParams params)
ExportResult	exportVCard(short locale)
Date	getAnniversary()
BigDecimal	getAnnualIncomeAmount()
Short	getAnnualIncomeCurrency()
Account	getAssistant() Retrieves the value for the optional reference assistant.
Date	getBirthdate()
List	getChildrenNames()
String	getChildrenNames(int index)
Collection	getContactRelationship() Retrieves a collection containing all the elements for the reference contactRelationship.
List	getContactRelationship(ContactRelationshipFilter filter) Retrieves the value for the reference contactRelationship for the specified filter.
List	getContactRelationship(ContactRelationshipQuery query) Retrieves the value for the reference contactRelationship for the specified query.
ContactRelationship	getContactRelationship(String id) Retrieves the value for the reference contactRelationship for the specified qualifier attribute value.
String	getDepartment()
Account	getDeputy() Retrieves the value for the optional reference deputy.
short	getEducation() Retrieves the value for the attribute education.
short	getFamilyStatus() Retrieves the value for the attribute familyStatus.
String	getFirstName()
short	getGender() Retrieves the value for the attribute gender.
String	getGovernmentId()
String	getJobRole()
String	getJobTitle()
String	getLastName()
String	getMiddleName()
String	getNickName()
Short	getNumberOfChildren()
String	getOrganization()
Collection	getOuMembership() Retrieves the objects referenced by ouMembership.
OrganizationalUnit	getOuMembership(int index) Retrieves the value for the reference ouMembership for the specified qualifier attribute value.
short	getPreferredContactMethod() Retrieves the value for the attribute preferredContactMethod.
short	getPreferredSpokenLanguage() Retrieves the value for the attribute preferredSpokenLanguage.
short	getPreferredWrittenLanguage() Retrieves the value for the attribute preferredWrittenLanguage.
Contact	getReportsTo() Retrieves the value for the optional reference reportsTo.
String	getSalutation()
short	getSalutationCode() Retrieves the value for the attribute salutationCode.
String	getSuffix()
Boolean	isDoNotBulkPostalMail()
Boolean	isDoNotEMail()
Boolean	isDoNotFax()
Boolean	isDoNotPhone()
Boolean	isDoNotPostalMail()
void	removeAssistant() Removes the value for the optional reference assistant.
void	removeContactRelationship(String id)
void	removeDeputy() Removes the value for the optional reference deputy.
void	removeReportsTo() Removes the value for the optional reference reportsTo.
void	setAnniversary(Date newValue) Sets a new value for the attribute anniversary.
void	setAnnualIncomeAmount(BigDecimal newValue) Sets a new value for the attribute annualIncomeAmount.
void	setAnnualIncomeCurrency(Short newValue) Sets a new value for the attribute annualIncomeCurrency.
void	setAssistant(Account newValue) Sets a new value for the reference assistant.
void	setBirthdate(Date newValue) Sets a new value for the attribute birthdate.
void	setChildrenNames(List newValue)
void	setChildrenNames(String[] newValue)
void	setDepartment(String newValue) Sets a new value for the attribute department.
void	setDeputy(Account newValue) Sets a new value for the reference deputy.
void	setDoNotBulkPostalMail(Boolean newValue) Sets a new value for the attribute doNotBulkPostalMail.
void	setDoNotEMail(Boolean newValue) Sets a new value for the attribute doNotEMail.
void	setDoNotFax(Boolean newValue) Sets a new value for the attribute doNotFax.
void	setDoNotPhone(Boolean newValue) Sets a new value for the attribute doNotPhone.
void	setDoNotPostalMail(Boolean newValue) Sets a new value for the attribute doNotPostalMail.
void	setEducation(short newValue) Sets a new value for the attribute education.
void	setFamilyStatus(short newValue) Sets a new value for the attribute familyStatus.
void	setFirstName(String newValue) Sets a new value for the attribute firstName.
void	setGender(short newValue) Sets a new value for the attribute gender.
void	setGovernmentId(String newValue) Sets a new value for the attribute governmentId.
void	setJobRole(String newValue) Sets a new value for the attribute jobRole.
void	setJobTitle(String newValue) Sets a new value for the attribute jobTitle.
void	setLastName(String newValue) Sets a new value for the attribute lastName.
void	setMiddleName(String newValue) Sets a new value for the attribute middleName.
void	setNickName(String newValue) Sets a new value for the attribute nickName.
void	setNumberOfChildren(Short newValue) Sets a new value for the attribute numberOfChildren.
void	setOrganization(String newValue) Sets a new value for the attribute organization.
void	setPreferredContactMethod(short newValue) Sets a new value for the attribute preferredContactMethod.
void	setPreferredSpokenLanguage(short newValue) Sets a new value for the attribute preferredSpokenLanguage.
void	setPreferredWrittenLanguage(short newValue) Sets a new value for the attribute preferredWrittenLanguage.
void	setReportsTo(Contact newValue) Sets a new value for the reference reportsTo.
void	setSalutation(String newValue) Sets a new value for the attribute salutation.
void	setSalutationCode(short newValue) Sets a new value for the attribute salutationCode.
void	setSuffix(String newValue) Sets a new value for the attribute suffix.

Methods inherited from interface org.opencrx.kernel.account1.cci.Account

addAddress, addAddress, addContact, addContact, addPartner, addPartner, createInvoice, createInvoice, createLead, createLead, createOpportunity, createOpportunity, createQuote, createQuote, createSalesOrder, createSalesOrder, getAddress, getAddress, getAddress, getAddress, getAssignedActivity, getAssignedActivity, getAssignedActivity, getAssignedActivity, getAssignedContract, getAssignedContract, getAssignedContract, getAssignedContract, getContact, getContact, getGroupMembership, getGroupMembership, getGroupMembership, getGroupMembership, getMaster, getPartner, getPartner, getProduct, getProduct, getProduct, getProduct, removeAddress, removeContact, removeMaster, removePartner, setMaster

Methods inherited from interface org.opencrx.kernel.account1.cci.AbstractAccount

getAccountCategory, getAccountCategory, getAccountRating, getAccountState, getAccountType, getAccountType, getAliasName, getBusinessType, getBusinessType, getDescription, getFullName, setAccountCategory, setAccountCategory, setAccountRating, setAccountState, setAccountType, setAccountType, setAliasName, setBusinessType, setBusinessType, setDescription

Methods inherited from interface org.opencrx.kernel.generic.cci.CrxObject

addAdditionalExternalLink, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addMedia, addMedia, addNote, addNote, addPropertySet, addPropertySet, addRating, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getCategory, getDisabledReason, getExternalLink, getExternalLink, getMedia, getMedia, getMedia, getMedia, getNote, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, isUserBoolean4, isUserBoolean4, removeAdditionalExternalLink, removeAttachedDocument, removeMedia, removeNote, removePropertySet, removeRating, setCategory, setCategory, setDisabled, setDisabledReason, setExternalLink, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4, setUserString4

Methods inherited from interface org.opencrx.kernel.base.cci.AlertSender

sendAlert, sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci.Auditee

getAudit, getAudit, getAudit, getAudit

Methods inherited from interface org.opencrx.kernel.base.cci.Cloneable

clone_, clone_

Methods inherited from interface org.opencrx.kernel.base.cci.Importer

importItem, importItem

Methods inherited from interface org.opencrx.kernel.base.cci.Indexed

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci.SecureObject

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci.SubscriptionTarget

addSubscription, addSubscription, addSubscriptionForParent, addSubscriptionForParent, removeSubscription, removeSubscription, removeSubscriptionForParent, removeSubscriptionForParent

Methods inherited from interface org.opencrx.kernel.base.cci.XmlExporter

exportXml, exportXml

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.base.cci.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface org.opencrx.kernel.generic.cci.Pictured

getPicture, getPictureContent, getPictureContentMimeType, getPictureContentName, removePicture, setPicture

Method Detail

getAnniversary

Date getAnniversary()

Returns:

The possibly null value for attribute anniversary.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setAnniversary

void setAnniversary(Date newValue)

Sets a new value for the attribute anniversary.

Parameters:

newValue - The possibly null new value for attribute anniversary.

Throws:

JmiException - If the value cannot be set for some reason.

getAnnualIncomeAmount

BigDecimal getAnnualIncomeAmount()

Returns:

The possibly null value for attribute annualIncomeAmount.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setAnnualIncomeAmount

void setAnnualIncomeAmount(BigDecimal newValue)

Sets a new value for the attribute annualIncomeAmount.

Parameters:

newValue - The possibly null new value for attribute annualIncomeAmount.

Throws:

JmiException - If the value cannot be set for some reason.

getAnnualIncomeCurrency

Short getAnnualIncomeCurrency()

Returns:

The possibly null value for attribute annualIncomeCurrency.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setAnnualIncomeCurrency

void setAnnualIncomeCurrency(Short newValue)

Sets a new value for the attribute annualIncomeCurrency.

Parameters:

newValue - The possibly null new value for attribute annualIncomeCurrency.

Throws:

JmiException - If the value cannot be set for some reason.

getAssistant

Account getAssistant()

Retrieves the value for the optional reference assistant.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setAssistant

void setAssistant(Account newValue)

Sets a new value for the reference assistant.

Parameters:

newValue - The non-null new value for this reference.

Throws:

JmiException - If the value cannot be set for some reason.

removeAssistant

void removeAssistant()

Removes the value for the optional reference assistant.

Throws:

JmiException - If the value cannot be removed for some reason.

getBirthdate

Date getBirthdate()

Returns:

The possibly null value for attribute birthdate.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setBirthdate

void setBirthdate(Date newValue)

Sets a new value for the attribute birthdate.

Parameters:

newValue - The possibly null new value for attribute birthdate.

Throws:

JmiException - If the value cannot be set for some reason.

getChildrenNames

List getChildrenNames()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getChildrenNames

String getChildrenNames(int index)

Parameters:

index - The index of the element to return.

Returns:

The element at the specified position in the list of all values for this attribute.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setChildrenNames

void setChildrenNames(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setChildrenNames

void setChildrenNames(String[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getContactRelationship

ContactRelationship getContactRelationship(String id)

Retrieves the value for the reference contactRelationship for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getContactRelationship

Collection getContactRelationship()

Retrieves a collection containing all the elements for the reference contactRelationship.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getContactRelationship

List getContactRelationship(ContactRelationshipFilter filter)

Retrieves the value for the reference contactRelationship for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getContactRelationship

List getContactRelationship(ContactRelationshipQuery query)

Retrieves the value for the reference contactRelationship for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addContactRelationship

void addContactRelationship(String id,
                            ContactRelationship newValue)

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addContactRelationship

void addContactRelationship(ContactRelationship newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeContactRelationship

void removeContactRelationship(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getDepartment

String getDepartment()

Returns:

The possibly null value for attribute department.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDepartment

void setDepartment(String newValue)

Sets a new value for the attribute department.

Parameters:

newValue - The possibly null new value for attribute department.

Throws:

JmiException - If the value cannot be set for some reason.

getDeputy

Account getDeputy()

Retrieves the value for the optional reference deputy.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDeputy

void setDeputy(Account newValue)

Sets a new value for the reference deputy.

Parameters:

newValue - The non-null new value for this reference.

Throws:

JmiException - If the value cannot be set for some reason.

removeDeputy

void removeDeputy()

Removes the value for the optional reference deputy.

Throws:

JmiException - If the value cannot be removed for some reason.

isDoNotBulkPostalMail

Boolean isDoNotBulkPostalMail()

Returns:

The possibly null value for attribute doNotBulkPostalMail.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDoNotBulkPostalMail

void setDoNotBulkPostalMail(Boolean newValue)

Sets a new value for the attribute doNotBulkPostalMail.

Parameters:

newValue - The possibly null new value for attribute doNotBulkPostalMail.

Throws:

JmiException - If the value cannot be set for some reason.

isDoNotEMail

Boolean isDoNotEMail()

Returns:

The possibly null value for attribute doNotEMail.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDoNotEMail

void setDoNotEMail(Boolean newValue)

Sets a new value for the attribute doNotEMail.

Parameters:

newValue - The possibly null new value for attribute doNotEMail.

Throws:

JmiException - If the value cannot be set for some reason.

isDoNotFax

Boolean isDoNotFax()

Returns:

The possibly null value for attribute doNotFax.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDoNotFax

void setDoNotFax(Boolean newValue)

Sets a new value for the attribute doNotFax.

Parameters:

newValue - The possibly null new value for attribute doNotFax.

Throws:

JmiException - If the value cannot be set for some reason.

isDoNotPhone

Boolean isDoNotPhone()

Returns:

The possibly null value for attribute doNotPhone.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDoNotPhone

void setDoNotPhone(Boolean newValue)

Sets a new value for the attribute doNotPhone.

Parameters:

newValue - The possibly null new value for attribute doNotPhone.

Throws:

JmiException - If the value cannot be set for some reason.

isDoNotPostalMail

Boolean isDoNotPostalMail()

Returns:

The possibly null value for attribute doNotPostalMail.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDoNotPostalMail

void setDoNotPostalMail(Boolean newValue)

Sets a new value for the attribute doNotPostalMail.

Parameters:

newValue - The possibly null new value for attribute doNotPostalMail.

Throws:

JmiException - If the value cannot be set for some reason.

getEducation

short getEducation()

Retrieves the value for the attribute education.

Returns:

The non-null value for attribute education.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setEducation

void setEducation(short newValue)

Sets a new value for the attribute education.

Parameters:

newValue - The non-null new value for attribute education.

Throws:

JmiException - If the value cannot be set for some reason.

exportVCard

ExportResult exportVCard(ExportVCardParams params)
                         throws RefException

Throws:

RefException