Liferay 6.0.5

com.liferay.portal.model
Interface PhoneModel

All Superinterfaces:
BaseModel<Phone>, Cloneable, Comparable<Phone>, Serializable
All Known Subinterfaces:
Phone
All Known Implementing Classes:
PhoneImpl, PhoneModelImpl, PhoneWrapper

public interface PhoneModel
extends BaseModel<Phone>

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

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

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

See Also:
Phone, PhoneImpl, PhoneModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Phone phone)
           
 String getClassName()
          Gets the class name of the model instance this phone is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this phone.
 long getClassPK()
          Gets the class p k of this phone.
 long getCompanyId()
          Gets the company id of this phone.
 Date getCreateDate()
          Gets the create date of this phone.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getExtension()
          Gets the extension of this phone.
 Date getModifiedDate()
          Gets the modified date of this phone.
 String getNumber()
          Gets the number of this phone.
 long getPhoneId()
          Gets the phone id of this phone.
 boolean getPrimary()
          Gets the primary of this phone.
 long getPrimaryKey()
          Gets the primary key of this phone.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 int getTypeId()
          Gets the type id of this phone.
 long getUserId()
          Gets the user id of this phone.
 String getUserName()
          Gets the user name of this phone.
 String getUserUuid()
          Gets the user uuid of this phone.
 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 isNew()
          Determines if this model instance does not yet exist in the database.
 boolean isPrimary()
          Determines whether this phone is primary.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassNameId(long classNameId)
          Sets the class name id of this phone.
 void setClassPK(long classPK)
          Sets the class p k of this phone.
 void setCompanyId(long companyId)
          Sets the company id of this phone.
 void setCreateDate(Date createDate)
          Sets the create date of this phone.
 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 setExtension(String extension)
          Sets the extension of this phone.
 void setModifiedDate(Date modifiedDate)
          Sets the modified date of this phone.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setNumber(String number)
          Sets the number of this phone.
 void setPhoneId(long phoneId)
          Sets the phone id of this phone.
 void setPrimary(boolean primary)
          Sets whether this {$entity.humanName} is primary.
 void setPrimaryKey(long pk)
          Sets the primary key of this phone
 void setTypeId(int typeId)
          Sets the type id of this phone.
 void setUserId(long userId)
          Sets the user id of this phone.
 void setUserName(String userName)
          Sets the user name of this phone.
 void setUserUuid(String userUuid)
          Sets the user uuid of this phone.
 Phone toEscapedModel()
          Gets a copy of this phone 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 phone.

Returns:
the primary key of this phone

setPrimaryKey

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

Parameters:
pk - the primary key of this phone

getPhoneId

long getPhoneId()
Gets the phone id of this phone.

Returns:
the phone id of this phone

setPhoneId

void setPhoneId(long phoneId)
Sets the phone id of this phone.

Parameters:
phoneId - the phone id of this phone

getCompanyId

long getCompanyId()
Gets the company id of this phone.

Returns:
the company id of this phone

setCompanyId

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

Parameters:
companyId - the company id of this phone

getUserId

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

Returns:
the user id of this phone

setUserId

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

Parameters:
userId - the user id of this phone

getUserUuid

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

Returns:
the user uuid of this phone
Throws:
SystemException - if a system exception occurred

setUserUuid

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

Parameters:
userUuid - the user uuid of this phone

getUserName

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

Returns:
the user name of this phone

setUserName

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

Parameters:
userName - the user name of this phone

getCreateDate

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

Returns:
the create date of this phone

setCreateDate

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

Parameters:
createDate - the create date of this phone

getModifiedDate

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

Returns:
the modified date of this phone

setModifiedDate

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

Parameters:
modifiedDate - the modified date of this phone

getClassName

String getClassName()
Gets the class name of the model instance this phone is polymorphically associated with.

Returns:
the class name of the model instance this phone is polymorphically associated with

getClassNameId

long getClassNameId()
Gets the class name id of this phone.

Returns:
the class name id of this phone

setClassNameId

void setClassNameId(long classNameId)
Sets the class name id of this phone.

Parameters:
classNameId - the class name id of this phone

getClassPK

long getClassPK()
Gets the class p k of this phone.

Returns:
the class p k of this phone

setClassPK

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

Parameters:
classPK - the class p k of this phone

getNumber

@AutoEscape
String getNumber()
Gets the number of this phone.

Returns:
the number of this phone

setNumber

void setNumber(String number)
Sets the number of this phone.

Parameters:
number - the number of this phone

getExtension

@AutoEscape
String getExtension()
Gets the extension of this phone.

Returns:
the extension of this phone

setExtension

void setExtension(String extension)
Sets the extension of this phone.

Parameters:
extension - the extension of this phone

getTypeId

int getTypeId()
Gets the type id of this phone.

Returns:
the type id of this phone

setTypeId

void setTypeId(int typeId)
Sets the type id of this phone.

Parameters:
typeId - the type id of this phone

getPrimary

boolean getPrimary()
Gets the primary of this phone.

Returns:
the primary of this phone

isPrimary

boolean isPrimary()
Determines whether this phone is primary.

Returns:
whether this phone is primary

setPrimary

void setPrimary(boolean primary)
Sets whether this {$entity.humanName} is primary.

Parameters:
primary - the primary of this phone

toEscapedModel

Phone toEscapedModel()
Gets a copy of this phone as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

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<Phone>
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<Phone>
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<Phone>
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<Phone>
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<Phone>
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<Phone>
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<Phone>
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<Phone>
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<Phone>
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<Phone>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(Phone phone)
Specified by:
compareTo in interface Comparable<Phone>

hashCode

int hashCode()
Overrides:
hashCode in class Object

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<Phone>
Returns:
the XML representation of this model instance

Liferay 6.0.5