CSLink (GOSS iCM API)

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

All Implemented Interfaces:

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

See Also:

CSLinkContent, CSLinkMultiple, Serialized Form

Field Summary

Fields
Modifier 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.

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
`CSLink()` Creates an empty `CSLink` object.
`CSLink(java.lang.String strPropertyFile)` Creates a new `CSLink` object, specifying a property file that contains all of the required database connection details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Not currently implemented for `CSLink`.
`void`	`get()` Retrieves the details of a link from the database.
`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.
`boolean`	`getHttpAutoInsert()` Gets whether 'http://' should be automatically inserted in the link address if there is no protocol specifier already present.
`java.lang.String`	`getLinkAddress()` Gets the address (URL) of the link.
`java.lang.String`	`getLinkDescription()` Gets the description of the link.
`int`	`getLinkID()` Gets the link ID currently specified as key information.
`int`	`getLinkStatus()` Gets the current link accessibility status.
`java.lang.String`	`getLinkText()` Gets the link text to be displayed on the website.
`void`	`setDetailLevel(int nDetailLevel)` Sets the level of detail to be handled by the `get` method.
`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`	`setHttpAutoInsert(boolean bHttpAutoInsert)` Used to indicate whether 'http://' should be automatically inserted in the link address if there is no protocol specifier already present.
`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)` Sets the link ID to be used as key information.
`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`	`toString()` Provides debug information on the contents of the `CSLink` object.
`void`	`update()` Not currently implemented for `CSLink`.

Methods inherited from class gi.controlsite.objects.CSItem
equals, exist, getID, getStatus, hashCode, jsonString, serialiseWithTypes, setID, setStatus, 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

- Field Detail
  - STATUS_UNKNOWN
```
public static final int STATUS_UNKNOWN
```
    A valid parameter value for the setLinkStatus method and return value for the getLinkStatus method. STATUS_UNKNOWN is used to indicate that the accessibility of the link target is unknown.
    
    See Also:
    
    Constant Field Values
  - STATUS_LIVE
```
public static final int STATUS_LIVE
```
    A valid parameter value for the setLinkStatus method and return value for the getLinkStatus method. STATUS_LIVE is used to indicate that the link target is accessible.
    
    See Also:
    
    Constant Field Values
  - STATUS_MISSING
```
public static final int STATUS_MISSING
```
    A valid parameter value for the setLinkStatus method and return value for the getLinkStatus method. STATUS_MISSING is used to indicate that the link target is temporarily inaccessible.
    
    See Also:
    
    Constant Field Values
  - STATUS_DEAD
```
public static final int STATUS_DEAD
```
    A valid parameter value for the setLinkStatus method and return value for the getLinkStatus method. STATUS_DEAD is used to indicate that the link target is inaccessible.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CSLink
```
public CSLink()
```
    Creates an empty CSLink object.
    Use the various set methods provided to initialise the CSLink object prior to invoking any of its query methods.
  - CSLink
```
public CSLink(java.lang.String strPropertyFile)
```
    Creates a new CSLink object, specifying a property file that contains all of the required database connection details.
    Use the various set methods provided to initialise the CSLink object prior to invoking any of its query manipulation methods.
    
    Parameters:
    
    strPropertyFile - the property file that contains the connection details.
- Method Detail
  - setLinkID
```
public void setLinkID(int nLinkID)
```
    Sets the link ID to be used as key information.
    setLinkID followed by a call to get will return details of the link with the specified link ID.
    
    Parameters:
    
    nLinkID - the integer ID of the link to be retrieved.
  - getLinkID
```
public int getLinkID()
```
    Gets the link ID currently specified as key information.
    
    Returns:
    
    The link's integer ID.
  - setGroupID
```
public void setGroupID(int nGroupID)
```
    Sets the ID of the link group to which the link belongs.
    
    Parameters:
    
    nGroupID - the integer ID of the link group.
  - getGroupID
```
public int getGroupID()
```
    Gets the link ID of the link group to which the link belongs.
    
    Returns:
    
    The ID of the link group as a String object.
  - setGroupName
```
public void setGroupName(java.lang.String strGroupName)
```
    Sets the name of the link group to which the link belongs.
    
    Parameters:
    
    strGroupName - the name of the link group as a String object.
  - getGroupName
```
public java.lang.String getGroupName()
```
    Gets the name of the link group to which the link belongs.
    
    Returns:
    
    The name of the link group as a String object.
  - setLinkDescription
```
public void setLinkDescription(java.lang.String strLinkDescription)
```
    Sets the description of the link.
    
    Parameters:
    
    strLinkDescription - the link's description as a String object.
  - getLinkDescription
```
public java.lang.String getLinkDescription()
```
    Gets the description of the link.
    
    Returns:
    
    The link's description as a String object.
  - setLinkAddress
```
public void setLinkAddress(java.lang.String strLinkAddress)
```
    Sets the address (URL) of the link, for example 'www.gossinteractive.com' or 'http://www.gossinteractive.com'.
    It is not necessary to include 'http://' in the address. It will be added automatically if omitted, unless specified otherwise using the setHttpAutoInsert method and provided there is no other protocol specifier already present.
    
    Parameters:
    
    strLinkAddress - the link's URL (address) as a String object.
  - getLinkAddress
```
public java.lang.String getLinkAddress()
```
    Gets the address (URL) of the link.
    If not already present, 'http://' is automatically inserted in the address, unless specified otherwise using the setHttpAutoInsert method.
    
    Returns:
    
    The link's (URL) address as a String object.
  - setHttpAutoInsert
```
public void setHttpAutoInsert(boolean bHttpAutoInsert)
```
    Used to indicate whether 'http://' should be automatically inserted in the link address if there is no protocol specifier already present. Defaults to true.
    
    Parameters:
    
    bHttpAutoInsert - indicates whether or not the 'http' prefix should be prepended.
  - getHttpAutoInsert
```
public boolean getHttpAutoInsert()
```
    Gets whether 'http://' should be automatically inserted in the link address if there is no protocol specifier already present.
    
    Returns:
    
    true if 'http://' is automatically inserted, otherwise false.
  - setLinkText
```
public void setLinkText(java.lang.String strLinkText)
```
    Sets the link text to be displayed on the website.
    
    Parameters:
    
    strLinkText - text representing the link for display on the website.
  - getLinkText
```
public java.lang.String getLinkText()
```
    Gets the link text to be displayed on the website.
    
    Returns:
    
    Text representing the link for display on the website.
  - setLinkStatus
```
public void setLinkStatus(int nLinkStatus)
```
    Sets the current link accessibility status.
    Links newly added via iCM will be assigned an initial status of STATUS_LIVE. This status is thereafter maintained by the ExternalLinkCheck housekeeping task.
    Valid values for a link status are :
    - STATUS_UNKNOWN - The status has not been retrieved from the database.
    - STATUS_LIVE - The link is accessible.
    - STATUS_MISSING - The link is temporarily inaccessible.
    - STATUS_DEAD - The link is inaccessible.
    Parameters:
    
    nLinkStatus - the predefined status value.
  - getLinkStatus
```
public int getLinkStatus()
```
    Gets the current link accessibility status.
    Links newly added via iCM will be assigned an initial status of STATUS_LIVE. This status is thereafter maintained by the ExternalLinkCheck housekeeping task.
    Valid values for a link status are :
    - STATUS_UNKNOWN - The status has not been retrieved from the database.
    - STATUS_LIVE - The link is accessible.
    - STATUS_MISSING - The link is temporarily inaccessible.
    - STATUS_DEAD - The link is inaccessible.
    Returns:
    
    The predefined status value.
  - setDetailLevel
```
public void setDetailLevel(int nDetailLevel)
                    throws CSParameterException
