public class CSSubsite extends CSItem
The CSSubsite
class includes methods for the retrieval of a particular subsite's details. All such
methods require that certain database and key information (subsite ID, for example) be specified via the
set
methods provided, prior to their invocation.
All database access/connectivity is handled internally by the CSSubsite
class.
CSSubsiteContent
,
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 |
---|
CSSubsite()
Creates an empty
CSSubsite object. |
CSSubsite(java.lang.String strPropertyFile)
Creates a new
CSSubsite , specifying a properties files that contains all of the database
connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSSubsite . |
boolean |
exist()
Not currently implemented for
CSSubsite . |
void |
get()
Retrieves the details of a subsite from the database.
|
java.util.ArrayList |
getAliases()
Gets the subsite aliases that are related to the subsite.
|
java.lang.String |
getDefaultDoc()
Gets the type of pages processed by the subsite.
|
java.lang.String |
getDescription()
Gets the description of the subsite.
|
boolean |
getEnforceIPRules()
Gets whether or not this subsite has IP Rules.
|
CSObject |
getExtensionData()
Get the extension data object or null if none
|
boolean |
getExtensionDataReqd()
Get the flag that requests that subsite extension data is returned
|
int |
getExtensionObjectID()
Get the ID of the extension data object or zero if none
|
int |
getGroupID()
Gets the group ID of the subsite.
|
int |
getHomePageID()
Gets the article ID of the subsite's home page.
|
java.lang.String |
getIcmProtocol()
Gets the subsite's iCM URL protocol
|
java.lang.String |
getIcmURL()
Gets the subsite's iCM URL
|
int |
getID()
Gets the ID of the subsite.
|
java.lang.String |
getName()
Gets the name of the subsite.
|
java.lang.String |
getProcotol()
Deprecated.
|
java.lang.String |
getProtocol()
Gets whether or not this subsite has IP Rules.
|
java.lang.String |
getRootArticleIDs()
Gets the subite's root article ID list.
|
java.lang.String |
getRootEventIDs()
Gets the subite's root event ID group list.
|
java.lang.String |
getRootFeatureIDs()
Gets the subite's root feature group ID list.
|
java.lang.String |
getRootForumIDs()
Gets the subite's root forum ID list.
|
java.lang.String |
getRootLinkIDs()
Gets the subite's root external link group ID list.
|
java.lang.String |
getRootMediaIDs()
Gets the subite's root media group ID list.
|
java.lang.String |
getRootMetadataIDs()
Gets the subite's root metadata group ID list.
|
java.lang.String |
getRootPollIDs()
Gets the subite's root poll ID group list.
|
java.lang.String |
getURL()
Gets the URL of the subsite.
|
int |
getUserID()
Gets the User ID of the subsite.
|
int |
getZoneID()
Gets the Subsite Zone ID
|
boolean |
isIPAccessAllowed(java.net.InetAddress source,
boolean secure)
Checks whether a particular IP/protocol combination can access this subsite.
|
void |
setAliases(java.util.ArrayList arrAliases)
Sets the subsite aliases that are related to the subsite.
|
void |
setDefaultDoc(java.lang.String strDefaultDoc)
Sets the type of pages processed by the subsite.
|
void |
setDescription(java.lang.String strDescription)
Sets the description of the subsite.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setEnforceIPRules(java.lang.Boolean bEnf)
Sets whether or not this subsite has IP Rules.
|
void |
setExtensionData(CSObject obj)
Set the ID of the extension data object or zero if none
|
void |
setExtensionDataReqd(boolean extensionDataReqd)
Set the flag that requests that subsite extension data is returned
|
void |
setExtensionObjectID(int objectID)
Set the ID of the extension data object or zero if none
|
void |
setGroupID(int nGroupID)
Sets the subsite group ID.
|
void |
setHomePageID(int nHomePageID)
Sets the article ID of the subsite's home page to be used as key information.
|
void |
setIcmProtocol(java.lang.String icmProtocol)
Sets the subsite's iCM URL protocol (null if unknown, otherwise either http or https)
|
void |
setIcmURL(java.lang.String strIcmURL)
Sets the subsite's iCM URL
|
void |
setID(int nID)
Sets the subsite ID to be used as key information.
|
void |
setName(java.lang.String strName)
Sets the name of the subsite to be used as key information..
|
void |
setProtocol(java.lang.String protocol)
Sets this subsite's protocol (null, http, https, etc).
|
void |
setRootArticleIDs(java.lang.String strRootArticleIDs)
Sets the subite's root article ID list.
|
void |
setRootEventIDs(java.lang.String strRootEventIDs)
Sets the subite's root event group ID list.
|
void |
setRootFeatureIDs(java.lang.String strRootFeatureIDs)
Sets the subite's root feature group ID list.
|
void |
setRootForumIDs(java.lang.String strRootForumIDs)
Sets the subite's root forum ID list.
|
void |
setRootLinkIDs(java.lang.String strRootLinkIDs)
Sets the subite's root external link group ID list.
|
void |
setRootMediaIDs(java.lang.String strRootMediaIDs)
Sets the subite's root media group ID list.
|
void |
setRootMetadataIDs(java.lang.String strRootMetadataIDs)
Sets the subite's root metadata group ID list.
|
void |
setRootPollIDs(java.lang.String strRootPollIDs)
Sets the subite's root poll group ID list.
|
void |
setURL(java.lang.String strURL)
Sets the URL of the subsite to be used as key information..
|
void |
setUserID(int nUserID)
Sets the subsite user ID.
|
java.lang.String |
toString()
Provides debug information on the contents of the
CSSubsite object. |
void |
update()
Not currently implemented for
CSSubsite . |
equals, getStatus, hashCode, jsonString, serialiseWithTypes, 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 CSSubsite()
CSSubsite
object.
Use the various set methods provided to initialise the CSSubsite
object prior to invoking any of
its query methods.
public CSSubsite(java.lang.String strPropertyFile)
CSSubsite
, specifying a properties files that contains all of the database
connection details.
Use the various set methods provided to initialise the CSSubsite
object prior to invoking any of
its query manipulation methods.
strPropertyFile
- the property file that contains the connection details.public void setAliases(java.util.ArrayList arrAliases)
arrAliases
- the subsite aliases that are related to the subsite.public java.util.ArrayList getAliases()
public void setUserID(int nUserID)
nUserID
- the user ID of the subsite.public int getUserID()
public void setGroupID(int nGroupID)
nGroupID
- the group ID of the subsite.public int getGroupID()
public void setID(int nID)
setID
followed by a call to get
will return details of the subsite with the
specified subsite ID.
public int getID()
public void setName(java.lang.String strName)
setName
followed by a call to get
will return details of the subsite with the
specified subsite name.
strName
- the subsite's name to be retrieved.public java.lang.String getName()
public void setDescription(java.lang.String strDescription)
strDescription
- the subsite's description.public java.lang.String getDescription()
public void setProtocol(java.lang.String protocol)
protocol
- This subsite's protocol (null if unknown/automatic, 'http', 'https', etc)public java.lang.String getProcotol()
public java.lang.String getProtocol()
public void setURL(java.lang.String strURL)
setURL
followed by a call to get
will return details of the subsite with the
specified subsite or alias URL.
strURL
- the subsite's URL.public java.lang.String getURL()
public void setIcmProtocol(java.lang.String icmProtocol)
icmProtocol
- This subsite's iCM URL protocol (null if unknown/automatic, 'http', 'https', etc)public java.lang.String getIcmProtocol()
public void setIcmURL(java.lang.String strIcmURL)
strIcmURL
- the subsite's iCM URL.public java.lang.String getIcmURL()
public void setDefaultDoc(java.lang.String strDefaultDoc)
NOTE: This only applies for database versions from 5.3.1.0.
strDefaultDoc
- the type of pages processed by the subsite.public java.lang.String getDefaultDoc()
NOTE: This only applies for database versions from 5.3.1.0.
public void setEnforceIPRules(java.lang.Boolean bEnf)
bEnf
- true if this subsite should enforce IP Rules.public boolean getEnforceIPRules()
public int getZoneID()
public void setHomePageID(int nHomePageID)
nHomePageID
- the subsite's home page article ID.public int getHomePageID()
public void setRootArticleIDs(java.lang.String strRootArticleIDs)
strRootArticleIDs
- subite's root article ID list.public java.lang.String getRootArticleIDs()
public void setRootMetadataIDs(java.lang.String strRootMetadataIDs)
strRootMetadataIDs
- subite's root metedata group ID list.public java.lang.String getRootMetadataIDs()
public void setRootMediaIDs(java.lang.String strRootMediaIDs)
strRootMediaIDs
- subite's root media group ID list.public java.lang.String getRootMediaIDs()
public void setRootLinkIDs(java.lang.String strRootLinkIDs)
strRootLinkIDs
- subite's root external link group ID list.public java.lang.String getRootLinkIDs()
public void setRootFeatureIDs(java.lang.String strRootFeatureIDs)
strRootFeatureIDs
- subite's root feature group ID list.public java.lang.String getRootFeatureIDs()
public void setRootEventIDs(java.lang.String strRootEventIDs)
strRootEventIDs
- subite's root event group ID list.public java.lang.String getRootEventIDs()
public void setRootForumIDs(java.lang.String strRootForumIDs)
NOTE: for database versions prior to 5.2.1.0, this must be a list of forum ID's. For database versions from 5.2.1.0, this must be a list of forum group ID's.
strRootForumIDs
- subite's root forum ID list.public java.lang.String getRootForumIDs()
For database versions prior to 5.2.1.0, this will be a list of forum ID's. For database versions from 5.2.1.0, this will be a list of forum group ID's.
public void setRootPollIDs(java.lang.String strRootPollIDs)
This will be ignored for database versions earlier than 5.2.1.0.
strRootPollIDs
- subite's root poll group ID list.public java.lang.String getRootPollIDs()
This property will only be set for database versions from 5.2.1.0 onwards.
public boolean getExtensionDataReqd()
public void setExtensionDataReqd(boolean extensionDataReqd)
extensionDataReqd
- true to request extension datapublic int getExtensionObjectID()
public void setExtensionObjectID(int objectID)
objectID
- ID of the extension data object or zero if nonepublic CSObject getExtensionData()
public void setExtensionData(CSObject obj)
obj
- The extension data object or zero if nonepublic void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method.
Valid detail levels for a subsite are :
LEVEL_ID
Retrieves Subsite ID only.
LEVEL_ALL
Retrieves all Subsite 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
CSSubsite
.
exist
in class CSItem
true
if this subsite 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
CSSubsite
.
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
CSSubsite
.
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 setID
followed by get
to populate this CSSubsite
object
with the details of the subsite identified by the specified ID.
Use setName
followed by get
to populate this CSSubsite
object with the details of the subsite which has the specified name.
Use setURL
followed by get
to populate this CSSubsite
object with the details of the subsite which has the specified URL.
Use setHomePageID
followed by get
to populate this
CSSubsite
object with the details of the subsite which has the specified root (home page) article.
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 attribute cannot be found on the database.CSSecurityException
- if security has been breached.CSException
- the base class for exceptions thrown by this method.public boolean isIPAccessAllowed(java.net.InetAddress source, boolean secure) throws CSDatabaseException, CSException, java.sql.SQLException
Use setID
followed by isIPAccessAllowed
to check whether a source IP should be allowed to
access this subsite.
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.java.sql.SQLException
Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.