Liferay 6.2.0

com.liferay.portal.model
Interface ContactModel

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<Contact>, ClassedModel, Cloneable, Comparable<Contact>, Serializable, TypedModel
All Known Subinterfaces:
Contact
All Known Implementing Classes:
ContactWrapper

@ProviderType
public interface ContactModel
extends AttachedModel, AuditedModel, BaseModel<Contact>

The base model interface for the Contact service. Represents a row in the "Contact_" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation ContactModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in ContactImpl.

See Also:
Contact, ContactImpl, ContactModelImpl

Method Summary
abstract  Object clone()
          Creates a shallow clone of this model instance.
abstract  int compareTo(Contact contact)
           
abstract  long getAccountId()
          Returns the account ID of this contact.
abstract  String getAimSn()
          Returns the aim sn of this contact.
abstract  Date getBirthday()
          Returns the birthday of this contact.
abstract  String getClassName()
          Returns the fully qualified class name of this contact.
abstract  long getClassNameId()
          Returns the class name ID of this contact.
abstract  long getClassPK()
          Returns the class p k of this contact.
abstract  long getCompanyId()
          Returns the company ID of this contact.
abstract  long getContactId()
          Returns the contact ID of this contact.
abstract  Date getCreateDate()
          Returns the create date of this contact.
abstract  String getEmailAddress()
          Returns the email address of this contact.
abstract  String getEmployeeNumber()
          Returns the employee number of this contact.
abstract  String getEmployeeStatusId()
          Returns the employee status ID of this contact.
abstract  ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
abstract  String getFacebookSn()
          Returns the facebook sn of this contact.
abstract  String getFirstName()
          Returns the first name of this contact.
abstract  String getHoursOfOperation()
          Returns the hours of operation of this contact.
abstract  String getIcqSn()
          Returns the icq sn of this contact.
abstract  String getJabberSn()
          Returns the jabber sn of this contact.
abstract  String getJobClass()
          Returns the job class of this contact.
abstract  String getJobTitle()
          Returns the job title of this contact.
abstract  String getLastName()
          Returns the last name of this contact.
abstract  boolean getMale()
          Returns the male of this contact.
abstract  String getMiddleName()
          Returns the middle name of this contact.
abstract  Date getModifiedDate()
          Returns the modified date of this contact.
abstract  String getMsnSn()
          Returns the msn sn of this contact.
abstract  String getMySpaceSn()
          Returns the my space sn of this contact.
abstract  long getParentContactId()
          Returns the parent contact ID of this contact.
abstract  int getPrefixId()
          Returns the prefix ID of this contact.
abstract  long getPrimaryKey()
          Returns the primary key of this contact.
abstract  Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
abstract  String getSkypeSn()
          Returns the skype sn of this contact.
abstract  String getSmsSn()
          Returns the sms sn of this contact.
abstract  int getSuffixId()
          Returns the suffix ID of this contact.
abstract  String getTwitterSn()
          Returns the twitter sn of this contact.
abstract  long getUserId()
          Returns the user ID of this contact.
abstract  String getUserName()
          Returns the user name of this contact.
abstract  String getUserUuid()
          Returns the user uuid of this contact.
abstract  String getYmSn()
          Returns the ym sn of this contact.
abstract  int hashCode()
           
abstract  boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
abstract  boolean isEscapedModel()
          Returns true if this model instance is escaped.
abstract  boolean isMale()
          Returns true if this contact is male.
abstract  boolean isNew()
          Returns true if this model instance does not yet exist in the database.
abstract  void setAccountId(long accountId)
          Sets the account ID of this contact.
abstract  void setAimSn(String aimSn)
          Sets the aim sn of this contact.
abstract  void setBirthday(Date birthday)
          Sets the birthday of this contact.
abstract  void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
abstract  void setClassName(String className)
           
abstract  void setClassNameId(long classNameId)
          Sets the class name ID of this contact.
abstract  void setClassPK(long classPK)
          Sets the class p k of this contact.
abstract  void setCompanyId(long companyId)
          Sets the company ID of this contact.
abstract  void setContactId(long contactId)
          Sets the contact ID of this contact.
abstract  void setCreateDate(Date createDate)
          Sets the create date of this contact.
abstract  void setEmailAddress(String emailAddress)
          Sets the email address of this contact.
abstract  void setEmployeeNumber(String employeeNumber)
          Sets the employee number of this contact.
abstract  void setEmployeeStatusId(String employeeStatusId)
          Sets the employee status ID of this contact.
