gi.controlsite.objects

Class CSSubsiteAlias

java.lang.Object

gi.controlsite.objects.CSDatabaseItem

gi.controlsite.objects.CSItem

gi.controlsite.objects.CSSubsiteAlias

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CSSubsiteAlias
extends CSItem

Class that handles the querying of an iCM subsite alias.

The CSSubsiteAlias class includes methods for the retrieval of a particular subsite alias details. All such methods require that certain database and key information (alias ID, for example) be specified via the set methods provided, prior to their invocation.

This CSSubsiteAlias class is only intended for use on database version 5.3.1.0 or later.

All database access/connectivity is handled internally by the CSSubsiteAlias class.

See Also:

CSSubsiteAliasContent, 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
CSSubsiteAlias() Creates an empty CSSubsiteAlias object.
CSSubsiteAlias(java.lang.String strPropertyFile) Creates a new CSSubsiteAlias, specifying a properties files that contains all of the database connection details.

Method Summary

Modifier and Type	Method and Description
void	delete() Not currently implemented for CSSubsiteAlias.
boolean	exist() Not currently implemented for CSSubsiteAlias.
void	get() Retrieves the details of a subsite alias from the database.
int	getAliasID() Gets the ID of the subsite alias.
java.lang.String	getDescription() Gets the subsite alias description.
java.lang.String	getProtocol() Gets the subsite alias protocol.
int	getSubsiteID() Gets the subsite ID that the subsite alias is related to.
java.lang.String	getURL() Gets the subsite alias URL.
void	setAliasID(int nAliasID) Sets the subsite alias ID to be used as key information.
void	setDescription(java.lang.String strDescription) Sets the subsite alias description.
void	setDetailLevel(int nDetailLevel) Sets the level of detail to be handled by the get method.
void	setProtocol(java.lang.String strProtocol) Sets this subsite's protocol (null if unknown/automatic, http, https, etc).
void	setSubsiteID(int nSubsiteID) Sets the subsite ID that the subsite alias is related to.
void	setURL(java.lang.String strURL) Sets the subsite alias URL.
java.lang.String	toString() Provides debug information on the contents of the CSSubsiteAlias object.
void	update() Not currently implemented for CSSubsiteAlias.

Methods inherited from class gi.controlsite.objects.CSItem

equals, 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

Constructor Detail

CSSubsiteAlias

public CSSubsiteAlias()

Creates an empty CSSubsiteAlias object.

Use the various set methods provided to initialise the CSSubsiteAlias object prior to invoking any of its query methods.

CSSubsiteAlias

public CSSubsiteAlias(java.lang.String strPropertyFile)

Creates a new CSSubsiteAlias, specifying a properties files that contains all of the database connection details.

Use the various set methods provided to initialise the CSSubsiteAlias object prior to invoking any of its query manipulation methods.

Parameters:

strPropertyFile - the property file that contains the connection details.

Method Detail

setAliasID

public void setAliasID(int nAliasID)

Sets the subsite alias ID to be used as key information.

setAliasID followed by a call to get will return details of the subsite alias with the specified subsite alias ID.

Parameters:

nAliasID - the ID of the subsite alias to be retrieved.

getAliasID

public int getAliasID()

Gets the ID of the subsite alias.

Returns:

The subsite alias ID.

setProtocol

public void setProtocol(java.lang.String strProtocol)

Sets this subsite's protocol (null if unknown/automatic, http, https, etc).

Parameters:

strProtocol - This subsite's protocol (null if unknown/automatic, 'http', 'https', etc)

getProtocol

public java.lang.String getProtocol()

Gets the subsite alias protocol.

Returns:

The protocol of the subsite alias.

setURL

public void setURL(java.lang.String strURL)

Sets the subsite alias URL.

Parameters:

strURL - the URL of the subsite alias.

getURL

public java.lang.String getURL()

Gets the subsite alias URL.

Returns:

The URL of the subsite alias.

setDescription

public void setDescription(java.lang.String strDescription)

Sets the subsite alias description.

Parameters:

strDescription - the description of the subsite alias.

getDescription

public java.lang.String getDescription()

Gets the subsite alias description.

Returns:

The description of the subsite alias.

setSubsiteID

public void setSubsiteID(int nSubsiteID)

Sets the subsite ID that the subsite alias is related to.

Parameters:

nSubsiteID - the subsite ID that the subsite alias is related to.

getSubsiteID

public int getSubsiteID()

Gets the subsite ID that the subsite alias is related to.

Returns:

the subsite ID that the subsite alias is related to.

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 subsite alias are :

• LEVEL_ID Retrieves Subsite Alias ID only.

.

• LEVEL_ALL Retrieves all Subsite Alias details.

.

Overrides:

setDetailLevel in class CSDatabaseItem

Parameters:

nDetailLevel - the detail level to be used.

Throws:

CSParameterException - if an invalid detail level is specified.

exist

public boolean exist()
              throws CSException

Not currently implemented for CSSubsiteAlias.

Overrides:

exist in class CSItem

Returns:

true if this subsite alias exists on the database.

Throws:

CSParameterException - if an invalid combination of key information has been supplied.

CSDatabaseException - if there are problems accessing the database.

CSException - the base class for exceptions thrown by this method.

delete

public void delete()
            throws CSException

Not currently implemented for CSSubsiteAlias.

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 CSSubsiteAlias.

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.

get

public void get()
         throws CSException

Retrieves the details of a subsite alias from the database.

Use setAliasID followed by get to populate this CSSubsiteAlias object with the details of the subsite alias 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 subsite alias cannot be found on the database.

CSSecurityException - if security has been breached.

CSException - the base class for exceptions thrown by this method.

toString

public java.lang.String toString()

Provides debug information on the contents of the CSSubsiteAlias object.

Overrides:

toString in class CSItem

Returns:

The String containing the user-friendly output.