public class CSArticleContent extends CSItemContent
CSArticle
object.
set/get
methods within CSArticle
provide access to this content data and so there
should not typically be any need to explicitly use the set/get
methods supplied here.
CSArticle
,
Serialized FormConstructor and Description |
---|
CSArticleContent()
Creates an empty
CSArticleContent object. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSArticleContent object is the same as that
contained within the one supplied. |
boolean |
getArchiveable()
Gets the flag which indicates whether the article can be archived or not.
|
java.util.Date |
getArchiveDate()
Gets the date and time at which the article is scheduled for archival.
|
int |
getArchiveParentID()
Gets the archive parent ID of the article below which this article will be archived.
|
boolean |
getArticleDisplay()
Gets the flag which indicates whether the article should be displayed or not.
|
java.lang.String |
getArticleHeading()
Gets the heading text of the article.
|
int |
getArticleID()
Gets the article ID.
|
java.lang.String |
getArticleIntroText()
Gets the intro text of the article.
|
java.lang.String |
getArticleLinkText() |
java.lang.String |
getArticlePath()
Gets the complete list of article parent IDs.
|
java.lang.String |
getArticleSummary() |
java.lang.String |
getArticleText()
Gets the article text of the article.
|
java.util.HashMap |
getArticleTextAdditional()
Gets the additional article text blocks of the article, as defined by the template.
|
java.lang.String |
getBestLinkText() |
java.lang.String |
getBoostedKeywords() |
float |
getBoostValue() |
java.lang.String |
getChildArticleIDs()
Gets the list of child articles (iCM version 6.0.0.0 or later only).
|
java.util.Date |
getCreationDate()
Gets the date and time on which the article was created.
|
java.util.Date |
getEndDate()
Gets the end date and time for the display of the article on the website.
|
java.lang.String |
getFriendlyURL() |
int |
getLastModifiedByUserID()
Gets the User ID of the iCM user who last modified the article.
|
java.util.Date |
getLastModifiedDate()
Gets the date and time on which the article was last modified.
|
java.lang.String |
getMetaDataOptionalIDs()
Gets the list of metadata value IDs specified via the
CSArticleMultiple.setMetaDataOptionalIDs(String)
method that matched for this article. |
int |
getOwnerID() |
java.lang.String |
getOwnerType() |
int |
getParentArticleID()
Gets the article ID of the parent article in the article hierarchy.
|
java.lang.String |
getRelatedArticleIDs() |
java.lang.String |
getRelatedEventIDs() |
java.lang.String |
getRelatedFeatureIDs() |
java.lang.String |
getRelatedFormIDs() |
java.lang.String |
getRelatedForumIDs() |
java.lang.String |
getRelatedLinkIDs() |
java.lang.String |
getRelatedMediaIDs() |
java.lang.String |
getRelatedMetaDataIDs() |
java.lang.String |
getRelatedPollIDs() |
java.lang.String |
getRelatedProductIDs() |
java.lang.String |
getRelatedRackIDs() |
boolean |
getReviewable()
Gets the flag to indicate whether the article needs reviewing or not.
|
java.util.Date |
getReviewDate()
Gets the date and time at which the article is scheduled for review.
|
int |
getReviewInterval()
Gets the number of hours between regular article reviews.
|
java.lang.String |
getSecureUserGroupIDs() |
java.util.Date |
getStartDate()
Gets the start date and time for the display of the article on the website.
|
java.lang.String |
getSuggestedArticleIDs() |
int |
getTemplateID()
Gets the template ID of the article.
|
void |
setArchiveable(boolean bArchiveable)
Sets a flag to indicate whether the article can be archived or not.
|
void |
setArchiveDate(java.util.Date objArchiveDate)
Sets the date and time on which the article is to be archived.
|
void |
setArchiveParentID(int nArchiveParentID)
Sets the archive parent ID of the article below which this article will be archived.
|
void |
setArticleDisplay(boolean bArticleDisplay)
Sets a flag to indicate whether the article should be displayed or not.
|
void |
setArticleHeading(java.lang.String strArticleHeading)
Sets the heading text of the article.
|
void |
setArticleID(int nArticleID)
Sets the article ID of the article.
|
void |
setArticleIntroText(java.lang.String strArticleIntroText)
Sets the intro text of the article.
|
void |
setArticleLinkText(java.lang.String articleLinkText) |
void |
setArticlePath(java.lang.String strArticlePath)
Sets the complete list of article parent IDs.
|
void |
setArticleSummary(java.lang.String articleSummary) |
void |
setArticleText(java.lang.String strArticleText)
Sets the text of the article.
|
void |
setArticleTextAdditional(java.util.HashMap objArticleTextAdditional)
Sets the additional article text blocks of the article, as defined by the template.
|
void |
setBoostedKeywords(java.lang.String boostedKeywords) |
void |
setBoostValue(float boostValue) |
void |
setChildArticleIDs(java.lang.String strChildArticleIDs)
Sets the list of the child articles (iCM version 6.0.0.0 or later only).
|
void |
setCreationDate(java.util.Date objCreationDate)
Sets the date and time on which the article was created.
|
void |
setEndDate(java.util.Date objEndDate)
Sets the end date and time for the display of the article on the website.
|
void |
setFriendlyURL(java.lang.String URL) |
void |
setLastModifiedByUserID(int nLastModifiedByUserID)
Sets the User ID of the iCM user who last modified the article.
|
void |
setLastModifiedDate(java.util.Date objLastModifiedDate)
Sets the date and time on which the article was last modified.
|
void |
setOwnerID(int ownerID) |
void |
setOwnerType(java.lang.String ownerType) |
void |
setParentArticleID(int nParentArticleID)
Sets the article ID of the parent article in the article hierarchy.
|
void |
setRelatedArticleIDs(java.lang.String strRelatedArticleIDs) |
void |
setRelatedEventIDs(java.lang.String strRelatedEventIDs) |
void |
setRelatedFeatureIDs(java.lang.String strRelatedFeatureIDs) |
void |
setRelatedFormIDs(java.lang.String strRelatedFormIDs) |
void |
setRelatedForumIDs(java.lang.String strRelatedForumIDs) |
void |
setRelatedLinkIDs(java.lang.String strRelatedLinkIDs) |
void |
setRelatedMediaIDs(java.lang.String strRelatedMediaIDs) |
void |
setRelatedMetaDataIDs(java.lang.String strRelatedMetaDataIDs) |
void |
setRelatedPollIDs(java.lang.String strRelatedPollIDs) |
void |
setRelatedProductIDs(java.lang.String strRelatedProductIDs) |
void |
setRelatedRackIDs(java.lang.String strRelatedRackIDs) |
void |
setReviewable(boolean bReviewable)
Sets a flag to indicate whether the article needs reviewing or not.
|
void |
setReviewDate(java.util.Date objReviewDate)
Sets the date and time on which the article is to be reviewed.
|
void |
setReviewInterval(int nReviewIntervalHours)
Sets the number of hours between regular article reviews.
|
void |
setSecureUserGroupIDs(java.lang.String strSecureUserGroupIDs) |
void |
setStartDate(java.util.Date objStartDate)
Sets the start date and time for the display of the article on the website.
|
void |
setSuggestedArticleIDs(java.lang.String suggestedArticleIDs)
Sets the article IDs suggested for the article.
|
void |
setTemplateID(int nTemplateID)
Sets the template ID of the article.
|
java.lang.String |
toString()
Provides debug information on the contents of the
CSArticleContent object. |
clone, getID, setID, unset
public CSArticleContent()
CSArticleContent
object.public int getArticleID()
public void setArticleID(int nArticleID)
nArticleID
- the ID of the article to be retrieved.public void setArticleHeading(java.lang.String strArticleHeading)
strArticleHeading
- the article's heading.public java.lang.String getArticleHeading()
public void setArticleIntroText(java.lang.String strArticleIntroText)
strArticleIntroText
- the article's intro text.public java.lang.String getArticleIntroText()
public void setArticleText(java.lang.String strArticleText)
For iCM version 8.0.0 or later, if multiple text blocks have been defined for the template then this will contain the text of the first (__DEFAULT) block only.
strArticleText
- the article's text.public java.lang.String getArticleText()
For iCM version 8.0.0 or later, if multiple text blocks have been defined for the template then this will contain the text of the first (__DEFAULT) block only.
public void setArticleTextAdditional(java.util.HashMap objArticleTextAdditional)
For iCM version earlier than 8.0.0 this will be ignored.
objArticleTextAdditional
- the article's additional text blocks.public java.util.HashMap getArticleTextAdditional()
For iCM version earlier than 8.0.0 this will be ignored.
public void setParentArticleID(int nParentArticleID)
nParentArticleID
- the article's parent article ID.public int getParentArticleID()
public void setArticlePath(java.lang.String strArticlePath)
strArticlePath
- the article's path (comma delimited).public java.lang.String getArticlePath()
public void setArchiveParentID(int nArchiveParentID)
nArchiveParentID
- the archive parent article ID.public int getArchiveParentID()
public void setTemplateID(int nTemplateID)
nTemplateID
- the article's template ID.public int getTemplateID()
public void setLastModifiedByUserID(int nLastModifiedByUserID)
nLastModifiedByUserID
- the ID of the iCM user who last modified the article.public int getLastModifiedByUserID()
public void setArchiveable(boolean bArchiveable)
bArchiveable
- flag indicating whether the article can be archived or not.public boolean getArchiveable()
public void setArticleDisplay(boolean bArticleDisplay)
bArticleDisplay
- the flag indicating whether the article should be displayed or not.public boolean getArticleDisplay()
public void setCreationDate(java.util.Date objCreationDate)
objCreationDate
- the creation date and time of the article.public java.util.Date getCreationDate()
public void setLastModifiedDate(java.util.Date objLastModifiedDate)
objLastModifiedDate
- the date and time when the article was last modified.public java.util.Date getLastModifiedDate()
public void setReviewable(boolean bReviewable)
bReviewable
- flag indicating whether the article needs reviewing or not.public boolean getReviewable()
public void setReviewDate(java.util.Date objReviewDate)
objReviewDate
- the date and time when the article should be reviewed.public java.util.Date getReviewDate()
public void setReviewInterval(int nReviewIntervalHours)
nReviewIntervalHours
- the number of hours between regular article reviews.public int getReviewInterval()
public void setArchiveDate(java.util.Date objArchiveDate)
objArchiveDate
- the date and time when the article should be archived.public java.util.Date getArchiveDate()
public void setEndDate(java.util.Date objEndDate)
objEndDate
- the end date and time for the display of the article on the website.public java.util.Date getEndDate()
public void setStartDate(java.util.Date objStartDate)
objStartDate
- the start date and time for the display of the article on the website.public java.util.Date getStartDate()
public void setChildArticleIDs(java.lang.String strChildArticleIDs)
An ID with a 'P' prefix denotes a non-live article.
For iCM version earlier than 6.0.0.0 this list will be ignored.
strChildArticleIDs
- a comma-separated list of this article's child article IDs.public java.lang.String getChildArticleIDs()
An ID with a 'P' prefix denotes a non-live article.
If manual ordering is enabled in the iCM AUTOCONFIG utility, and this article has had its children manually ordered within iCM, then that manual ordering shall determine the ordering of these child articles, otherwise live articles will be listed before non-live articles and then further ordered by ID.
For iCM versions earlier than 6.0.0.0 this list will be empty when the CSArticle.get()
method is called.
public java.lang.String getMetaDataOptionalIDs()
CSArticleMultiple.setMetaDataOptionalIDs(String)
method that matched for this article. This list will only be populated when the
setMetaDataOptionalIDs
method is specified as key information.
public float getBoostValue()
public void setBoostValue(float boostValue)
boostValue
- The m_nBoostValue to set.public int getOwnerID()
public void setOwnerID(int ownerID)
ownerID
- The m_nOwnerID to set.public java.lang.String getArticleLinkText()
public void setArticleLinkText(java.lang.String articleLinkText)
articleLinkText
- The m_strArticleLinkText to set.public java.lang.String getBestLinkText()
public java.lang.String getArticleSummary()
public void setArticleSummary(java.lang.String articleSummary)
articleSummary
- The m_strArticleSummary to set.public java.lang.String getFriendlyURL()
public void setFriendlyURL(java.lang.String URL)
URL
- The friendly URL to set.public java.lang.String getBoostedKeywords()
public void setBoostedKeywords(java.lang.String boostedKeywords)
boostedKeywords
- The m_strBoostedKeywords to set.public java.lang.String getOwnerType()
public void setOwnerType(java.lang.String ownerType)
ownerType
- The m_strOwnerType to set.public java.lang.String getSecureUserGroupIDs()
public void setSecureUserGroupIDs(java.lang.String strSecureUserGroupIDs)
strSecureUserGroupIDs
- Comma delimited list of groupIDs which have access to the article.public java.lang.String getRelatedMediaIDs()
public void setRelatedMediaIDs(java.lang.String strRelatedMediaIDs)
strRelatedMediaIDs
- Comma delimited list of media IDs which are related to the article.public java.lang.String getRelatedLinkIDs()
public void setRelatedLinkIDs(java.lang.String strRelatedLinkIDs)
strRelatedLinkIDs
- Comma delimited list of link IDs which are related to the article.public java.lang.String getRelatedMetaDataIDs()
public void setRelatedMetaDataIDs(java.lang.String strRelatedMetaDataIDs)
strRelatedMetaDataIDs
- Comma delimited list of MetaData IDs which are related to the article.public java.lang.String getRelatedArticleIDs()
public void setRelatedArticleIDs(java.lang.String strRelatedArticleIDs)
strRelatedArticleIDs
- Comma delimited list of article IDs which are related to the article.public java.lang.String getRelatedPollIDs()
public void setRelatedPollIDs(java.lang.String strRelatedPollIDs)
strRelatedPollIDs
- Comma delimited list of poll IDs which are related to the article.public java.lang.String getRelatedForumIDs()
public void setRelatedForumIDs(java.lang.String strRelatedForumIDs)
strRelatedForumIDs
- Comma delimited list of forum IDs which are related to the article.public java.lang.String getRelatedFeatureIDs()
public void setRelatedFeatureIDs(java.lang.String strRelatedFeatureIDs)
strRelatedFeatureIDs
- Comma delimited list of feature IDs which are related to the article.public java.lang.String getRelatedEventIDs()
public void setRelatedEventIDs(java.lang.String strRelatedEventIDs)
strRelatedEventIDs
- Comma delimited list of event IDs which are related to the article.public java.lang.String getRelatedFormIDs()
public void setRelatedFormIDs(java.lang.String strRelatedFormIDs)
strRelatedFormIDs
- Comma delimited list of form IDs which are related to the article.public java.lang.String getRelatedRackIDs()
public void setRelatedRackIDs(java.lang.String strRelatedRackIDs)
strRelatedRackIDs
- Comma delimited list of rack IDs which are related to the article.public java.lang.String getRelatedProductIDs()
public void setRelatedProductIDs(java.lang.String strRelatedProductIDs)
strRelatedProductIDs
- Comma delimited list of products IDs which are related to the article.public java.lang.String getSuggestedArticleIDs()
public void setSuggestedArticleIDs(java.lang.String suggestedArticleIDs)
public java.lang.String toString()
CSArticleContent
object.
toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSArticleContent
object is the same as that
contained within the one supplied. Note that the key data used for searching is not tested for equality.
equals
in class CSItemContent
obj
- the CSArticleContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.