abstract  void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
abstract  void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
abstract  void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
abstract  void setFacebookSn(String facebookSn)
          Sets the facebook sn of this contact.
abstract  void setFirstName(String firstName)
          Sets the first name of this contact.
abstract  void setHoursOfOperation(String hoursOfOperation)
          Sets the hours of operation of this contact.
abstract  void setIcqSn(String icqSn)
          Sets the icq sn of this contact.
abstract  void setJabberSn(String jabberSn)
          Sets the jabber sn of this contact.
abstract  void setJobClass(String jobClass)
          Sets the job class of this contact.
abstract  void setJobTitle(String jobTitle)
          Sets the job title of this contact.
abstract  void setLastName(String lastName)
          Sets the last name of this contact.
abstract  void setMale(boolean male)
          Sets whether this contact is male.
abstract  void setMiddleName(String middleName)
          Sets the middle name of this contact.
abstract  void setModifiedDate(Date modifiedDate)
          Sets the modified date of this contact.
abstract  void setMsnSn(String msnSn)
          Sets the msn sn of this contact.
abstract  void setMySpaceSn(String mySpaceSn)
          Sets the my space sn of this contact.
abstract  void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
abstract  void setParentContactId(long parentContactId)
          Sets the parent contact ID of this contact.
abstract  void setPrefixId(int prefixId)
          Sets the prefix ID of this contact.
abstract  void setPrimaryKey(long primaryKey)
          Sets the primary key of this contact.
abstract  void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
abstract  void setSkypeSn(String skypeSn)
          Sets the skype sn of this contact.
abstract  void setSmsSn(String smsSn)
          Sets the sms sn of this contact.
abstract  void setSuffixId(int suffixId)
          Sets the suffix ID of this contact.
abstract  void setTwitterSn(String twitterSn)
          Sets the twitter sn of this contact.
abstract  void setUserId(long userId)
          Sets the user ID of this contact.
abstract  void setUserName(String userName)
          Sets the user name of this contact.
abstract  void setUserUuid(String userUuid)
          Sets the user uuid of this contact.
abstract  void setYmSn(String ymSn)
          Sets the ym sn of this contact.
abstract  CacheModel<Contact> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
abstract  Contact toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
abstract  String toString()
           
abstract  Contact toUnescapedModel()
           
abstract  String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this contact.

Returns:
the primary key of this contact

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this contact.

Parameters:
primaryKey - the primary key of this contact

getContactId

long getContactId()
Returns the contact ID of this contact.

Returns:
the contact ID of this contact

setContactId

void setContactId(long contactId)
Sets the contact ID of this contact.

Parameters:
contactId - the contact ID of this contact

getCompanyId

long getCompanyId()
Returns the company ID of this contact.

Specified by:
getCompanyId in interface AuditedModel
Returns:
the company ID of this contact

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this contact.

Specified by:
setCompanyId in interface AuditedModel
Parameters:
companyId - the company ID of this contact

getUserId

long getUserId()
Returns the user ID of this contact.

Specified by:
getUserId in interface AuditedModel
Returns:
the user ID of this contact

setUserId

void setUserId(long userId)
Sets the user ID of this contact.

Specified by:
setUserId in interface AuditedModel
Parameters:
userId - the user ID of this contact

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this contact.

Specified by:
getUserUuid in interface AuditedModel
Returns:
the user uuid of this contact
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this contact.

Specified by:
setUserUuid in interface AuditedModel
Parameters:
userUuid - the user uuid of this contact

getUserName

@AutoEscape
String getUserName()
Returns the user name of this contact.

Specified by:
getUserName in interface AuditedModel
Returns:
the user name of this contact

setUserName

void setUserName(String userName)
Sets the user name of this contact.

Specified by:
setUserName in interface AuditedModel
Parameters:
userName - the user name of this contact

getCreateDate

Date getCreateDate()
Returns the create date of this contact.

Specified by:
getCreateDate in interface AuditedModel
Returns:
the create date of this contact

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this contact.

Specified by:
setCreateDate in interface AuditedModel
Parameters:
createDate - the create date of this contact

getModifiedDate

Date getModifiedDate()
Returns the modified date of this contact.

Specified by:
getModifiedDate in interface AuditedModel
Returns:
the modified date of this contact

setModifiedDate

void setModifiedDate(Date modifiedDate)
Sets the modified date of this contact.

Specified by:
setModifiedDate in interface AuditedModel
Parameters:
modifiedDate - the modified date of this contact

getClassName

