CSEvent (GOSS iCM API)

java.lang.Object
- gi.controlsite.objects.CSDatabaseItem
- - gi.controlsite.objects.CSItem
  - - gi.controlsite.objects.CSEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CSEvent
extends CSItem
```
Class that handles the querying of an event that has been set-up within the EVENTS section of iCM.
The CSEvent class includes methods for the retrieval of a particular event's details.
All such methods require that certain database and key information (event ID, for example) be specified via the set methods provided, prior to their invocation.
All database access/connectivity is handled internally by the CSEvent class.

See Also:

CSEventContent, CSEventMultiple, Serialized Form

Field Summary
- Fields inherited from class gi.controlsite.objects.CSItem
  ACCESS_GRANTED, DOES_NOT_EXIST, EMPTY, EXISTS, SECURE_ACCESS_DENIED, SECURE_ACCESS_GRANTED, UPDATE_ACTION_INSERTED, UPDATE_ACTION_UPDATED
- Fields inherited from class gi.controlsite.objects.CSDatabaseItem
  LEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY

Constructor Summary

Constructors
Constructor and Description
`CSEvent()` Creates an empty `CSEvent` object.
`CSEvent(java.lang.String strPropertyFile)` Creates a new `CSEvent`, specifying a properties file that contains all of the database connection details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Not currently implemented for `CSEvent`.
`void`	`get()` Retrieves the details of an event from the database.
`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 in which the event's duration is specified using the `setDuration` method.
`java.util.Date`	`getEndDate()` Gets the last date/time on which the event can occur.
`int`	`getEventID()` Gets the event ID of the event.
`int`	`getGroupID()` Gets the ID of the event group to which the event belongs.
`java.lang.String`	`getGroupName()` Gets the name of the event group to which the event belongs.
`int`	`getInterval()` Gets the interval of the event, specified in the units indicated by the `setIntervalUnit` method.
`java.lang.String`	`getIntervalUnit()` Gets the unit in which the event's interval is specified using the `setInterval` method.
`java.util.ArrayList`	`getMetaData()` Get the array of `CSMetaData` objects associated with 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 number of times the event is to occur, up to and including the end date/time.
`java.util.Date`	`getStartDate()` Gets the start date of the event.
`void`	`setDescription(java.lang.String strDescription)` Sets the description of the event.
`void`	`setDetailLevel(int nDetailLevel)` Sets the level of detail to be handled by the `get` method.
`void`	`setDuration(int nDuration)` Sets the event's duration, specified in the units indicated by the `setDurationUnit` method.
`void`	`setDurationUnit(java.lang.String strDurationUnit)` Sets the unit in which the event's duration is specified using the `setDuration` method.
`void`	`setEndDate(java.util.Date objEndDate)` Sets the last date/time on which the event can occur.
`void`	`setEventID(int nEventID)` Sets the event ID to be used as key information.
`void`	`setGroupID(int nGroupID)` Sets the ID of the event group to which the event belongs.
`void`	`setGroupName(java.lang.String strGroupName)` Sets the name of the event group to which the event belongs.
`void`	`setInterval(int nInterval)` Sets the event's interval, specified in the units indicated by the `setIntervalUnit` method.
`void`	`setIntervalUnit(java.lang.String strIntervalUnit)` Sets the unit in which the event's interval is specified using the `setInterval` method.
`void`	`setMetaDataArray(java.util.ArrayList MetaDataArray)` Set the array of `CSMetaData` objects associated with this event.
`void`	`setRecurrenceNo(int nRecurrenceNo)` Sets the number of times the event is to occur.
`void`	`setStartDate(java.util.Date objStartDate)` Sets the start date of the event.
`void`	`update()` Not currently implemented for `CSEvent`.

Methods inherited from class gi.controlsite.objects.CSItem
equals, exist, getID, getStatus, hashCode, jsonString, serialiseWithTypes, setID, setStatus, toString, unset

Methods inherited from class gi.controlsite.objects.CSDatabaseItem
clearRecordedGatewayMessages, clone, count, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CSEvent
```
public CSEvent()
```
    Creates an empty CSEvent object.
    Use the various set methods provided to initialise the CSEvent object prior to invoking any of its query methods.
  - CSEvent
