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 TypeMethodDescriptionlong
Returns the company ID of this kb article.Returns the content of this kb article.Returns the create date of this kb article.long
Returns 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.long
Returns the group ID of this kb article.long
Returns the kb article ID of this kb article.long
Returns the kb folder ID of this kb article.Returns the last publish date of this kb article.boolean
Returns the latest of this kb article.boolean
getMain()
Returns the main of this kb article.Returns the modified date of this kb article.long
Returns the mvcc version of this kb article.long
Returns the parent resource class name ID of this kb article.long
Returns the parent resource prim key of this kb article.long
Returns the primary key of this kb article.double
Returns the priority of this kb article.long
Returns the resource prim key of this kb article.Returns the review date of this kb article.long
Returns the root resource prim key of this kb article.Returns the sections of this kb article.Returns the source url of this kb article.int
Returns the status of this kb article.long
Returns 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.long
Returns the class primary key of the trash entry for this kb article.Returns the url title of this kb article.long
Returns 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.int
Returns the version of this kb article.boolean
Returnstrue
if this kb article is approved.boolean
isDenied()
Returnstrue
if this kb article is denied.boolean
isDraft()
Returnstrue
if this kb article is a draft.boolean
Returnstrue
if this kb article is expired.boolean
Returnstrue
if this kb article is inactive.boolean
Returnstrue
if this kb article is incomplete.boolean
Returnstrue
if this kb article is in the Recycle Bin.boolean
isLatest()
Returnstrue
if this kb article is latest.boolean
isMain()
Returnstrue
if this kb article is main.boolean
Returnstrue
if this kb article is pending.boolean
boolean
Returnstrue
if this kb article is scheduled.void
setCompanyId
(long companyId) Sets the company ID of this kb article.void
setContent
(String content) Sets the content of this kb article.void
setCreateDate
(Date createDate) Sets the create date of this kb article.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this kb article.void
setDescription
(String description) Sets the description of this kb article.void
setDisplayDate
(Date displayDate) Sets the display date of this kb article.void
setExpirationDate
(Date expirationDate) Sets the expiration date of this kb article.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this kb article.void
setGroupId
(long groupId) Sets the group ID of this kb article.void
setKbArticleId
(long kbArticleId) Sets the kb article ID of this kb article.void
setKbFolderId
(long kbFolderId) Sets the kb folder ID of this kb article.void
setLastPublishDate
(Date lastPublishDate) Sets the last publish date of this kb article.void
setLatest
(boolean latest) Sets whether this kb article is latest.void
setMain
(boolean main) Sets whether this kb article is main.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this kb article.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this kb article.void
setParentResourceClassNameId
(long parentResourceClassNameId) Sets the parent resource class name ID of this kb article.void
setParentResourcePrimKey
(long parentResourcePrimKey) Sets the parent resource prim key of this kb article.void
setPrimaryKey
(long primaryKey) Sets the primary key of this kb article.void
setPriority
(double priority) Sets the priority of this kb article.void
setResourcePrimKey
(long resourcePrimKey) Sets the resource prim key of this kb article.void
setReviewDate
(Date reviewDate) Sets the review date of this kb article.void
setRootResourcePrimKey
(long rootResourcePrimKey) Sets the root resource prim key of this kb article.void
setSections
(String sections) Sets the sections of this kb article.void
setSourceURL
(String sourceURL) Sets the source url of this kb article.void
setStatus
(int status) Sets the status of this kb article.void
setStatusByUserId
(long statusByUserId) Sets the status by user ID of this kb article.void
setStatusByUserName
(String statusByUserName) Sets the status by user name of this kb article.void
setStatusByUserUuid
(String statusByUserUuid) Sets the status by user uuid of this kb article.void
setStatusDate
(Date statusDate) Sets the status date of this kb article.void
Sets the title of this kb article.void
setUrlTitle
(String urlTitle) Sets the url title of this kb article.void
setUserId
(long userId) Sets the user ID of this kb article.void
setUserName
(String userName) Sets the user name of this kb article.void
setUserUuid
(String userUuid) Sets the user uuid of this kb article.void
Sets the uuid of this kb article.void
setVersion
(int version) Sets the version of this kb article.default String
Methods 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, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods 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:
getPrimaryKey
in 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:
setPrimaryKey
in 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:
getMvccVersion
in 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:
setMvccVersion
in 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:
getCtCollectionId
in 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:
setCtCollectionId
in 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:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this kb article
-
setUuid
Sets the uuid of this kb article.- Specified by:
setUuid
in 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:
getResourcePrimKey
in 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:
setResourcePrimKey
in interfacecom.liferay.portal.kernel.model.ResourcedModel
- Parameters:
resourcePrimKey
- the resource prim key of this kb article
-
isResourceMain
boolean isResourceMain()- Specified by:
isResourceMain
in interfacecom.liferay.portal.kernel.model.ResourcedModel
-
getGroupId
long getGroupId()Returns the group ID of this kb article.- Specified by:
getGroupId
in 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:
setGroupId
in 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:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in 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:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in 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:
getUserId
in 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:
setUserId
in 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:
getUserUuid
in 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:
setUserUuid
in 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:
getUserName
in 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:
setUserName
in 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:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in 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:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in 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:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in 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:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in 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:
getExternalReferenceCode
in 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:
setExternalReferenceCode
in 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()Returnstrue
if this kb article is latest.- Returns:
true
if this kb article is latest;false
otherwise
-
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()Returnstrue
if this kb article is main.- Returns:
true
if this kb article is main;false
otherwise
-
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:
getLastPublishDate
in 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:
setLastPublishDate
in 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:
getStatus
in interfacecom.liferay.portal.kernel.model.TrashedModel
- Specified by:
getStatus
in 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:
setStatus
in 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:
getStatusByUserId
in 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:
setStatusByUserId
in 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:
getStatusByUserUuid
in 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:
setStatusByUserUuid
in 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:
getStatusByUserName
in 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:
setStatusByUserName
in 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:
getStatusDate
in 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:
setStatusDate
in 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:
getTrashEntryClassPK
in interfacecom.liferay.portal.kernel.model.TrashedModel
- Returns:
- the class primary key of the trash entry for this kb article
-
isInTrash
boolean isInTrash()Returnstrue
if this kb article is in the Recycle Bin.- Specified by:
isInTrash
in interfacecom.liferay.portal.kernel.model.TrashedModel
- Returns:
true
if this kb article is in the Recycle Bin;false
otherwise
-
isApproved
boolean isApproved()Returnstrue
if this kb article is approved.- Specified by:
isApproved
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this kb article is approved;false
otherwise
-
isDenied
boolean isDenied()Returnstrue
if this kb article is denied.- Specified by:
isDenied
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this kb article is denied;false
otherwise
-
isDraft
boolean isDraft()Returnstrue
if this kb article is a draft.- Specified by:
isDraft
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this kb article is a draft;false
otherwise
-
isExpired
boolean isExpired()Returnstrue
if this kb article is expired.- Specified by:
isExpired
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this kb article is expired;false
otherwise
-
isInactive
boolean isInactive()Returnstrue
if this kb article is inactive.- Specified by:
isInactive
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this kb article is inactive;false
otherwise
-
isIncomplete
boolean isIncomplete()Returnstrue
if this kb article is incomplete.- Specified by:
isIncomplete
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this kb article is incomplete;false
otherwise
-
isPending
boolean isPending()Returnstrue
if this kb article is pending.- Specified by:
isPending
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this kb article is pending;false
otherwise
-
isScheduled
boolean isScheduled()Returnstrue
if this kb article is scheduled.- Specified by:
isScheduled
in interfacecom.liferay.portal.kernel.model.WorkflowedModel
- Returns:
true
if this kb article is scheduled;false
otherwise
-
cloneWithOriginalValues
KBArticle cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<KBArticle>
-
toXmlString
-