public class CSEventContent extends CSItemContent
CSEvent
object.
set/get
methods within CSEvent
provide access to this content data and so there should
not typically be any need to explicitly use the set/get
methods supplied here.
CSEvent
,
Serialized FormConstructor and Description |
---|
CSEventContent()
Creates an empty
CSEventContent object. |
Modifier and Type | Method and Description |
---|---|
CSItemContent |
createInstance()
Creates a new
CSEventContent object and returns it as a CSItemContent , its superclass. |
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSEventContent object is the same as that contained
within the one supplied. |
java.lang.String |
getDescription()
Gets the description of the event.
|
int |
getDuration()
Gets the duration of the event.
|
java.lang.String |
getDurationUnit()
Gets the unit of measurement used for specifying the duration of the event.
|
java.util.Date |
getEndDate()
Gets the end date/time of the event.
|
int |
getEventID()
Gets the event ID.
|
int |
getGroupID()
Gets the event group ID.
|
java.lang.String |
getGroupName()
Gets the event group name.
|
int |
getInterval()
Gets the interval of the event.
|
java.lang.String |
getIntervalUnit()
Gets the unit of measurement used for specifying the interval of the event.
|
java.util.ArrayList |
getMetaDataArray()
Get the array of
CSMetaData objects for this event. |
java.lang.String |
getMetaDataOptionalIDs()
Gets the list of metadata value IDs specified via the
CSEventMultiple.setMetaDataOptionalIDs(String)
method that matched for this event. |
int |
getRecurrenceNo()
Gets the total number of times this event is to occur before (and including) the end date/time.
|
java.util.Date |
getStartDate()
Gets the start date/time of the event.
|
void |
setDescription(java.lang.String strDescription)
Sets the description of the event.
|
void |
setDuration(int nDuration)
Sets the duration of the event, in the unit specified using the
setDurationUnit
method. |
void |
setDurationUnit(java.lang.String strDurationUnit)
Sets the unit of measurement for the duration of the event.
|
void |
setEndDate(java.util.Date objEndDate)
Sets the end date/time of the event.
|
void |
setEventID(int nEventID)
Sets the event ID of the event.
|
void |
setGroupID(int nGroupID)
Sets the event group ID.
|
void |
setGroupName(java.lang.String strGroupName)
Sets the event group name.
|
void |
setInterval(int nInterval)
Sets the interval of the event, in the unit specified using the
setIntervalUnit
method. |
void |
setIntervalUnit(java.lang.String strIntervalUnit)
Sets the unit of measurement for the interval of the event.
|
void |
setMetaDataArray(java.util.ArrayList MetaDataArray)
Set the array of
CSMetaData objects for this event. |
void |
setRecurrenceNo(int nRecurrenceNo)
Sets the number of times the event is to occur before (and including) the end date/time.
|
void |
setStartDate(java.util.Date objStartDate)
Sets the start date/time of the event.
|
java.lang.String |
toString()
Provides debug information on the contents of the
CSEventContent object. |
clone, getID, setID, unset
public void setEventID(int nEventID)
nEventID
- the ID of the event.public int getEventID()
public void setGroupID(int nGroupID)
nGroupID
- the ID of the event group to which the event belongs.public int getGroupID()
public void setGroupName(java.lang.String strGroupName)
strGroupName
- the name of the event group to which the event belongs.public java.lang.String getGroupName()
public void setDurationUnit(java.lang.String strDurationUnit)
strDurationUnit
- the unit of measurement for the duration of the event.public java.lang.String getDurationUnit()
public void setIntervalUnit(java.lang.String strIntervalUnit)
strIntervalUnit
- the unit of measurement for the interval of the event.public java.lang.String getIntervalUnit()
public void setDescription(java.lang.String strDescription)
strDescription
- the event's description.public java.lang.String getDescription()
public void setRecurrenceNo(int nRecurrenceNo)
nRecurrenceNo
- the maximum number of occurrences of the event.public int getRecurrenceNo()
public void setDuration(int nDuration)
setDurationUnit
method.
nDuration
- the duration of the event.public int getDuration()
public void setInterval(int nInterval)
setIntervalUnit
method.
nInterval
- the interval of the event.public int getInterval()
public void setStartDate(java.util.Date objStartDate)
objStartDate
- the start date of the event.public java.util.Date getStartDate()
public void setEndDate(java.util.Date objEndDate)
objEndDate
- the end date of the event.public java.util.Date getEndDate()
public CSItemContent createInstance()
CSEventContent
object and returns it as a CSItemContent
, its superclass.
This is used by the clone
method in CSItemContent
.
CSEventContent
object.public void setMetaDataArray(java.util.ArrayList MetaDataArray)
CSMetaData
objects for this event.
MetaDataArray
- an ArrayList
of CSMetaData
objects.public java.util.ArrayList getMetaDataArray()
CSMetaData
objects for this event.
ArrayList
of CSMetaData
objects.public java.lang.String getMetaDataOptionalIDs()
CSEventMultiple.setMetaDataOptionalIDs(String)
method that matched for this event. This list will only be populated when the setMetaDataOptionalIDs
method is specified as key information.
public java.lang.String toString()
CSEventContent
object.
toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSEventContent
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 CSEventContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.