```
    Sets the level of detail to be handled by the get method.
    Valid detail levels for a link are :
    - LEVEL_ID Retrieves Link ID only.
    .
    - LEVEL_ALL Retrieves all link data, including Link Text.
    .
    Overrides:
    
    setDetailLevel in class CSDatabaseItem
    
    Parameters:
    
    nDetailLevel - the detail level to be used.
    
    Throws:
    
    CSParameterException - if an invalid detail level is specified.
  - get
```
public void get()
         throws CSException
```
    Retrieves the details of a link from the database.
    Use setLinkID followed by get to populate this CSLink object with the details of the link 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 CSLink.
    
    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 CSLink.
    
    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.
  - toString
```
public java.lang.String toString()
```
    Provides debug information on the contents of the CSLink object.
    
    Overrides:
    
    toString in class CSItem
    
    Returns:
    
    The String containing the user-friendly output.

Class CSLink

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

Field Detail

STATUS_UNKNOWN

STATUS_LIVE

STATUS_MISSING

STATUS_DEAD

Constructor Detail

CSLink

CSLink

Method Detail

setLinkID

getLinkID

setGroupID

getGroupID

setGroupName

getGroupName

setLinkDescription

getLinkDescription

setLinkAddress

getLinkAddress

setHttpAutoInsert

getHttpAutoInsert

setLinkText

getLinkText

setLinkStatus

getLinkStatus

setDetailLevel

get

delete

update

toString