Liferay 6.2-ce-ga5

com.liferay.portal.model
Interface PhoneModel

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<Phone>, ClassedModel, Cloneable, Comparable<Phone>, Serializable, StagedAuditedModel, StagedModel, TypedModel
All Known Subinterfaces:
Phone
All Known Implementing Classes:
PhoneWrapper

@ProviderType
public interface PhoneModel
extends AttachedModel, BaseModel<Phone>, StagedAuditedModel

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.

See Also:
Phone, PhoneImpl, PhoneModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Phone phone)
           
 String getClassName()
          Returns the fully qualified class name of this phone.
 long getClassNameId()
          Returns the class name ID of this phone.
 long getClassPK()
          Returns the class p k of this phone.
 long getCompanyId()
          Returns the company ID of this phone.
 Date getCreateDate()
          Returns the create date of this phone.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getExtension()
          Returns the extension of this phone.
 Date getModifiedDate()
          Returns the modified date of this phone.
 String getNumber()
          Returns the number of this phone.
 long getPhoneId()
          Returns the phone ID of this phone.
 boolean getPrimary()
          Returns the primary of this phone.
 long getPrimaryKey()
          Returns the primary key of this phone.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 int getTypeId()
          Returns the type ID of this phone.
 long getUserId()
          Returns the user ID of this phone.
 String getUserName()
          Returns the user name of this phone.
 String getUserUuid()
          Returns the user uuid of this phone.
 String getUuid()
          Returns the uuid of this phone.
 int hashCode()
           
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isPrimary()
          Returns true if this phone is primary.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassName(String className)
           
 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 setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
 void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
 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 phone is primary.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this phone.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 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.
 void setUuid(String uuid)
          Sets the uuid of this phone.
 CacheModel<Phone> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 Phone toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 Phone toUnescapedModel()
           
 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.StagedModel
getStagedModelType
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

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

Returns:
the primary key of this phone

setPrimaryKey

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

Parameters:
primaryKey - the primary key of this phone

getUuid

@AutoEscape
String getUuid()
Returns the uuid of this phone.

Specified by:
getUuid in interface StagedModel
Returns:
the uuid of this phone

setUuid

void setUuid(String uuid)
Sets the uuid of this phone.

Specified by:
setUuid in interface StagedModel
Parameters:
uuid - the uuid of this phone

getPhoneId

long getPhoneId()
Returns 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()
Returns the company ID of this phone.

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

setCompanyId

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

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

getUserId

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

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

setUserId

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

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

getUserUuid

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

Specified by:
getUserUuid in interface AuditedModel
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.

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

getUserName

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

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

setUserName

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

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

getCreateDate

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

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

setCreateDate

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

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

getModifiedDate

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

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

setModifiedDate

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

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

getClassName

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

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

setClassName

void setClassName(String className)

getClassNameId

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

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

setClassNameId

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

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

getClassPK

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

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

setClassPK

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

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

getNumber

@AutoEscape
String getNumber()
Returns 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()
Returns 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()
Returns 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()
Returns the primary of this phone.

Returns:
the primary of this phone

isPrimary

boolean isPrimary()
Returns true if this phone is primary.

Returns:
true if this phone is primary; false otherwise

setPrimary

void setPrimary(boolean primary)
Sets whether this phone is primary.

Parameters:
primary - the primary of this phone

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<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
Returns true 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
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Phone>
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<Phone>
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<Phone>
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<Phone>
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<Phone>

setExpandoBridgeAttributes

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

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 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<Phone>
Specified by:
clone in interface StagedModel
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

toCacheModel

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

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

toEscapedModel

Phone 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<Phone>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

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

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

Liferay 6.2-ce-ga5