gi.controlsite.objects

Class CSTemplateImage

java.lang.Object

gi.controlsite.objects.CSDatabaseItem

gi.controlsite.objects.CSItem

gi.controlsite.objects.CSTemplateImage

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CSTemplateImage
extends CSItem

Class that handles the querying and storage of a template image.

The CSTemplateImage class includes methods for the retrieval of a particular image's details. It also provides a method that checks for the existence of an image for a particular template. All such methods require that certain database and key information (template ID, for example) be specified via the set methods provided, prior to their invocation.

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

Since:

iCM 8.0.0

See Also:

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

Method Summary

Modifier and Type	Method and Description
void	delete() Not currently implemented for CSTemplateImage.
boolean	exist() Checks to see whether a template image exists on the database.
void	get() Retrieves the details of a template image from the database.
java.lang.String	getDescription() Gets the image description.
int	getDisplayOrder() Gets the image display order position.
java.lang.String	getFilename() Gets the image filename.
int	getSubsiteID() Gets the ID of the subsite.
int	getTemplateID() Gets the ID of the template.
void	setDescription(java.lang.String description) Sets the image description.
void	setDetailLevel(int nDetailLevel) Sets the level of detail to be handled by the get method.
void	setDisplayOrder(int displayOrder) Sets the image display order position.
void	setFilename(java.lang.String filename) Sets the image filename.
void	setSubsiteID(int nSubsiteID) Sets the ID of the subsite to be used as key information.
void	setTemplateID(int nTemplateID) Sets the ID of the template to be used as key information.
void	update() Not currently implemented for CSTemplateImage.

Methods inherited from class gi.controlsite.objects.CSItem

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

CSTemplateImage

public CSTemplateImage()

Creates an empty CSTemplateImage object.

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

CSTemplateImage

public CSTemplateImage(java.lang.String strPropertyFile)

Creates an empty CSTemplateImage object, specifying a property file that contains all of the database connection details.

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

Parameters:

strPropertyFile - the name of the property file from which the database connection details are to be read.

Method Detail

setDetailLevel

public final void setDetailLevel(int nDetailLevel)
                          throws CSParameterException

Sets the level of detail to be handled by the get method.

Valid detail levels for an asset are :

• LEVEL_ALL - all details are processed

Overrides:

setDetailLevel in class CSDatabaseItem

Parameters:

nDetailLevel - the detail level to be used.

Throws:

CSParameterException - if an invalid detail level is specified.

setTemplateID

public final void setTemplateID(int nTemplateID)

Sets the ID of the template to be used as key information.

setTemplateID, setSubsiteID and setFilename followed by a call to exist will determine whether a template image of that filename exists for the specified template and subsite.

setTemplateID, setSubsiteID and setFilename followed by a call to get will populate this CSTemplateImage instance with details of the specified image for the specified template and subsite.

Parameters:

nTemplateID - the numeric identifier of the template.

getTemplateID

public final int getTemplateID()

Gets the ID of the template.

Returns:

The numeric identifier of the template.

setSubsiteID

public final void setSubsiteID(int nSubsiteID)

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

Use a subsite ID value greater than zero to identify a specific subsite. To identify the enterprise site, specify a subsite ID value of zero. A subsite ID value of -1 may be used to denote the default settings for all subsites.

setSubsiteID, setTemplateID and setFilename followed by a call to exist will determine whether an image of that name exists for the specified template and subsite.

setSubsiteID, setTemplateID and setFilename followed by a call to get will populate this CSTemplateImage instance with details of the specified image for the specified template and subsite.

Parameters:

nSubsiteID - the numeric identifier of the subsite.

getSubsiteID

public final int getSubsiteID()

Gets the ID of the subsite.

Returns:

The numeric identifier of the subsite.

getFilename

public java.lang.String getFilename()

Gets the image filename. The image should exist in the site's /media/templateimages&0 folder.

Returns:

the image filename

setFilename

public void setFilename(java.lang.String filename)

Sets the image filename. The image should exist in the site's /media/templateimages&0 folder.

Parameters:

filename - the image filename to set

getDescription

public java.lang.String getDescription()

Gets the image description.

Returns:

the image Description

setDescription

public void setDescription(java.lang.String description)

Sets the image description.

Parameters:

description - the image description to set

getDisplayOrder

public int getDisplayOrder()

Gets the image display order position.

Returns:

the image's display order position

setDisplayOrder

public void setDisplayOrder(int displayOrder)

Sets the image display order position.

Parameters:

displayOrder - the display order position to set

exist

public final boolean exist()
                    throws CSException

Checks to see whether a template image exists on the database.

Use setTemplateID, setSubsiteID and setFileame followed by exist to check for the existence of an image with a particular filename for the specified template.

Overrides:

exist in class CSItem

Returns:

true if the image exists on the database, false otherwise.

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.

get

public final void get()
               throws CSException

Retrieves the details of a template image from the database.

Use setTemplateID, setSubsiteID and setFilename followed by get to populate this CSTemplateImage instance with the details of a particular template image.

Use the setDetailLevel method to determine the exact information that is retrieved and stored within this CSTemplateImage instance.

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 template cannot be found on the database.

CSSecurityException - if security has been breached.

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

update

public final void update()
                  throws CSException

Not currently implemented for CSTemplateImage.

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 items cannot be found on the database.

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

delete

public final void delete()
                  throws CSException

Not currently implemented for CSTemplateImage.

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 items cannot be found on the database.

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