String getClassName()
Returns the fully qualified class name of this contact.

Specified by:
getClassName in interface TypedModel
Returns:
the fully qualified class name of this contact

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()
Returns the class name ID of this contact.

Specified by:
getClassNameId in interface TypedModel
Returns:
the class name ID of this contact

setClassNameId

void setClassNameId(long classNameId)
Sets the class name ID of this contact.

Specified by:
setClassNameId in interface TypedModel
Parameters:
classNameId - the class name ID of this contact

getClassPK

long getClassPK()
Returns the class p k of this contact.

Specified by:
getClassPK in interface AttachedModel
Returns:
the class p k of this contact

setClassPK

void setClassPK(long classPK)
Sets the class p k of this contact.

Specified by:
setClassPK in interface AttachedModel
Parameters:
classPK - the class p k of this contact

getAccountId

long getAccountId()
Returns the account ID of this contact.

Returns:
the account ID of this contact

setAccountId

void setAccountId(long accountId)
Sets the account ID of this contact.

Parameters:
accountId - the account ID of this contact

getParentContactId

long getParentContactId()
Returns the parent contact ID of this contact.

Returns:
the parent contact ID of this contact

setParentContactId

void setParentContactId(long parentContactId)
Sets the parent contact ID of this contact.

Parameters:
parentContactId - the parent contact ID of this contact

getEmailAddress

@AutoEscape
String getEmailAddress()
Returns the email address of this contact.

Returns:
the email address of this contact

setEmailAddress

void setEmailAddress(String emailAddress)
Sets the email address of this contact.

Parameters:
emailAddress - the email address of this contact

getFirstName

@AutoEscape
String getFirstName()
Returns the first name of this contact.

Returns:
the first name of this contact

setFirstName

void setFirstName(String firstName)
Sets the first name of this contact.

Parameters:
firstName - the first name of this contact

getMiddleName

@AutoEscape
String getMiddleName()
Returns the middle name of this contact.

Returns:
the middle name of this contact

setMiddleName

void setMiddleName(String middleName)
Sets the middle name of this contact.

Parameters:
middleName - the middle name of this contact

getLastName

@AutoEscape
String getLastName()
Returns the last name of this contact.

Returns:
the last name of this contact

setLastName

void setLastName(String lastName)
Sets the last name of this contact.

Parameters:
lastName - the last name of this contact

getPrefixId

int getPrefixId()
Returns the prefix ID of this contact.

Returns:
the prefix ID of this contact

setPrefixId

void setPrefixId(int prefixId)
Sets the prefix ID of this contact.

Parameters:
prefixId - the prefix ID of this contact

getSuffixId

int getSuffixId()
Returns the suffix ID of this contact.

Returns:
the suffix ID of this contact

setSuffixId

void setSuffixId(int suffixId)
Sets the suffix ID of this contact.

Parameters:
suffixId - the suffix ID of this contact

getMale

boolean getMale()
Returns the male of this contact.

Returns:
the male of this contact

isMale

boolean isMale()
Returns true if this contact is male.

Returns:
true if this contact is male; false otherwise

setMale

void setMale(boolean male)
Sets whether this contact is male.

Parameters:
male - the male of this contact

getBirthday

Date getBirthday()
Returns the birthday of this contact.

Returns:
the birthday of this contact

setBirthday

void setBirthday(Date birthday)
Sets the birthday of this contact.

Parameters:
birthday - the birthday of this contact

getSmsSn

@AutoEscape
String getSmsSn()
Returns the sms sn of this contact.

Returns:
the sms sn of this contact

setSmsSn

void setSmsSn(String smsSn)
Sets the sms sn of this contact.

Parameters:
smsSn - the sms sn of this contact

getAimSn

@AutoEscape
String getAimSn()
Returns the aim sn of this contact.

Returns:
the aim sn of this contact

setAimSn

void setAimSn(String aimSn)
Sets the aim sn of this contact.

Parameters:
aimSn - the aim sn of this contact

getFacebookSn

@AutoEscape
String getFacebookSn()
Returns the facebook sn of this contact.

Returns:
the facebook sn of this contact

setFacebookSn

void setFacebookSn(String facebookSn)
Sets the facebook sn of this contact.

Parameters:
facebookSn - the facebook sn of this contact

getIcqSn

@AutoEscape
String getIcqSn()
Returns the icq sn of this contact.

Returns:
the icq sn of this contact

setIcqSn

void setIcqSn(String icqSn)
Sets the icq sn of this contact.

Parameters:
icqSn - the icq sn of this contact

