Package com.liferay.knowledge.base.model
Interface KBArticleModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel,com.liferay.portal.kernel.model.BaseModel<KBArticle>,com.liferay.portal.kernel.model.ClassedModel,Cloneable,Comparable<KBArticle>,com.liferay.portal.kernel.model.change.tracking.CTModel<KBArticle>,com.liferay.portal.kernel.model.ExternalReferenceCodeModel,com.liferay.portal.kernel.model.GroupedModel,com.liferay.portal.kernel.model.MVCCModel,com.liferay.portal.kernel.model.ResourcedModel,Serializable,com.liferay.portal.kernel.model.ShardedModel,com.liferay.portal.kernel.model.StagedGroupedModel,com.liferay.portal.kernel.model.StagedModel,com.liferay.portal.kernel.model.TrashedModel,com.liferay.portal.kernel.model.WorkflowedModel
- All Known Subinterfaces:
KBArticle
- All Known Implementing Classes:
KBArticleWrapper
@ProviderType
public interface KBArticleModel
extends com.liferay.portal.kernel.model.BaseModel<KBArticle>, com.liferay.portal.kernel.model.change.tracking.CTModel<KBArticle>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ResourcedModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.TrashedModel, com.liferay.portal.kernel.model.WorkflowedModel
The base model interface for the KBArticle service. Represents a row in the "KBArticle" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.knowledge.base.model.impl.KBArticleModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.knowledge.base.model.impl.KBArticleImpl.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionlongReturns the company ID of this kb article.Returns the content of this kb article.Returns the create date of this kb article.longReturns the ct collection ID of this kb article.Returns the description of this kb article.Returns the display date of this kb article.Returns the expiration date of this kb article.Returns the external reference code of this kb article.longReturns the group ID of this kb article.longReturns the kb article ID of this kb article.longReturns the kb folder ID of this kb article.Returns the last publish date of this kb article.booleanReturns the latest of this kb article.booleangetMain()Returns the main of this kb article.Returns the modified date of this kb article.longReturns the mvcc version of this kb article.longReturns the parent resource class name ID of this kb article.longReturns the parent resource prim key of this kb article.longReturns the primary key of this kb article.doubleReturns the priority of this kb article.longReturns the resource prim key of this kb article.Returns the review date of this kb article.longReturns the root resource prim key of this kb article.Returns the sections of this kb article.Returns the source url of this kb article.intReturns the status of this kb article.longReturns the status by user ID of this kb article.Returns the status by user name of this kb article.Returns the status by user uuid of this kb article.Returns the status date of this kb article.getTitle()Returns the title of this kb article.longReturns the class primary key of the trash entry for this kb article.Returns the url title of this kb article.longReturns the user ID of this kb article.Returns the user name of this kb article.Returns the user uuid of this kb article.getUuid()Returns the uuid of this kb article.intReturns the version of this kb article.booleanReturnstrueif this kb article is approved.booleanisDenied()Returnstrueif this kb article is denied.booleanisDraft()Returnstrueif this kb article is a draft.booleanReturnstrueif this kb article is expired.booleanReturnstrueif this kb article is inactive.booleanReturnstrueif this kb article is incomplete.booleanReturnstrueif this kb article is in the Recycle Bin.booleanisLatest()Returnstrueif this kb article is latest.booleanisMain()Returnstrueif this kb article is main.booleanReturnstrueif this kb article is pending.booleanbooleanReturnstrueif this kb article is scheduled.voidsetCompanyId(long companyId) Sets the company ID of this kb article.voidsetContent(String content) Sets the content of this kb article.voidsetCreateDate(Date createDate) Sets the create date of this kb article.voidsetCtCollectionId(long ctCollectionId) Sets the ct collection ID of this kb article.voidsetDescription(String description) Sets the description of this kb article.voidsetDisplayDate(Date displayDate) Sets the display date of this kb article.voidsetExpirationDate(Date expirationDate) Sets the expiration date of this kb article.voidsetExternalReferenceCode(String externalReferenceCode) Sets the external reference code of this kb article.voidsetGroupId(long groupId) Sets the group ID of this kb article.voidsetKbArticleId(long kbArticleId) Sets the kb article ID of this kb article.voidsetKbFolderId(long kbFolderId) Sets the kb folder ID of this kb article.voidsetLastPublishDate(Date lastPublishDate) Sets the last publish date of this kb article.voidsetLatest(boolean latest) Sets whether this kb article is latest.voidsetMain(boolean main) Sets whether this kb article is main.voidsetModifiedDate(Date modifiedDate) Sets the modified date of this kb article.voidsetMvccVersion(long mvccVersion) Sets the mvcc version of this kb article.voidsetParentResourceClassNameId(long parentResourceClassNameId) Sets the parent resource class name ID of this kb article.voidsetParentResourcePrimKey(long parentResourcePrimKey) Sets the parent resource prim key of this kb article.voidsetPrimaryKey(long primaryKey) Sets the primary key of this kb article.voidsetPriority(double priority) Sets the priority of this kb article.voidsetResourcePrimKey(long resourcePrimKey) Sets the resource prim key of this kb article.voidsetReviewDate(Date reviewDate) Sets the review date of this kb article.voidsetRootResourcePrimKey(long rootResourcePrimKey) Sets the root resource prim key of this kb article.voidsetSections(String sections) Sets the sections of this kb article.voidsetSourceURL(String sourceURL) Sets the source url of this kb article.voidsetStatus(int status) Sets the status of this kb article.voidsetStatusByUserId(long statusByUserId) Sets the status by user ID of this kb article.voidsetStatusByUserName(String statusByUserName) Sets the status by user name of this kb article.voidsetStatusByUserUuid(String statusByUserUuid) Sets the status by user uuid of this kb article.voidsetStatusDate(Date statusDate) Sets the status date of this kb article.voidSets the title of this kb article.voidsetUrlTitle(String urlTitle) Sets the url title of this kb article.voidsetUserId(long userId) Sets the user ID of this kb article.voidsetUserName(String userName) Sets the user name of this kb article.voidsetUserUuid(String userUuid) Sets the user uuid of this kb article.voidSets the uuid of this kb article.voidsetVersion(int version) Sets the version of this kb article.default StringMethods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModelMethods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassNameMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this kb article.- Specified by:
getPrimaryKeyin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<KBArticle>- Returns:
- the primary key of this kb article
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this kb article.- Specified by:
setPrimaryKeyin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<KBArticle>- Parameters:
primaryKey- the primary key of this kb article
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this kb article.- Specified by:
getMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Returns:
- the mvcc version of this kb article
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this kb article.- Specified by:
setMvccVersionin interfacecom.liferay.portal.kernel.model.MVCCModel- Parameters:
mvccVersion- the mvcc version of this kb article
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this kb article.- Specified by:
getCtCollectionIdin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<KBArticle>- Returns:
- the ct collection ID of this kb article
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this kb article.- Specified by:
setCtCollectionIdin interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<KBArticle>- Parameters:
ctCollectionId- the ct collection ID of this kb article
-
getUuid
Returns the uuid of this kb article.- Specified by:
getUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the uuid of this kb article
-
setUuid
Sets the uuid of this kb article.- Specified by:
setUuidin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
uuid- the uuid of this kb article
-
getKbArticleId
long getKbArticleId()Returns the kb article ID of this kb article.- Returns:
- the kb article ID of this kb article
-
setKbArticleId
void setKbArticleId(long kbArticleId) Sets the kb article ID of this kb article.- Parameters:
kbArticleId- the kb article ID of this kb article
-
getResourcePrimKey
long getResourcePrimKey()Returns the resource prim key of this kb article.- Specified by:
getResourcePrimKeyin interfacecom.liferay.portal.kernel.model.ResourcedModel- Returns:
- the resource prim key of this kb article
-
setResourcePrimKey
void setResourcePrimKey(long resourcePrimKey) Sets the resource prim key of this kb article.- Specified by:
setResourcePrimKeyin interfacecom.liferay.portal.kernel.model.ResourcedModel- Parameters:
resourcePrimKey- the resource prim key of this kb article
-
isResourceMain
boolean isResourceMain()- Specified by:
isResourceMainin interfacecom.liferay.portal.kernel.model.ResourcedModel
-
getGroupId
long getGroupId()Returns the group ID of this kb article.- Specified by:
getGroupIdin interfacecom.liferay.portal.kernel.model.GroupedModel- Returns:
- the group ID of this kb article
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this kb article.- Specified by:
setGroupIdin interfacecom.liferay.portal.kernel.model.GroupedModel- Parameters:
groupId- the group ID of this kb article
-
getCompanyId
long getCompanyId()Returns the company ID of this kb article.- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
getCompanyIdin interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the company ID of this kb article
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this kb article.- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.ShardedModel- Specified by:
setCompanyIdin interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
companyId- the company ID of this kb article
-
getUserId
long getUserId()Returns the user ID of this kb article.- Specified by:
getUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user ID of this kb article
-
setUserId
void setUserId(long userId) Sets the user ID of this kb article.- Specified by:
setUserIdin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userId- the user ID of this kb article
-
getUserUuid
String getUserUuid()Returns the user uuid of this kb article.- Specified by:
getUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user uuid of this kb article
-
setUserUuid
Sets the user uuid of this kb article.- Specified by:
setUserUuidin interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userUuid- the user uuid of this kb article
-
getUserName
Returns the user name of this kb article.- Specified by:
getUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Returns:
- the user name of this kb article
-
setUserName
Sets the user name of this kb article.- Specified by:
setUserNamein interfacecom.liferay.portal.kernel.model.AuditedModel- Parameters:
userName- the user name of this kb article
-
getCreateDate
Date getCreateDate()Returns the create date of this kb article.- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the create date of this kb article
-
setCreateDate
Sets the create date of this kb article.- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setCreateDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
createDate- the create date of this kb article
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this kb article.- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
getModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Returns:
- the modified date of this kb article
-
setModifiedDate
Sets the modified date of this kb article.- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.AuditedModel- Specified by:
setModifiedDatein interfacecom.liferay.portal.kernel.model.StagedModel- Parameters:
modifiedDate- the modified date of this kb article
-
getExternalReferenceCode
Returns the external reference code of this kb article.- Specified by:
getExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Returns:
- the external reference code of this kb article
-
setExternalReferenceCode
Sets the external reference code of this kb article.- Specified by:
setExternalReferenceCodein interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel- Parameters:
externalReferenceCode- the external reference code of this kb article
-
getRootResourcePrimKey
long getRootResourcePrimKey()Returns the root resource prim key of this kb article.- Returns:
- the root resource prim key of this kb article
-
setRootResourcePrimKey
void setRootResourcePrimKey(long rootResourcePrimKey) Sets the root resource prim key of this kb article.- Parameters:
rootResourcePrimKey- the root resource prim key of this kb article
-
getParentResourceClassNameId
long getParentResourceClassNameId()Returns the parent resource class name ID of this kb article.- Returns:
- the parent resource class name ID of this kb article
-
setParentResourceClassNameId
void setParentResourceClassNameId(long parentResourceClassNameId) Sets the parent resource class name ID of this kb article.- Parameters:
parentResourceClassNameId- the parent resource class name ID of this kb article
-
getParentResourcePrimKey
long getParentResourcePrimKey()Returns the parent resource prim key of this kb article.- Returns:
- the parent resource prim key of this kb article
-
setParentResourcePrimKey
void setParentResourcePrimKey(long parentResourcePrimKey) Sets the parent resource prim key of this kb article.- Parameters:
parentResourcePrimKey- the parent resource prim key of this kb article
-
getKbFolderId
long getKbFolderId()Returns the kb folder ID of this kb article.- Returns:
- the kb folder ID of this kb article
-
setKbFolderId
void setKbFolderId(long kbFolderId) Sets the kb folder ID of this kb article.- Parameters:
kbFolderId- the kb folder ID of this kb article
-
getVersion
int getVersion()Returns the version of this kb article.- Returns:
- the version of this kb article
-
setVersion
void setVersion(int version) Sets the version of this kb article.- Parameters:
version- the version of this kb article
-
getTitle
Returns the title of this kb article.- Returns:
- the title of this kb article
-
setTitle
Sets the title of this kb article.- Parameters:
title- the title of this kb article
-
getUrlTitle
Returns the url title of this kb article.- Returns:
- the url title of this kb article
-
setUrlTitle
Sets the url title of this kb article.- Parameters:
urlTitle- the url title of this kb article
-
getContent
Returns the content of this kb article.- Returns:
- the content of this kb article
-
setContent
Sets the content of this kb article.- Parameters:
content- the content of this kb article
-
getDescription
Returns the description of this kb article.- Returns:
- the description of this kb article
-
setDescription
Sets the description of this kb article.- Parameters:
description- the description of this kb article
-
getPriority
double getPriority()Returns the priority of this kb article.- Returns:
- the priority of this kb article
-
setPriority
void setPriority(double priority) Sets the priority of this kb article.- Parameters:
priority- the priority of this kb article
-
getSections
Returns the sections of this kb article.- Returns:
- the sections of this kb article
-
setSections
Sets the sections of this kb article.- Parameters:
sections- the sections of this kb article
-
getLatest
boolean getLatest()Returns the latest of this kb article.- Returns:
- the latest of this kb article
-
isLatest
boolean isLatest()Returnstrueif this kb article is latest.- Returns:
trueif this kb article is latest;falseotherwise
-
setLatest
void setLatest(boolean latest) Sets whether this kb article is latest.- Parameters:
latest- the latest of this kb article
-
getMain
boolean getMain()Returns the main of this kb article.- Returns:
- the main of this kb article
-
isMain
boolean isMain()Returnstrueif this kb article is main.- Returns:
trueif this kb article is main;falseotherwise
-
setMain
void setMain(boolean main) Sets whether this kb article is main.- Parameters:
main- the main of this kb article
-
getSourceURL
Returns the source url of this kb article.- Returns:
- the source url of this kb article
-
setSourceURL
Sets the source url of this kb article.- Parameters:
sourceURL- the source url of this kb article
-
getDisplayDate
Date getDisplayDate()Returns the display date of this kb article.- Returns:
- the display date of this kb article
-
setDisplayDate
Sets the display date of this kb article.- Parameters:
displayDate- the display date of this kb article
-
getExpirationDate
Date getExpirationDate()Returns the expiration date of this kb article.- Returns:
- the expiration date of this kb article
-
setExpirationDate
Sets the expiration date of this kb article.- Parameters:
expirationDate- the expiration date of this kb article
-
getReviewDate
Date getReviewDate()Returns the review date of this kb article.- Returns:
- the review date of this kb article
-
setReviewDate
Sets the review date of this kb article.- Parameters:
reviewDate- the review date of this kb article
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this kb article.- Specified by:
getLastPublishDatein interfacecom.liferay.portal.kernel.model.StagedGroupedModel- Returns:
- the last publish date of this kb article
-
setLastPublishDate
Sets the last publish date of this kb article.- Specified by:
setLastPublishDatein interfacecom.liferay.portal.kernel.model.StagedGroupedModel- Parameters:
lastPublishDate- the last publish date of this kb article
-
getStatus
int getStatus()Returns the status of this kb article.- Specified by:
getStatusin interfacecom.liferay.portal.kernel.model.TrashedModel- Specified by:
getStatusin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status of this kb article
-
setStatus
void setStatus(int status) Sets the status of this kb article.- Specified by:
setStatusin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
status- the status of this kb article
-
getStatusByUserId
long getStatusByUserId()Returns the status by user ID of this kb article.- Specified by:
getStatusByUserIdin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user ID of this kb article
-
setStatusByUserId
void setStatusByUserId(long statusByUserId) Sets the status by user ID of this kb article.- Specified by:
setStatusByUserIdin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserId- the status by user ID of this kb article
-
getStatusByUserUuid
String getStatusByUserUuid()Returns the status by user uuid of this kb article.- Specified by:
getStatusByUserUuidin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user uuid of this kb article
-
setStatusByUserUuid
Sets the status by user uuid of this kb article.- Specified by:
setStatusByUserUuidin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserUuid- the status by user uuid of this kb article
-
getStatusByUserName
Returns the status by user name of this kb article.- Specified by:
getStatusByUserNamein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status by user name of this kb article
-
setStatusByUserName
Sets the status by user name of this kb article.- Specified by:
setStatusByUserNamein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusByUserName- the status by user name of this kb article
-
getStatusDate
Date getStatusDate()Returns the status date of this kb article.- Specified by:
getStatusDatein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
- the status date of this kb article
-
setStatusDate
Sets the status date of this kb article.- Specified by:
setStatusDatein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Parameters:
statusDate- the status date of this kb article
-
getTrashEntryClassPK
long getTrashEntryClassPK()Returns the class primary key of the trash entry for this kb article.- Specified by:
getTrashEntryClassPKin interfacecom.liferay.portal.kernel.model.TrashedModel- Returns:
- the class primary key of the trash entry for this kb article
-
isInTrash
boolean isInTrash()Returnstrueif this kb article is in the Recycle Bin.- Specified by:
isInTrashin interfacecom.liferay.portal.kernel.model.TrashedModel- Returns:
trueif this kb article is in the Recycle Bin;falseotherwise
-
isApproved
boolean isApproved()Returnstrueif this kb article is approved.- Specified by:
isApprovedin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this kb article is approved;falseotherwise
-
isDenied
boolean isDenied()Returnstrueif this kb article is denied.- Specified by:
isDeniedin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this kb article is denied;falseotherwise
-
isDraft
boolean isDraft()Returnstrueif this kb article is a draft.- Specified by:
isDraftin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this kb article is a draft;falseotherwise
-
isExpired
boolean isExpired()Returnstrueif this kb article is expired.- Specified by:
isExpiredin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this kb article is expired;falseotherwise
-
isInactive
boolean isInactive()Returnstrueif this kb article is inactive.- Specified by:
isInactivein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this kb article is inactive;falseotherwise
-
isIncomplete
boolean isIncomplete()Returnstrueif this kb article is incomplete.- Specified by:
isIncompletein interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this kb article is incomplete;falseotherwise
-
isPending
boolean isPending()Returnstrueif this kb article is pending.- Specified by:
isPendingin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this kb article is pending;falseotherwise
-
isScheduled
boolean isScheduled()Returnstrueif this kb article is scheduled.- Specified by:
isScheduledin interfacecom.liferay.portal.kernel.model.WorkflowedModel- Returns:
trueif this kb article is scheduled;falseotherwise
-
cloneWithOriginalValues
KBArticle cloneWithOriginalValues()- Specified by:
cloneWithOriginalValuesin interfacecom.liferay.portal.kernel.model.BaseModel<KBArticle>
-
toXmlString
-