public class CSMediaContent extends CSItemContent
CSMediaType
object.
CSMedia
,
CSMediaMultiple
,
Serialized FormConstructor and Description |
---|
CSMediaContent()
Construct a
CSMediaContent object. |
Modifier and Type | Method and Description |
---|---|
CSItemContent |
createInstance()
Creates a new
CSMediaContent object and returns it as a CSItemContent , its
superclass. |
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSMediaContent object is equal to another object. |
int |
getArticleID()
Get the article ID, linked to by the media item.
|
java.lang.String |
getBoostedKeywords() |
float |
getBoostValue() |
java.util.Date |
getCreationDate()
Gets the date and time on which the media item was created.
|
java.lang.String |
getDescription()
Get the description of the media item.
|
boolean |
getDisplay()
Gets the flag which indicates whether the media item should be displayed or not.
|
java.util.Date |
getEndDate()
Gets the end date and time for the display of the media item on the website.
|
java.util.ArrayList |
getFileArray()
Get the array of filenames for this media item.
|
int |
getGroupID()
Get the group ID for this media item.
|
java.lang.String |
getGroupName()
Get the group name for this media item.
|
java.lang.String |
getKeywords()
Get the keywords of this media item.
|
java.util.Date |
getLastModifiedDate()
Gets the date and time on which the media item was last modified.
|
int |
getLinkID()
Get the external link ID for this media item.
|
java.lang.String |
getLinkText() |
int |
getMediaID()
Get the media ID.
|
CSDelimList |
getMediaPath()
Gets the media's path.
|
java.lang.String |
getMetaDataOptionalIDs()
Gets the list of metadata value IDs specified via the
CSMediaMultiple.setMetaDataOptionalIDs(String)
method that matched for this media. |
int |
getOwnerID() |
java.lang.String |
getOwnerType() |
java.lang.String |
getRelatedMetaDataIDs() |
boolean |
getReviewable()
Gets the flag to indicate whether the media item needs reviewing or not.
|
java.util.Date |
getReviewDate()
Gets the date and time at which the media item is scheduled for review.
|
int |
getReviewInterval()
Gets the number of hours between regular media item reviews.
|
java.util.Date |
getStartDate()
Gets the start date and time for the display of the media item on the website.
|
java.lang.String |
getTitle()
Get the title of the media item.
|
java.lang.String |
getType()
Get the type of media item.
|
int |
getTypeID()
Get the media type ID for this media item.
|
int |
getUserID()
Get the user ID for this media item.
|
void |
setArticleID(int nArticleID)
Set the article ID, linked to by the media item.
|
void |
setBoostedKeywords(java.lang.String boostedKeywords) |
void |
setBoostValue(float boostValue) |
void |
setCreationDate(java.util.Date objCreationDate)
Sets the date and time on which the media item was created.
|
void |
setDescription(java.lang.String strDesc)
Set the description of the media item.
|
void |
setDisplay(boolean bDisplay)
Sets a flag to indicate whether the media item should be displayed or not.
|
void |
setEndDate(java.util.Date objEndDate)
Sets the end date and time for the display of the media item on the website.
|
void |
setFileArray(java.util.ArrayList FileArray)
Set the array of filenames for this media item.
|
void |
setGroupID(int nGroupID)
Set the group ID for this media item.
|
void |
setGroupName(java.lang.String strGroupName)
Set the group name for this media item.
|
void |
setKeywords(java.lang.String strKeywords)
Set the keywords of this media item.
|
void |
setLastModifiedDate(java.util.Date objLastModifiedDate)
Sets the date and time on which the media item was last modified.
|
void |
setLinkID(int nLinkID)
Set the external link ID for this media item.
|
void |
setLinkText(java.lang.String linkText) |
void |
setMediaID(int nMediaID)
Set the media ID.
|
void |
setMediaPath(java.lang.String strMediaPath)
Sets the media's path.
|
void |
setOwnerID(int ownerID) |
void |
setOwnerType(java.lang.String ownerType) |
void |
setRelatedMetaDataIDs(java.lang.String strRelatedMetaDataIDs) |
void |
setReviewable(boolean bReviewable)
Sets a flag to indicate whether the media item needs reviewing or not.
|
void |
setReviewDate(java.util.Date objReviewDate)
Sets the date and time on which the media item is to be reviewed.
|
void |
setReviewInterval(int nReviewIntervalHours)
Sets the number of hours between regular media item reviews.
|
void |
setStartDate(java.util.Date objStartDate)
Sets the start date and time for the display of the media item on the website.
|
void |
setTitle(java.lang.String strTitle)
Set the title of the media item.
|
void |
setType(java.lang.String strType)
Set the type of media item.
|
void |
setTypeID(int nTypeID)
Set the media type ID for this media item.
|
void |
setUserID(int nUserID)
Set the user ID for this media item.
|
java.lang.String |
toString()
Outputs the contents of this
CSMediaContent object to a String object in a
user-friendly format. |
clone, getID, setID, unset
public CSMediaContent()
CSMediaContent
object.
The MediaID is initialised to 0,
the Media Title is initialised to null,
the Media Description is initialised to null,
the Article ID is initialised to 0,
the External Link ID is initialised to 0,
the Media Type ID is initialised to 0,
the Media Type is initialised to null, and
the Group Name is initialised to null.
public void setMediaID(int nMediaID)
nMediaID
- the unique numeric ID of the media item.public int getMediaID()
public void setTitle(java.lang.String strTitle)
strTitle
- a String
containing the title of the media.public java.lang.String getTitle()
String
containing the title of the media.public void setDescription(java.lang.String strDesc)
strDesc
- a String
containing the description of the media.public java.lang.String getDescription()
String
containing the description of the media.public void setArticleID(int nArticleID)
nArticleID
- the unique numeric ID of the article which this media links to.public int getArticleID()
public void setLinkID(int nLinkID)
nLinkID
- the unique numeric ID of the external link.public int getLinkID()
public void setTypeID(int nTypeID)
nTypeID
- the unique numeric ID of the media type.public int getTypeID()
public void setUserID(int nUserID)
nUserID
- the unique user ID of the media type.public int getUserID()
public void setType(java.lang.String strType)
strType
- a String
containing the media type. This also equates to the name of the sub-directory,
below the media directory, in which the media files are located.public java.lang.String getType()
String
containing the media item's type.public void setKeywords(java.lang.String strKeywords)
strKeywords
- a String
containing the keywords.public java.lang.String getKeywords()
String
containing the media item's keywords.public void setGroupID(int nGroupID)
nGroupID
- the ID of this media item's group.public int getGroupID()
public void setGroupName(java.lang.String strGroupName)
strGroupName
- a String
containing the name of this media item's group.public java.lang.String getGroupName()
String
containing the name of this media item's group.public void setFileArray(java.util.ArrayList FileArray)
FileArray
- an ArrayList
of CSMediaContentFile
objects.public java.util.ArrayList getFileArray()
ArrayList
of CSMediaContentFile
objects.public void setDisplay(boolean bDisplay)
bDisplay
- the flag indicating whether the media item should be displayed or not.public boolean getDisplay()
public void setCreationDate(java.util.Date objCreationDate)
objCreationDate
- the creation date and time of the media item.public java.util.Date getCreationDate()
public void setLastModifiedDate(java.util.Date objLastModifiedDate)
objLastModifiedDate
- the date and time when the media item was last modified.public java.util.Date getLastModifiedDate()
public void setEndDate(java.util.Date objEndDate)
objEndDate
- the end date and time for the display of the media item 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 media item on the website.public java.util.Date getStartDate()
public void setReviewable(boolean bReviewable)
bReviewable
- flag indicating whether the media item needs reviewing or not.public boolean getReviewable()
public void setReviewDate(java.util.Date objReviewDate)
objReviewDate
- the date and time when the media item should be reviewed.public java.util.Date getReviewDate()
public void setReviewInterval(int nReviewIntervalHours)
nReviewIntervalHours
- the number of hours between regular media item reviews.public int getReviewInterval()
public java.lang.String getMetaDataOptionalIDs()
CSMediaMultiple.setMetaDataOptionalIDs(String)
method that matched for this media. 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_fBoostValue to set.public int getOwnerID()
public void setOwnerID(int ownerID)
ownerID
- The m_nOwnerID to set.public java.lang.String getBoostedKeywords()
public void setBoostedKeywords(java.lang.String boostedKeywords)
boostedKeywords
- The m_strBoostedKeywords to set.public java.lang.String getLinkText()
public void setLinkText(java.lang.String linkText)
linkText
- The m_strLinkText to set.public java.lang.String getOwnerType()
public void setOwnerType(java.lang.String ownerType) throws CSParameterException
ownerType
- The m_strOwnerType to set.CSParameterException
- if OwnerType is not recognisedCSMedia.OWNERTYPE_GROUP
,
CSMedia.OWNERTYPE_USER
public java.lang.String getRelatedMetaDataIDs()
public void setRelatedMetaDataIDs(java.lang.String strRelatedMetaDataIDs)
strRelatedMetaDataIDs
- Comma delimited list of metadata IDs to set.public void setMediaPath(java.lang.String strMediaPath)
strMediaPath
- the media's path.public CSDelimList getMediaPath()
public CSItemContent createInstance()
CSMediaContent
object and returns it as a CSItemContent
, its
superclass.
CSMediaContent
object.public java.lang.String toString()
CSMediaContent
object to a String
object in a
user-friendly format.
toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSMediaContent
object is equal to another object.
Note that the key data used for searching is not tested for equality.
equals
in class CSItemContent
obj
- the object to be tested for equality.false
if there are any differences between the objects.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.