public class CSObjectDefinitionContent extends CSItemContent
CSObjectDefinition
object.
CSObjectDefinition
,
Serialized FormConstructor and Description |
---|
CSObjectDefinitionContent()
Creates an empty
CSObjectDefinitionContent instance. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Creates a duplicate of this
CSObjectDefinitionContent object. |
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSObjectDefinitionContent object is the same as that
contained within the one supplied. |
java.lang.String |
getCFCheck(java.lang.String strObject)
Gets the Coldfusion validation to be performed on this field's data when a form containing it is submitted.
|
java.util.Hashtable |
getChildEmptyObjects()
Gets the empty objects of the object definition's child definitions.
|
java.lang.String |
getDataSubtype(java.lang.String strObject)
Gets the data subtype of the specified field.
|
java.lang.String |
getDataType(java.lang.String strObject)
Gets the data type of the specified field.
|
java.lang.String |
getDDBContents(java.lang.String strObject)
Gets the items to be displayed in the list if the data type
setInputType is
SELECT or MULTISELECT , or as radio buttons if the data type is RADIO . |
java.lang.String |
getDefault(java.lang.String strObject)
Gets the default field value.
|
java.lang.String |
getDescription()
Gets the object definition's description.
|
java.util.Hashtable |
getEmptyObject()
Gets the empty data structure for this definition.
|
java.lang.String |
getErrorMessage(java.lang.String strObject)
Gets the error message that is to be displayed when the field's data validation fails.
|
java.lang.String |
getFieldSize(java.lang.String strObject)
Gets the value to use for the SIZE attribute of this field's input control.
|
java.lang.String |
getFormat(java.lang.String strObject) |
java.lang.String |
getFormLabel(java.lang.String strObject)
Gets the label to be displayed alongside this field when it is displayed on a form.
|
java.lang.String |
getInputType(java.lang.String strObject)
Gets the input type to be used when displaying this field on a form.
|
java.lang.String |
getJSCheck(java.lang.String strObject)
Gets the javascript validation to be performed on this field's data when a form containing it is submitted.
|
java.lang.Object[] |
getNameList()
Gets the array of fully qualified field names.
|
java.lang.String |
getObjectName(java.lang.String strObject)
Gets the field name.
|
int |
getObjectTypeID(java.lang.String strObject)
Gets the unique ID of this definition.
|
boolean |
getRequired(java.lang.String strObject)
Indicates whether this field's value is currently required.
|
boolean |
getSearchable(java.lang.String strObject)
Indicates whether this field's value is currently searchable.
|
java.lang.String |
getSearchableList()
Gets the comma-separated list of searchable field names.
|
java.lang.String |
getType()
Gets the object definition's label.
|
java.util.Hashtable |
getTypeData()
Gets the object definition's data.
|
int |
getTypeID()
Gets the object definition's numeric identifier.
|
void |
setCFCheck(java.lang.String strObject,
java.lang.String strCFCheck)
Sets the ColdFusion validation to be performed on this field's data when a form containing it is submitted.
|
void |
setChildEmptyObjects(java.util.Hashtable childEmptyObjects)
Sets the empty objects of the object definition's child definitions.
|
void |
setDataSubtype(java.lang.String strObject,
java.lang.String strDataType)
Sets the data type of the specified field.
|
void |
setDataType(java.lang.String strObject,
java.lang.String strDataType)
Sets the data type of the specified field.
|
void |
setDDBContents(java.lang.String strObject,
java.lang.String lstDDBContents)
Specifies the items to be displayed in the list if the data type
setInputType is SELECT or MULTISELECT , or as
radio buttons if the data type is RADIO . |
void |
setDefault(java.lang.String strObject,
java.lang.String strDefault)
Sets the default field value.
|
void |
setDescription(java.lang.String strDescription)
Sets the object definition's description.
|
void |
setEmptyObject(java.util.Hashtable hstEmptyObject)
Sets the empty data structure for this definition.
|
void |
setErrorMessage(java.lang.String strObject,
java.lang.String strErrorMessage)
Sets the error message that is to be displayed when the field's data validation fails.
|
void |
setFieldSize(java.lang.String strObject,
java.lang.String strFieldSize)
Sets the value to use for the SIZE attribute of this field's input control.
|
void |
setFormat(java.lang.String strObject,
java.lang.String strFormat) |
void |
setFormLabel(java.lang.String strObject,
java.lang.String strFormLabel)
Sets the label to be displayed alongside this field when it is displayed on a form.
|
void |
setInputType(java.lang.String strObject,
java.lang.String strInputType)
Sets the input type to be used when displaying this field on a form.
|
void |
setJSCheck(java.lang.String strObject,
java.lang.String strJSCheck)
Sets the javascript validation to be performed on this field's data when a form containing it is submitted.
|
void |
setNameList(java.lang.Object[] arrNameList)
Sets the array of fully qualified field names.
|
void |
setObjectName(java.lang.String strObject,
java.lang.String strObjectName)
Sets the field name.
|
void |
setObjectTypeID(java.lang.String strObject,
int nObjectTypeID)
Sets the unique ID of this definition.
|
void |
setRequired(java.lang.String strObject,
boolean bRequired)
Specifies whether this field's value is required in order for a form containing it to be submitted successfully.
|
void |
setSearchable(java.lang.String strObject,
boolean bSearchable)
Specifies whether this field's value should be made searchable.
|
void |
setSearchableList(java.lang.String strSearchableList)
Sets the comma-separated list of searchable field names.
|
void |
setType(java.lang.String strType)
Sets the object definition's label.
|
void |
setTypeData(java.util.Hashtable hstTypeData)
Sets the object definition's data.
|
void |
setTypeID(int nTypeID)
Sets the object definition's numeric identifier.
|
java.lang.String |
toString()
Outputs the contents of this
CSObjectDefinitionContent object to a String object in
a user-friendly format. |
getID, setID, unset
public CSObjectDefinitionContent()
CSObjectDefinitionContent
instance.public void setType(java.lang.String strType)
strType
- The labelpublic java.lang.String getType()
public void setDescription(java.lang.String strDescription)
strDescription
- The descriptionpublic java.lang.String getDescription()
public void setTypeID(int nTypeID)
nTypeID
- The numeric identifierpublic int getTypeID()
public void setTypeData(java.util.Hashtable hstTypeData)
hstTypeData
- A Hashtable
that comprises the definition's datapublic java.util.Hashtable getTypeData()
Hashtable
that comprises the definition's datapublic void setChildEmptyObjects(java.util.Hashtable childEmptyObjects)
public java.util.Hashtable getChildEmptyObjects()
Hashtable
that comprises the empty objects of the definition's child definitions.public void setNameList(java.lang.Object[] arrNameList)
'ELECTRONICINFO'
definition, which in turn resides within the 'BILLTO' definition, would be
referred to as 'BILLTO.ELECTRONICINFO.EMAIL'
within this array.
arrNameList
- An array of String
objectspublic java.lang.Object[] getNameList()
'EMAIL'
field that resides
within the 'ELECTRONICINFO'
definition, which in turn resides within the 'BILLTO' definition,
would be referred to as 'BILLTO.ELECTRONICINFO.EMAIL'
within this array.
String
objectspublic void setSearchableList(java.lang.String strSearchableList)
setNameList
is used.
strSearchableList
- The comma-separated list of fully qualified field namespublic java.lang.String getSearchableList()
getNameList
is used.
public void setEmptyObject(java.util.Hashtable hstEmptyObject)
hstEmptyObject
- A Hashtable
containing the empty data structure that corresponds to this definition.public java.util.Hashtable getEmptyObject()
Hashtable
containing the empty data structure that corresponds to this definition.public java.lang.String getDataType(java.lang.String strObject) throws CSParameterException
Valid values are :
CHAR
- alphanumeric field
INTEGER
- numeric field
DATETIME
- date/time field
OBJECT
- a container for a set of one or more fields
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getFormat(java.lang.String strObject) throws CSParameterException
CSParameterException
public void setDataType(java.lang.String strObject, java.lang.String strDataType) throws CSParameterException
Valid values are :
CHAR
- alphanumeric field
INTEGER
- numeric field
DATETIME
- date/time field
OBJECT
- a container for a set of one or more fields
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrDataType
- The field's data typeCSParameterException
- if there are any problems locating the specified fieldpublic void setFormat(java.lang.String strObject, java.lang.String strFormat) throws CSParameterException
CSParameterException
public java.lang.String getDataSubtype(java.lang.String strObject) throws CSParameterException
This is an optional property of string fields which can specify a valid Solr dynamic field prefix to use for indexing the field e.g. OBJECT_LL_
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setDataSubtype(java.lang.String strObject, java.lang.String strDataType) throws CSParameterException
This is an optional property of string fields which can specify a valid Solr dynamic field prefix to use for indexing the field e.g. OBJECT_LL_
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrDataType
- The field's data typeCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getDDBContents(java.lang.String strObject) throws CSParameterException
setInputType
is
SELECT
or MULTISELECT
, or as radio buttons if the data type is RADIO
.
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setDDBContents(java.lang.String strObject, java.lang.String lstDDBContents) throws CSParameterException
setInputType
is SELECT
or MULTISELECT
, or as
radio buttons if the data type is RADIO
.
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplelstDDBContents
- A comma-separated list of values to be displayed in the listCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getDefault(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setDefault(java.lang.String strObject, java.lang.String strDefault) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrDefault
- The default valueCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getFormLabel(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setFormLabel(java.lang.String strObject, java.lang.String strFormLabel) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrFormLabel
- The field's labelCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getInputType(java.lang.String strObject) throws CSParameterException
Valid values are :
TEXT
- a standard edit box
TEXTAREA
- a memo edit box capable of handling larger amounts of data
SELECT
- a combo/drop-down list box
MULTISELECT
- a multi-select list box
RADIO
- a group of radio buttons
CHECKBOX
- a check box
HIDDEN
- a hidden form field
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setInputType(java.lang.String strObject, java.lang.String strInputType) throws CSParameterException
Valid values are :
TEXT
- a standard edit box
TEXTAREA
- a memo edit box capable of handling larger amounts of data
SELECT
- a combo/drop-down list box
MULTISELECT
- a multi-select list box
RADIO
- a group of radio buttons
CHECKBOX
- a check box
HIDDEN
- a hidden form field
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrInputType
- The field's input typeCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getErrorMessage(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setErrorMessage(java.lang.String strObject, java.lang.String strErrorMessage) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrErrorMessage
- The error messageCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getJSCheck(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setJSCheck(java.lang.String strObject, java.lang.String strJSCheck) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrJSCheck
- The javascript validationCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getCFCheck(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setCFCheck(java.lang.String strObject, java.lang.String strCFCheck) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrCFCheck
- The ColdFusion validationCSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getObjectName(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for example'EMAIL'
for example.CSParameterException
- if there are any problems locating the specified fieldpublic void setObjectName(java.lang.String strObject, java.lang.String strObjectName) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrObjectName
- The field name, 'EMAIL'
for example.CSParameterException
- if there are any problems locating the specified fieldpublic java.lang.String getFieldSize(java.lang.String strObject) throws CSParameterException
TEXT
,
TEXTAREA
, SELECT
, and MULTISELECT
input types
getDataType
.
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setFieldSize(java.lang.String strObject, java.lang.String strFieldSize) throws CSParameterException
TEXT
,
TEXTAREA
, SELECT
, and MULTISELECT
input types
getDataType
.
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplestrFieldSize
- The input control's sizeCSParameterException
- if there are any problems locating the specified fieldpublic boolean getRequired(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for example.CSParameterException
- if there are any problems locating the specified fieldpublic void setRequired(java.lang.String strObject, boolean bRequired) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplebRequired
- Set to true
if this field's value must be enteredCSParameterException
- if there are any problems locating the specified fieldpublic boolean getSearchable(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampletrue
if this field's value is searchableCSParameterException
- if there are any problems locating the specified fieldpublic void setSearchable(java.lang.String strObject, boolean bSearchable) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplebSearchable
- Set to true
if this field's value needs to be searchableCSParameterException
- if there are any problems locating the specified fieldpublic int getObjectTypeID(java.lang.String strObject) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for exampleCSParameterException
- if there are any problems locating the specified fieldpublic void setObjectTypeID(java.lang.String strObject, int nObjectTypeID) throws CSParameterException
strObject
- The fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for examplenObjectTypeID
- The unique definition IDCSParameterException
- if there are any problems locating the specified fieldpublic boolean equals(java.lang.Object obj)
CSObjectDefinitionContent
object is the same as that
contained within the one supplied.
equals
in class CSItemContent
obj
- The CSObjectDefinitionContent
object to be tested for equalitytrue
if the data matches, false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException, java.lang.OutOfMemoryError
CSObjectDefinitionContent
object.
clone
in class CSItemContent
CSObjectDefinitionContent
objectjava.lang.CloneNotSupportedException
- Thrown if cloning is not supported/allowedjava.lang.OutOfMemoryError
- Thrown if there are any problems allocating memorypublic java.lang.String toString()
CSObjectDefinitionContent
object to a String
object in
a user-friendly format.
toString
in class CSItemContent
String
containing the user-friendly outputCopyright © 2022 Goss Interactive Ltd. All Rights Reserved.