```
public CSEvent(java.lang.String strPropertyFile)
```
    Creates a new CSEvent, specifying a properties file that contains all of the database connection details.
    Use the various set methods provided to initialise the CSEvent object prior to invoking any of its query manipulation methods.
    
    Parameters:
    
    strPropertyFile - the property file that contains the connection details.
- Method Detail
  - setDetailLevel
```
public void setDetailLevel(int nDetailLevel)
                    throws CSParameterException
```
    Sets the level of detail to be handled by the get method. Default is LEVEL_DETAIL.
    Valid detail levels for an event are :
    - LEVEL_ID Retrieves the Event ID only.
    .
    - LEVEL_SUMMARY Retrieves Event ID, Description, Start Date, End Date, Group Name and Group ID only.
    .
    - LEVEL_DETAIL Retrieves all article data, except for associated metadata.
    .
    - LEVEL_ALL Retrieves all event data, including associated metadata.
    .
    Overrides:
    
    setDetailLevel in class CSDatabaseItem
    
    Parameters:
    
    nDetailLevel - the detail level to be used.
    
    Throws:
    
    CSParameterException - if an invalid detail level is specified.
  - setEventID
```
public void setEventID(int nEventID)
```
    Sets the event ID to be used as key information.
    setEventID followed by a call to get will return details of the event with the specified event ID.
    
    Parameters:
    
    nEventID - the ID of the event to be retrieved.
  - getEventID
```
public int getEventID()
```
    Gets the event ID of the event.
    
    Returns:
    
    The event ID.
  - setGroupID
```
public void setGroupID(int nGroupID)
```
    Sets the ID of the event group to which the event belongs.
    
    Parameters:
    
    nGroupID - the event group ID.
  - getGroupID
```
public int getGroupID()
```
    Gets the ID of the event group to which the event belongs.
    
    Returns:
    
    The event group ID.
  - setGroupName
```
public void setGroupName(java.lang.String strGroupName)
```
    Sets the name of the event group to which the event belongs.
    
    Parameters:
    
    strGroupName - the event group name.
  - getGroupName
```
public java.lang.String getGroupName()
```
    Gets the name of the event group to which the event belongs.
    
    Returns:
    
    The event group name.
  - setDuration
```
public void setDuration(int nDuration)
```
    Sets the event's duration, specified in the units indicated by the setDurationUnit method.
    
    Parameters:
    
    nDuration - the duration of the event.
  - getDuration
```
public int getDuration()
```
    Gets the duration of the event.
    
    Returns:
    
    The duration of the event, in units indicated by the setDurationUnit method.
  - setDurationUnit
```
public void setDurationUnit(java.lang.String strDurationUnit)
```
    Sets the unit in which the event's duration is specified using the setDuration method.
    
    Parameters:
    
    strDurationUnit - the unit of measurement of the duration of the event.
  - getDurationUnit
```
public java.lang.String getDurationUnit()
```
    Gets the unit in which the event's duration is specified using the setDuration method.
    
    Returns:
    
    The unit of measurement of the duration of the event.
  - setInterval
```
public void setInterval(int nInterval)
```
    Sets the event's interval, specified in the units indicated by the setIntervalUnit method.
    
    Parameters:
    
    nInterval - the interval of the event.
  - getInterval
```
public int getInterval()
```
    Gets the interval of the event, specified in the units indicated by the setIntervalUnit method.
    
    Returns:
    
    The interval of the event.
  - setIntervalUnit
```
public void setIntervalUnit(java.lang.String strIntervalUnit)
```
    Sets the unit in which the event's interval is specified using the setInterval method.
    
    Parameters:
    
    strIntervalUnit - the unit of measurement of the interval of the event.
  - getIntervalUnit
```
public java.lang.String getIntervalUnit()
```
    Gets the unit in which the event's interval is specified using the setInterval method.
    
    Returns:
    
    The unit of measurement of the interval of the event.
  - setRecurrenceNo
```
public void setRecurrenceNo(int nRecurrenceNo)
```
    Sets the number of times the event is to occur.
    
    Parameters:
    
    nRecurrenceNo - the number of times the event is to occur, up to and including the end date/time.
  - getRecurrenceNo
