gi.controlsite.objects

Class CSFormSectionMultiple

java.lang.Object

gi.controlsite.objects.CSDatabaseItem

gi.controlsite.objects.CSItemMultiple

gi.controlsite.objects.CSFormSectionMultiple

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Deprecated.

This is only used by pre-V9 forms. Class that handles the querying and storage of multiple form sections.

The CSFormSectionMultiple class provides a method that retrieves several form sections from the database. This method requires that certain database and key information (form name, for example) be specified via the set methods provided, prior to its invocation.

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

public class CSFormSectionMultiple
extends CSItemMultiple

See Also:

CSFormSection, CSForm, Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Deprecated. Creates a duplicate of this CSFormSectionMultiple object.
void	delete() Deprecated. Not currently implemented for CSFormSectionMultiple.
boolean	exist() Deprecated. Not currently implemented for CSFormSectionMultiple.
void	get() Deprecated. Retrieves the details of several form sections on an iCM form from the database.
CSObjectDefinition	getDataObjectDefinition() Deprecated. Gets the CSObject instance which holds the data associated with the form sections belonging to this CSFormSectionMultiple object.
int	getFormID() Deprecated. Gets the unique ID of the form specified as key information.
java.lang.String	getFormName() Deprecated. Gets the name of the form specified as key information.
java.lang.String	getSectionName() Deprecated. Gets the name of the form section specified as key information.
int	getSectionNumber() Deprecated. Gets the ordinal number of the form section specified as key information.
void	setDataObjectDefinition(CSObjectDefinition objDataObjectDefinition) Deprecated. Specifies the CSObject instance which contains the existing data to be updated using the form sections belonging to this CSFormSectionMultiple object, or which will be used to store new data captured via these form sections.
void	setDetailLevel(int nDetailLevel) Deprecated. Sets the level of detail to be handled by the get method.
void	setFormID(int nFormID) Deprecated. Sets the unique ID of the form to be used as key information.
void	setFormName(java.lang.String strFormName) Deprecated. Sets the name of the form to be used as key information.
void	setSectionName(java.lang.String strSectionName) Deprecated. Sets the name of the form section to be used as key information.
void	setSectionNumber(int nSectionNumber) Deprecated. Sets the ordinal number of the section within the iCM form, to be used as key information.
java.lang.String	toString() Deprecated. Outputs the contents of this CSFormSectionMultiple object to a String object in a user-friendly format.
void	update() Deprecated. Not currently implemented for CSFormSectionMultiple.

Methods inherited from class gi.controlsite.objects.CSItemMultiple

equals, getItems, getMaxRows, getSortOrder, getStartRow, iterator, setItems, setMaxRows, setSortOrder, setStartRow

Methods inherited from class gi.controlsite.objects.CSDatabaseItem

clearRecordedGatewayMessages, 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, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CSFormSectionMultiple

public CSFormSectionMultiple()

Deprecated.

Creates an empty CSFormSectionMultiple object.

Use the various set methods provided to initialise the CSFormSectionMultiple object prior to invoking any of its query methods. The datasource information should be specified using these set methods.

CSFormSectionMultiple

public CSFormSectionMultiple(java.lang.String strPropertyFile)

Deprecated.

Creates a new CSFormSectionMultiple, specifying a property file that contains all of the database connection details.

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

Parameters:

strPropertyFile - the property file that contains the connection details.

Method Detail

setFormID

public void setFormID(int nFormID)

Deprecated.

Sets the unique ID of the form to be used as key information.

setFormID followed by a call to get will return details of the CSFormSection and CSFormItem objects contained within the specified form. If this parameter is specified, any name specified via setFormName will be ignored.

Parameters:

nFormID - the unique form ID

getFormID

public int getFormID()

Deprecated.

Gets the unique ID of the form specified as key information.

Returns:

The ID of the form used as key information.

setFormName

public void setFormName(java.lang.String strFormName)

Deprecated.

Sets the name of the form to be used as key information.

setFormName followed by a call to get will create CSFormSection objects for each of the form sections on the specified form.

Parameters:

strFormName - the name of the form.

getFormName

public java.lang.String getFormName()

Deprecated.

Gets the name of the form specified as key information.

Returns:

The name of the form used as key information.

setSectionNumber

public void setSectionNumber(int nSectionNumber)

Deprecated.