getJabberSn

@AutoEscape
String getJabberSn()
Returns the jabber sn of this contact.

Returns:
the jabber sn of this contact

setJabberSn

void setJabberSn(String jabberSn)
Sets the jabber sn of this contact.

Parameters:
jabberSn - the jabber sn of this contact

getMsnSn

@AutoEscape
String getMsnSn()
Returns the msn sn of this contact.

Returns:
the msn sn of this contact

setMsnSn

void setMsnSn(String msnSn)
Sets the msn sn of this contact.

Parameters:
msnSn - the msn sn of this contact

getMySpaceSn

@AutoEscape
String getMySpaceSn()
Returns the my space sn of this contact.

Returns:
the my space sn of this contact

setMySpaceSn

void setMySpaceSn(String mySpaceSn)
Sets the my space sn of this contact.

Parameters:
mySpaceSn - the my space sn of this contact

getSkypeSn

@AutoEscape
String getSkypeSn()
Returns the skype sn of this contact.

Returns:
the skype sn of this contact

setSkypeSn

void setSkypeSn(String skypeSn)
Sets the skype sn of this contact.

Parameters:
skypeSn - the skype sn of this contact

getTwitterSn

@AutoEscape
String getTwitterSn()
Returns the twitter sn of this contact.

Returns:
the twitter sn of this contact

setTwitterSn

void setTwitterSn(String twitterSn)
Sets the twitter sn of this contact.

Parameters:
twitterSn - the twitter sn of this contact

getYmSn

@AutoEscape
String getYmSn()
Returns the ym sn of this contact.

Returns:
the ym sn of this contact

setYmSn

void setYmSn(String ymSn)
Sets the ym sn of this contact.

Parameters:
ymSn - the ym sn of this contact

getEmployeeStatusId

@AutoEscape
String getEmployeeStatusId()
Returns the employee status ID of this contact.

Returns:
the employee status ID of this contact

setEmployeeStatusId

void setEmployeeStatusId(String employeeStatusId)
Sets the employee status ID of this contact.

Parameters:
employeeStatusId - the employee status ID of this contact

getEmployeeNumber

@AutoEscape
String getEmployeeNumber()
Returns the employee number of this contact.

Returns:
the employee number of this contact

setEmployeeNumber

void setEmployeeNumber(String employeeNumber)
Sets the employee number of this contact.

Parameters:
employeeNumber - the employee number of this contact

getJobTitle

@AutoEscape
String getJobTitle()
Returns the job title of this contact.

Returns:
the job title of this contact

setJobTitle

void setJobTitle(String jobTitle)
Sets the job title of this contact.

Parameters:
jobTitle - the job title of this contact

getJobClass

@AutoEscape
String getJobClass()
Returns the job class of this contact.

Returns:
the job class of this contact

setJobClass

void setJobClass(String jobClass)
Sets the job class of this contact.

Parameters:
jobClass - the job class of this contact

getHoursOfOperation

@AutoEscape
String getHoursOfOperation()
Returns the hours of operation of this contact.

Returns:
the hours of operation of this contact

setHoursOfOperation

void setHoursOfOperation(String hoursOfOperation)
Sets the hours of operation of this contact.

Parameters:
hoursOfOperation - the hours of operation of this contact

isNew

boolean isNew()
Description copied from interface: BaseModel
Returns true if this model instance does not yet exist in the database.

Specified by:
isNew in interface BaseModel<Contact>
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)
Description copied from interface: BaseModel
Sets whether this model instance does not yet exist in the database.

Specified by:
setNew in interface BaseModel<Contact>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<Contact>
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)
Description copied from interface: BaseModel
Sets whether this model instance was retrieved from the entity cache.

Specified by:
setCachedModel in interface BaseModel<Contact>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Contact>
Returns:
true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<Contact>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Returns:
the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<Contact>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Parameters:
primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<Contact>
Specified by:
getExpandoBridge in interface ClassedModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Contact>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Contact>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)
Description copied from interface: BaseModel
Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:
setExpandoBridgeAttributes in interface BaseModel<Contact>
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<Contact>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(Contact contact)
Specified by:
compareTo in interface Comparable<Contact>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<Contact> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<Contact>
Returns:
the cache model object

toEscapedModel

Contact toEscapedModel()
Description copied from interface: BaseModel
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<Contact>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

Contact toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<Contact>

toString

String toString()
Overrides:
toString in class Object

toXmlString

String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<Contact>
Returns:
the XML representation of this model instance

Liferay 6.2.0