```
public int getRecurrenceNo()
```
    Gets the number of times the event is to occur, up to and including the end date/time.
    
    Returns:
    
    The number of times the event is to occur.
  - setDescription
```
public void setDescription(java.lang.String strDescription)
```
    Sets the description of the event.
    
    Parameters:
    
    strDescription - the event's description.
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description of the event.
    
    Returns:
    
    The event's description.
  - setStartDate
```
public void setStartDate(java.util.Date objStartDate)
```
    Sets the start date of the event.
    
    Parameters:
    
    objStartDate - the event's start date.
  - getStartDate
```
public java.util.Date getStartDate()
```
    Gets the start date of the event.
    
    Returns:
    
    The event's start date.
  - setEndDate
```
public void setEndDate(java.util.Date objEndDate)
```
    Sets the last date/time on which the event can occur.
    
    Parameters:
    
    objEndDate - the event's end date.
  - getEndDate
```
public java.util.Date getEndDate()
```
    Gets the last date/time on which the event can occur.
    
    Returns:
    
    The event's end date.
  - setMetaDataArray
```
public void setMetaDataArray(java.util.ArrayList MetaDataArray)
```
    Set the array of CSMetaData objects associated with this event.
    
    Parameters:
    
    MetaDataArray - an ArrayList populated with CSMetaData objects each of which represents a metadata item associated with this event.
  - getMetaData
```
public java.util.ArrayList getMetaData()
```
    Get the array of CSMetaData objects associated with this event.
    
    Returns:
    
    An ArrayList populated with CSMetaData objects which represent metadata associated with this event.
  - getMetaDataOptionalIDs
```
public java.lang.String getMetaDataOptionalIDs()
```
    Gets the list of metadata value IDs specified via the CSEventMultiple.setMetaDataOptionalIDs(String) method that matched for this event. This list will only be populated when the setMetaDataOptionalIDs method is specified as key information.
    
    Returns:
    
    A comma-separated list of metadata value IDs.
  - get
```
public void get()
         throws CSException
```
    Retrieves the details of an event from the database.
    Use setEventID followed by get to populate this CSEvent object with the details of the event identified by the specified ID.
    
    Overrides:
    
    get in class CSItem
    
    Throws:
    
    CSParameterException - if an invalid combination of key information has been supplied.
    
    CSDatabaseException - if there are problems accessing the database.
    
    CSNotFoundException - if the specified attribute cannot be found on the database.
    
    CSSecurityException - if security has been breached.
    
    CSException - the base class for exceptions thrown by this method.
  - delete
```
public void delete()
            throws CSException
```
    Not currently implemented for CSEvent.
    
    Overrides:
    
    delete in class CSItem
    
    Throws:
    
    CSParameterException - if an invalid combination of key information has been supplied.
    
    CSDatabaseException - if there are problems accessing the database.
    
    CSNotFoundException - if one of the specified attributes cannot be found on the database.
    
    CSException - the base class for exceptions thrown by this method.
  - update
```
public void update()
            throws CSException
```
    Not currently implemented for CSEvent.
    
    Overrides:
    
    update in class CSItem
    
    Throws:
    
    CSParameterException - if an invalid combination of key information has been supplied.
    
    CSDatabaseException - if there are problems accessing the database.
    
    CSNotFoundException - if one of the specified attributes cannot be found on the database.
    
    CSException - the base class for exceptions thrown by this method.

Class CSEvent

Field Summary

Fields inherited from class gi.controlsite.objects.CSItem

Fields inherited from class gi.controlsite.objects.CSDatabaseItem

Constructor Summary

Method Summary

Methods inherited from class gi.controlsite.objects.CSItem

Methods inherited from class gi.controlsite.objects.CSDatabaseItem

Methods inherited from class java.lang.Object

Constructor Detail

CSEvent

CSEvent

Method Detail

setDetailLevel

setEventID

getEventID

setGroupID

getGroupID

setGroupName

getGroupName

setDuration

getDuration

setDurationUnit

getDurationUnit

setInterval

getInterval

setIntervalUnit

getIntervalUnit

setRecurrenceNo

getRecurrenceNo

setDescription

getDescription

setStartDate

getStartDate

setEndDate

getEndDate

setMetaDataArray

getMetaData

getMetaDataOptionalIDs

get

delete

update