Sets the ordinal number of the section within the iCM form, to be used as key information. Used when only the section which is at the specified position in the form is to be retrieved. For example, if the CSFormSectionMultiple object consists of only the first section on the form.

setFormName and setSectionNumber followed by a call to get will return details of the form, which will have only one constituent CSFormSection. This section will be the nth section on the iCM form, where n is the specified section number.

Parameters:

nSectionNumber - the ordinal number of the form section within the iCM form, to be used as key information. The CSForm object will consist of only this section.

getSectionNumber

public int getSectionNumber()

Deprecated.

Gets the ordinal number of the form section specified as key information.

Returns:

The ordinal number of the form section used as key information.

setSectionName

public void setSectionName(java.lang.String strSectionName)

Deprecated.

Sets the name of the form section to be used as key information. Used when only the section with the specified name is to be retrieved.

setFormName and setSectionName followed by a call to get will return details of the form, which will have only one constituent CSFormSection, with the specified section name.

Parameters:

strSectionName - the name of the form section, where the form is to consist of only one section.

getSectionName

public java.lang.String getSectionName()

Deprecated.

Gets the name of the form section specified as key information.

Returns:

The name of the form section used as key information.

setDataObjectDefinition

public void setDataObjectDefinition(CSObjectDefinition objDataObjectDefinition)

Deprecated.

Specifies the CSObject instance which contains the existing data to be updated using the form sections belonging to this CSFormSectionMultiple object, or which will be used to store new data captured via these form sections. The setting is of this data object is cascaded to all the form items belonging to these form sections.

A CSObject should only be associated with this CSFormSectionMultiple object if all the form sections use data from the same CSObject. If the form sections use data from different CSObjects, then the different CSObjects should be associated with the form sections using the setDataObject method on the individual CSFormSection objects.

Parameters:

objDataObjectDefinition - the CSObject object holding the data to be updated or newly captured using the form sections.

getDataObjectDefinition

public CSObjectDefinition getDataObjectDefinition()

Deprecated.

Gets the CSObject instance which holds the data associated with the form sections belonging to this CSFormSectionMultiple object.

Returns:

The CSObject instance holding the data to be updated or newly captured using the form sections.

setDetailLevel

public void setDetailLevel(int nDetailLevel)
                    throws CSParameterException

Deprecated.

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

Valid detail levels for a form section are :

• LEVEL_ID Retrieves Section ID only.

.

• LEVEL_ALL Retrieves the above plus the complete Form Item details

.

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

Deprecated.

Retrieves the details of several form sections on an iCM form from the database. Creates CSFormSection objects for the form sections, which in turn creates CSFormItem objects for the form items making up each of these sections.

Use setFormName or setFormID followed by get to add all the form sections of the form with the specified name to this CSFormSectionMultiple object of the form with the specified ID/name.

Use setSectionName as well as setFormName followed by get to add only the section with the specified name to this CSFormSectionMultiple object.

Use setSectionNumber as well as setFormName followed by get to add only the nth section within the form to this CSFormSectionMultiple object.

Overrides:

get in class CSItemMultiple

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.

CSSecurityException - if security has been breached.

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

exist

public boolean exist()
              throws CSException

Deprecated.

Not currently implemented for CSFormSectionMultiple.

Overrides:

exist in class CSItemMultiple

Returns:

true if all attributes exist 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.

update

public void update()
            throws CSException

Deprecated.

Not currently implemented for CSFormSectionMultiple.

Overrides:

update in class CSItemMultiple

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.

delete

public void delete()
            throws CSException

Deprecated.

Not currently implemented for CSFormSectionMultiple.

Overrides:

delete in class CSItemMultiple

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.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException,
                              java.lang.OutOfMemoryError

Deprecated.

Creates a duplicate of this CSFormSectionMultiple object.

Overrides:

clone in class CSDatabaseItem

Returns:

The duplicate CSFormSectionMultiple object.

Throws:

java.lang.CloneNotSupportedException - if cloning is not supported/allowed.

java.lang.OutOfMemoryError - if there are any problems allocating memory.

toString

public java.lang.String toString()

Deprecated.

Outputs the contents of this CSFormSectionMultiple object to a String object in a user-friendly format.

Overrides:

toString in class CSItemMultiple

Returns:

The String containing the user-friendly output.