Liferay 6.0-ee

com.liferay.portal.model
Interface ContactModel

All Superinterfaces:
BaseModel<Contact>, Cloneable, Comparable<Contact>, Serializable
All Known Subinterfaces:
Contact
All Known Implementing Classes:
ContactImpl, ContactModelImpl, ContactWrapper

public interface ContactModel
extends 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.

Never modify or reference this interface directly. All methods that expect a contact model instance should use the Contact interface instead.

See Also:
Contact, ContactImpl, ContactModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Contact contact)
           
 long getAccountId()
          Gets the account id of this contact.
 String getAimSn()
          Gets the aim sn of this contact.
 Date getBirthday()
          Gets the birthday of this contact.
 long getCompanyId()
          Gets the company id of this contact.
 long getContactId()
          Gets the contact id of this contact.
 Date getCreateDate()
          Gets the create date of this contact.
 String getEmployeeNumber()
          Gets the employee number of this contact.
 String getEmployeeStatusId()
          Gets the employee status id of this contact.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getFacebookSn()
          Gets the facebook sn of this contact.
 String getFirstName()
          Gets the first name of this contact.
 String getHoursOfOperation()
          Gets the hours of operation of this contact.
 String getIcqSn()
          Gets the icq sn of this contact.
 String getJabberSn()
          Gets the jabber sn of this contact.
 String getJobClass()
          Gets the job class of this contact.
 String getJobTitle()
          Gets the job title of this contact.
 String getLastName()
          Gets the last name of this contact.
 boolean getMale()
          Gets the male of this contact.
 String getMiddleName()
          Gets the middle name of this contact.
 Date getModifiedDate()
          Gets the modified date of this contact.
 String getMsnSn()
          Gets the msn sn of this contact.
 String getMySpaceSn()
          Gets the my space sn of this contact.
 long getParentContactId()
          Gets the parent contact id of this contact.
 int getPrefixId()
          Gets the prefix id of this contact.
 long getPrimaryKey()
          Gets the primary key of this contact.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 String getSkypeSn()
          Gets the skype sn of this contact.
 String getSmsSn()
          Gets the sms sn of this contact.
 int getSuffixId()
          Gets the suffix id of this contact.
 String getTwitterSn()
          Gets the twitter sn of this contact.
 long getUserId()
          Gets the user id of this contact.
 String getUserName()
          Gets the user name of this contact.
 String getUserUuid()
          Gets the user uuid of this contact.
 String getYmSn()
          Gets the ym sn of this contact.
 int hashCode()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Determines if this model instance is escaped.
 boolean isMale()
          Determines whether this contact is male.
 boolean isNew()
          Determines if this model instance does not yet exist in the database.
 void setAccountId(long accountId)
          Sets the account id of this contact.
 void setAimSn(String aimSn)
          Sets the aim sn of this contact.
 void setBirthday(Date birthday)
          Sets the birthday of this contact.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setCompanyId(long companyId)
          Sets the company id of this contact.
 void setContactId(long contactId)
          Sets the contact id of this contact.
 void setCreateDate(Date createDate)
          Sets the create date of this contact.
 void setEmployeeNumber(String employeeNumber)
          Sets the employee number of this contact.
 void setEmployeeStatusId(String employeeStatusId)
          Sets the employee status id of this contact.
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setFacebookSn(String facebookSn)
          Sets the facebook sn of this contact.
 void setFirstName(String firstName)
          Sets the first name of this contact.
 void setHoursOfOperation(String hoursOfOperation)
          Sets the hours of operation of this contact.
 void setIcqSn(String icqSn)
          Sets the icq sn of this contact.
 void setJabberSn(String jabberSn)
          Sets the jabber sn of this contact.
 void setJobClass(String jobClass)
          Sets the job class of this contact.
 void setJobTitle(String jobTitle)
          Sets the job title of this contact.
 void setLastName(String lastName)
          Sets the last name of this contact.
 void setMale(boolean male)
          Sets whether this {$entity.humanName} is male.
 void setMiddleName(String middleName)
          Sets the middle name of this contact.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this contact.
 void setMsnSn(String msnSn)
          Sets the msn sn of this contact.
 void setMySpaceSn(String mySpaceSn)
          Sets the my space sn of this contact.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentContactId(long parentContactId)
          Sets the parent contact id of this contact.
 void setPrefixId(int prefixId)
          Sets the prefix id of this contact.
 void setPrimaryKey(long pk)
          Sets the primary key of this contact
 void setSkypeSn(String skypeSn)
          Sets the skype sn of this contact.
 void setSmsSn(String smsSn)
          Sets the sms sn of this contact.
 void setSuffixId(int suffixId)
          Sets the suffix id of this contact.
 void setTwitterSn(String twitterSn)
          Sets the twitter sn of this contact.
 void setUserId(long userId)
          Sets the user id of this contact.
 void setUserName(String userName)
          Sets the user name of this contact.
 void setUserUuid(String userUuid)
          Sets the user uuid of this contact.
 void setYmSn(String ymSn)
          Sets the ym sn of this contact.
 Contact toEscapedModel()
          Gets a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

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

Returns:
the primary key of this contact

setPrimaryKey

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

Parameters:
pk - the primary key of this contact

getContactId

long getContactId()
Gets 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()
Gets the company id of this contact.

Returns:
the company id of this contact

setCompanyId

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

Parameters:
companyId - the company id of this contact

getUserId

long getUserId()
Gets the user id of this contact.

Returns:
the user id of this contact

setUserId

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

Parameters:
userId - the user id of this contact

getUserUuid

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

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.

Parameters:
userUuid - the user uuid of this contact

getUserName

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

Returns:
the user name of this contact

setUserName

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

Parameters:
userName - the user name of this contact

getCreateDate

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

Returns:
the create date of this contact

setCreateDate

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

Parameters:
createDate - the create date of this contact

getModifiedDate

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

Returns:
the modified date of this contact

setModifiedDate

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

Parameters:
modifiedDate - the modified date of this contact

getAccountId

long getAccountId()
Gets 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()
Gets 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

getFirstName

@AutoEscape
String getFirstName()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets the male of this contact.

Returns:
the male of this contact

isMale

boolean isMale()
Determines whether this contact is male.

Returns:
whether this contact is male

setMale

void setMale(boolean male)
Sets whether this {$entity.humanName} is male.

Parameters:
male - the male of this contact

getBirthday

Date getBirthday()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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()
Gets 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
Determines 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
Determines 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
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Contact>
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<Contact>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

getExpandoBridge

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

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

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 retrieve the expando bridge attributes from
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

toEscapedModel

Contact toEscapedModel()
Description copied from interface: BaseModel
Gets 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

toString

String toString()
Overrides:
toString in class Object

toXmlString

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

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

Liferay 6.0-ee