Liferay 6.0-ee

com.liferay.portal.model
Interface OrganizationModel

All Superinterfaces:
BaseModel<Organization>, Cloneable, Comparable<Organization>, Serializable
All Known Subinterfaces:
Organization
All Known Implementing Classes:
OrganizationImpl, OrganizationModelImpl, OrganizationWrapper

public interface OrganizationModel
extends BaseModel<Organization>

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

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

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

See Also:
Organization, OrganizationImpl, OrganizationModelImpl
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(Organization organization)
           
 String getComments()
          Gets the comments of this organization.
 long getCompanyId()
          Gets the company id of this organization.
 long getCountryId()
          Gets the country id of this organization.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getLeftOrganizationId()
          Gets the left organization id of this organization.
 String getName()
          Gets the name of this organization.
 long getOrganizationId()
          Gets the organization id of this organization.
 long getParentOrganizationId()
          Gets the parent organization id of this organization.
 long getPrimaryKey()
          Gets the primary key of this organization.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 boolean getRecursable()
          Gets the recursable of this organization.
 long getRegionId()
          Gets the region id of this organization.
 long getRightOrganizationId()
          Gets the right organization id of this organization.
 int getStatusId()
          Gets the status id of this organization.
 String getType()
          Gets the type of this organization.
 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 isRecursable()
          Determines whether this organization is recursable.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setComments(String comments)
          Sets the comments of this organization.
 void setCompanyId(long companyId)
          Sets the company id of this organization.
 void setCountryId(long countryId)
          Sets the country id of this organization.
 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 setLeftOrganizationId(long leftOrganizationId)
          Sets the left organization id of this organization.
 void setName(String name)
          Sets the name of this organization.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setOrganizationId(long organizationId)
          Sets the organization id of this organization.
 void setParentOrganizationId(long parentOrganizationId)
          Sets the parent organization id of this organization.
 void setPrimaryKey(long pk)
          Sets the primary key of this organization
 void setRecursable(boolean recursable)
          Sets whether this {$entity.humanName} is recursable.
 void setRegionId(long regionId)
          Sets the region id of this organization.
 void setRightOrganizationId(long rightOrganizationId)
          Sets the right organization id of this organization.
 void setStatusId(int statusId)
          Sets the status id of this organization.
 void setType(String type)
          Sets the type of this organization.
 Organization 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 organization.

Returns:
the primary key of this organization

setPrimaryKey

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

Parameters:
pk - the primary key of this organization

getOrganizationId

long getOrganizationId()
Gets the organization id of this organization.

Returns:
the organization id of this organization

setOrganizationId

void setOrganizationId(long organizationId)
Sets the organization id of this organization.

Parameters:
organizationId - the organization id of this organization

getCompanyId

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

Returns:
the company id of this organization

setCompanyId

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

Parameters:
companyId - the company id of this organization

getParentOrganizationId

long getParentOrganizationId()
Gets the parent organization id of this organization.

Returns:
the parent organization id of this organization

setParentOrganizationId

void setParentOrganizationId(long parentOrganizationId)
Sets the parent organization id of this organization.

Parameters:
parentOrganizationId - the parent organization id of this organization

getLeftOrganizationId

long getLeftOrganizationId()
Gets the left organization id of this organization.

Returns:
the left organization id of this organization

setLeftOrganizationId

void setLeftOrganizationId(long leftOrganizationId)
Sets the left organization id of this organization.

Parameters:
leftOrganizationId - the left organization id of this organization

getRightOrganizationId

long getRightOrganizationId()
Gets the right organization id of this organization.

Returns:
the right organization id of this organization

setRightOrganizationId

void setRightOrganizationId(long rightOrganizationId)
Sets the right organization id of this organization.

Parameters:
rightOrganizationId - the right organization id of this organization

getName

@AutoEscape
String getName()
Gets the name of this organization.

Returns:
the name of this organization

setName

void setName(String name)
Sets the name of this organization.

Parameters:
name - the name of this organization

getType

String getType()
Gets the type of this organization.

Returns:
the type of this organization

setType

void setType(String type)
Sets the type of this organization.

Parameters:
type - the type of this organization

getRecursable

boolean getRecursable()
Gets the recursable of this organization.

Returns:
the recursable of this organization

isRecursable

boolean isRecursable()
Determines whether this organization is recursable.

Returns:
whether this organization is recursable

setRecursable

void setRecursable(boolean recursable)
Sets whether this {$entity.humanName} is recursable.

Parameters:
recursable - the recursable of this organization

getRegionId

long getRegionId()
Gets the region id of this organization.

Returns:
the region id of this organization

setRegionId

void setRegionId(long regionId)
Sets the region id of this organization.

Parameters:
regionId - the region id of this organization

getCountryId

long getCountryId()
Gets the country id of this organization.

Returns:
the country id of this organization

setCountryId

void setCountryId(long countryId)
Sets the country id of this organization.

Parameters:
countryId - the country id of this organization

getStatusId

int getStatusId()
Gets the status id of this organization.

Returns:
the status id of this organization

setStatusId

void setStatusId(int statusId)
Sets the status id of this organization.

Parameters:
statusId - the status id of this organization

getComments

@AutoEscape
String getComments()
Gets the comments of this organization.

Returns:
the comments of this organization

setComments

void setComments(String comments)
Sets the comments of this organization.

Parameters:
comments - the comments of this organization

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

compareTo

int compareTo(Organization organization)
Specified by:
compareTo in interface Comparable<Organization>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toEscapedModel

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

Liferay 6.0-ee