public class CSSubsiteAlias extends CSItem
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.
CSSubsiteAliasContent
,
Serialized FormACCESS_GRANTED, DOES_NOT_EXIST, EMPTY, EXISTS, SECURE_ACCESS_DENIED, SECURE_ACCESS_GRANTED, UPDATE_ACTION_INSERTED, UPDATE_ACTION_UPDATED
LEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
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. |
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 . |
equals, getID, getStatus, hashCode, jsonString, serialiseWithTypes, setID, setStatus, unset
clearRecordedGatewayMessages, clone, count, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache
public CSSubsiteAlias()
CSSubsiteAlias
object.
Use the various set methods provided to initialise the CSSubsiteAlias
object prior to invoking any
of its query methods.
public CSSubsiteAlias(java.lang.String strPropertyFile)
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.
strPropertyFile
- the property file that contains the connection details.public void setAliasID(int nAliasID)
setAliasID
followed by a call to get
will return details of the subsite alias with
the specified subsite alias ID.
nAliasID
- the ID of the subsite alias to be retrieved.public int getAliasID()
public void setProtocol(java.lang.String strProtocol)
strProtocol
- This subsite's protocol (null if unknown/automatic, 'http', 'https', etc)public java.lang.String getProtocol()
public void setURL(java.lang.String strURL)
strURL
- the URL of the subsite alias.public java.lang.String getURL()
public void setDescription(java.lang.String strDescription)
strDescription
- the description of the subsite alias.public java.lang.String getDescription()
public void setSubsiteID(int nSubsiteID)
nSubsiteID
- the subsite ID that the subsite alias is related to.public int getSubsiteID()
public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method.
Valid detail levels for a subsite alias are :
LEVEL_ID
Retrieves Subsite Alias ID only.
LEVEL_ALL
Retrieves all Subsite Alias details.
setDetailLevel
in class CSDatabaseItem
nDetailLevel
- the detail level to be used.CSParameterException
- if an invalid detail level is specified.public boolean exist() throws CSException
CSSubsiteAlias
.
exist
in class CSItem
true
if this subsite alias exists on the database.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.public void delete() throws CSException
CSSubsiteAlias
.
delete
in class CSItem
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.public void update() throws CSException
CSSubsiteAlias
.
update
in class CSItem
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.public void get() throws CSException
Use setAliasID
followed by get
to populate this
CSSubsiteAlias
object with the details of the subsite alias identified by the specified ID.
get
in class CSItem
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.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.