public class CSLinkContent extends CSItemContent
CSLink
object.
The set/get
methods within CSLink
provide access to this content data.
CSLink
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
STATUS_DEAD
A valid parameter value for the
setLinkStatus method and return value for the
getLinkStatus method. |
static int |
STATUS_LIVE
A valid parameter value for the
setLinkStatus method and return value for the
getLinkStatus method. |
static int |
STATUS_MISSING
A valid parameter value for the
setLinkStatus method and return value for the
getLinkStatus method. |
static int |
STATUS_UNKNOWN
A valid parameter value for the
setLinkStatus method and return value for the
getLinkStatus method. |
Constructor and Description |
---|
CSLinkContent()
Creates an empty
CSLinkContent object. |
Modifier and Type | Method and Description |
---|---|
CSItemContent |
createInstance()
Creates a new
CSLinkContent object and returns it as a CSItemContent , its superclass. |
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSLinkContent object is the same as that contained
within the one supplied. |
int |
getGroupID()
Gets the link ID of the link group to which the link belongs.
|
java.lang.String |
getGroupName()
Gets the name of the link group to which the link belongs.
|
java.lang.String |
getLinkAddress()
Gets the address (URL) of the link.
|
java.lang.String |
getLinkDescription()
Gets the description of the link.
|
int |
getLinkID()
Sets the link ID.
|
int |
getLinkStatus()
Gets the current link accessibility status.
|
java.lang.String |
getLinkText()
Gets the link text to be displayed on the website.
|
void |
setGroupID(int nGroupID)
Sets the ID of the link group to which the link belongs.
|
void |
setGroupName(java.lang.String strGroupName)
Sets the name of the link group to which the link belongs.
|
void |
setLinkAddress(java.lang.String strLinkAddress)
Sets the address (URL) of the link, for example 'www.gossinteractive.com' or 'http://www.gossinteractive.com'.
|
void |
setLinkDescription(java.lang.String strLinkDescription)
Sets the description of the link.
|
void |
setLinkID(int nLinkID)
Gets the link ID of the link.
|
void |
setLinkStatus(int nLinkStatus)
Sets the current link accessibility status.
|
void |
setLinkText(java.lang.String strLinkText)
Sets the link text to be displayed on the website.
|
java.lang.String |
statusToString()
Return the Status as a readable string.
|
java.lang.String |
StatusToString()
Deprecated.
use
statusToString() instead |
static int |
statusToValue(java.lang.String strValue)
Returns the appropriate status constant value for the passed (predefined) String.
|
static int |
StatusToValue(java.lang.String strValue)
Deprecated.
use
statusToValue(String) instead. |
java.lang.String |
toString()
Provides debug information on the contents of the
CSArticleContent object. |
clone, getID, setID, unset
public static final int STATUS_UNKNOWN
setLinkStatus
method and return value for the
getLinkStatus
method. STATUS_UNKNOWN
is used to indicate that the
accessibility of the link target is unknown.public static final int STATUS_LIVE
setLinkStatus
method and return value for the
getLinkStatus
method. STATUS_LIVE
is used to indicate that the link
target is accessible.public static final int STATUS_MISSING
setLinkStatus
method and return value for the
getLinkStatus
method. STATUS_MISSING
is used to indicate that the link
target is temporarily inaccessible.public static final int STATUS_DEAD
setLinkStatus
method and return value for the
getLinkStatus
method. STATUS_DEAD
is used to indicate that the link
target is inaccessible.public int getLinkID()
public void setLinkID(int nLinkID)
nLinkID
- The link ID.public void setLinkText(java.lang.String strLinkText)
strLinkText
- text representing the link for display on the website.public java.lang.String getLinkText()
public void setLinkAddress(java.lang.String strLinkAddress)
It is not necessary to include 'http://' in the address. It will be added automatically if omitted.
strLinkAddress
- the link's URL (address).public java.lang.String getLinkAddress()
public void setLinkDescription(java.lang.String strLinkDescription)
strLinkDescription
- the link's description.public java.lang.String getLinkDescription()
public void setLinkStatus(int nLinkStatus)
nLinkStatus
- the predefined status value.public int getLinkStatus()
public void setGroupName(java.lang.String strGroupName)
strGroupName
- the name of the link group.public java.lang.String getGroupName()
public void setGroupID(int nGroupID)
nGroupID
- the ID of the link group.public int getGroupID()
public CSItemContent createInstance()
CSLinkContent
object and returns it as a CSItemContent
, its superclass.
This is used by the clone
method in CSItemContent
.
CSLinkContent
object.public java.lang.String StatusToString()
statusToString()
insteadSTATUS_UNKNOWN
,
STATUS_LIVE
,
STATUS_MISSING
,
STATUS_DEAD
public java.lang.String statusToString()
STATUS_UNKNOWN
,
STATUS_LIVE
,
STATUS_MISSING
,
STATUS_DEAD
public static int StatusToValue(java.lang.String strValue)
statusToValue(String)
instead.null
or empty string is equivalent to "Live".strValue
- String identifier of Status (or null).STATUS_UNKNOWN
by default.STATUS_UNKNOWN
,
STATUS_LIVE
,
STATUS_MISSING
,
STATUS_DEAD
public static int statusToValue(java.lang.String strValue)
null
or empty string is equivalent to "Live".strValue
- String identifier of Status (or null).STATUS_UNKNOWN
by default.STATUS_UNKNOWN
,
STATUS_LIVE
,
STATUS_MISSING
,
STATUS_DEAD
public java.lang.String toString()
CSArticleContent
object.
toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSLinkContent
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 CSLinkContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.