public class CSObjectDefinition extends CSItem
CSObject
has
a type specified for it that identifies the definition that describes its data.
The CSObjectDefinition
class includes methods for the retrieval of a particular object definition. All
such methods require that certain database and key information (type ID, for example) be specified via the
set
methods provided, prior to their invocation.
All database access/connectivity is handled internally by the CSObjectDefinition
class.
CSObjectDefinitionContent
,
CSObject
,
CSObjectMultiple
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
DATATYPE_ARRAY
One of the valid values that can be passed to the
setDataType method. |
static java.lang.String |
DATATYPE_CHAR
Deprecated.
Use DATATYPE_STRING
|
static java.lang.String |
DATATYPE_DATETIME
Deprecated.
Use DATATYPE_STRING with format "date-time"
|
static java.lang.String |
DATATYPE_INTEGER
One of the valid values that can be passed to the
setDataType method. |
static java.lang.String |
DATATYPE_LONGCHAR
Deprecated.
Use DATATYPE_STRING
|
static java.lang.String |
DATATYPE_NUMBER
One of the valid values that can be passed to the
setDataType method. |
static java.lang.String |
DATATYPE_NUMERIC
Deprecated.
Use DATATYPE_NUMBER
|
static java.lang.String |
DATATYPE_OBJECT
One of the valid values that can be passed to the
setDataType method. |
static java.lang.String |
DATATYPE_STRING
One of the valid values that can be passed to the
setDataType method. |
static java.lang.String |
INPUTTYPE_CHECKBOX
Deprecated.
This is only used by pre-V9 forms.
One of the valid values that can be passed to the
setInputType method.
|
static java.lang.String |
INPUTTYPE_HIDDEN
Deprecated.
This is only used by pre-V9 forms.
One of the valid values that can be passed to the
setInputType method.
|
static java.lang.String |
INPUTTYPE_MULTISELECT
Deprecated.
This is only used by pre-V9 forms.
One of the valid values that can be passed to the
setInputType method.
|
static java.lang.String |
INPUTTYPE_RADIO
Deprecated.
This is only used by pre-V9 forms.
One of the valid values that can be passed to the
setInputType method.
|
static java.lang.String |
INPUTTYPE_SELECT
Deprecated.
This is only used by pre-V9 forms.
One of the valid values that can be passed to the
setInputType method.
|
static java.lang.String |
INPUTTYPE_TEXT
Deprecated.
This is only used by pre-V9 forms.
One of the valid values that can be passed to the
setInputType method.
|
static java.lang.String |
INPUTTYPE_TEXTAREA
Deprecated.
This is only used by pre-V9 forms.
One of the valid values that can be passed to the
setInputType method.
|
ACCESS_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 |
---|
CSObjectDefinition()
Creates an empty
CSObjectDefinition object. |
CSObjectDefinition(java.lang.String strPropertyFile)
Creates an empty
CSObjectDefinition object, specifying a property file that contains all of the
database connection details. |
Modifier and Type | Method and Description |
---|---|
void |
cacheAll()
Re-caches all objects.
|
java.lang.Object |
clone()
Creates a duplicate of this
CSObjectDefinition object. |
void |
decacheAll()
Empty the cache.
|
void |
delete()
Not currently implemented for
CSObjectDefinition . |
boolean |
exist()
Checks to see whether a particular iCM object definition exists on the database.
|
void |
get()
Retrieves the details of an iCM object's definition from the database.
|
java.util.Map<java.lang.String,java.lang.Integer> |
getAvailableTypes()
Returns a map of available type names to their associated IDs
|
java.lang.String |
getCFCheck(java.lang.String strObject)
Deprecated.
This is only used by pre-V9 forms.
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 Hashtable containing the empty objects for every child definition of this CSObjectDefinition.
|
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)
Deprecated.
This is only used by pre-V9 forms.
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)
Deprecated.
This is only used by pre-V9 forms.
Gets the error message that is to be displayed when the field's data validation fails.
|
java.lang.String |
getFieldSize(java.lang.String strObject)
Deprecated.
This is only used by pre-V9 forms.
Gets the value to use for the SIZE attribute of this field's input control. Only relevant to
TEXT ,
TEXTAREA , SELECT , and MULTISELECT input types
getDataType .
|
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)
Deprecated.
This is only used by pre-V9 forms.
Gets the input type to be used when displaying this field on a form.
Valid values are :
|
java.lang.String |
getJSCheck(java.lang.String strObject)
Deprecated.
This is only used by pre-V9 forms.
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 |
getReadOnly()
Indicates whether or not this instance is read only
|
boolean |
getRequired(java.lang.String strObject)
Deprecated.
This is only used by pre-V9 forms.
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.
|
boolean |
getTopLevelOnly()
Indicates whether the details for all child definitions are to be retrieved or not.
|
java.lang.String |
getType()
Gets the object definition's textual identifier currently set as key information.
|
java.util.Hashtable |
getTypeData()
Gets the object definition's data.
|
int |
getTypeID()
Gets the object definition's numeric identifier currently specified as key information.
|
boolean |
isPathValidForDefinition(java.lang.String flattenedObjectKey)
Given a flattened object key, determine if that key is present in the name list and if each part of the key matches the object type definition.
|
void |
setCFCheck(java.lang.String strObject,
java.lang.String strCFCheck)
Deprecated.
This is only used by pre-V9 forms.
Sets the ColdFusion validation to be performed on this field's data when a form containing it is submitted.
|
void |
setDataSubtype(java.lang.String strObject,
java.lang.String strDataSubtype)
Sets the data subtype 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)
Deprecated.
This is only used by pre-V9 forms.
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 |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setEmptyObject(java.util.Hashtable hstEmptyObject)
Sets the empty data structure for this definition.
|
void |
setErrorMessage(java.lang.String strObject,
java.lang.String strErrorMessage)
Deprecated.
This is only used by pre-V9 forms.
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)
Deprecated.
This is only used by pre-V9 forms.
Sets the value to use for the SIZE attribute of this field's input control. Only relevant to
TEXT ,
TEXTAREA , SELECT , and MULTISELECT input types
getDataType .
|
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)
Deprecated.
This is only used by pre-V9 forms.
Sets the input type to be used when displaying this field on a form.
Valid values are :
|
void |
setJSCheck(java.lang.String strObject,
java.lang.String strJSCheck)
Deprecated.
This is only used by pre-V9 forms.
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 |
setReadOnly()
Marks the instance as read only so it can be cached
|
void |
setRequired(java.lang.String strObject,
boolean bRequired)
Deprecated.
This is only used by pre-V9 forms.
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 |
setTopLevelOnly(boolean bTopLevelOnly)
Deprecated.
Only whole object type definitions are ever returned.
|
void |
setType(java.lang.String strType)
Sets the object definition's textual identifier to be used as key information.
|
void |
setTypeData(java.util.Hashtable hstTypeData)
Sets the object definition's data.
|
void |
setTypeID(int nTypeID)
Sets the object definition's numeric identifier to be used as key information.
|
void |
update()
Not currently implemented for
CSObjectDefinition . |
equals, getID, getStatus, hashCode, jsonString, serialiseWithTypes, setID, setStatus, toString, unset
clearRecordedGatewayMessages, count, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache
public static final java.lang.String DATATYPE_STRING
setDataType
method.
DATATYPE_CHAR
indicates that the field contains a character string.
public static final java.lang.String DATATYPE_NUMBER
setDataType
method.
DATATYPE_NUMERIC
indicates that the field contains a numeric value.
public static final java.lang.String DATATYPE_CHAR
setDataType
method.
DATATYPE_CHAR
indicates that the field contains a character string.
public static final java.lang.String DATATYPE_LONGCHAR
setDataType
method.
DATATYPE_LONGCHAR
indicates that the field contains a long character string.
public static final java.lang.String DATATYPE_INTEGER
setDataType
method.
DATATYPE_INTEGER
indicates that the field contains an integer value.
public static final java.lang.String DATATYPE_NUMERIC
setDataType
method.
DATATYPE_NUMERIC
indicates that the field contains a numeric value.
public static final java.lang.String DATATYPE_DATETIME
setDataType
method.
DATATYPE_DATETIME
indicates that the field contains a date/time value.
public static final java.lang.String DATATYPE_OBJECT
setDataType
method.
DATATYPE_OBJECT
indicates that the field is a container which contains one or more other fields..
public static final java.lang.String DATATYPE_ARRAY
setDataType
method.
DATATYPE_ARRAY
indicates that the field is an array which can contain other data types.
public static final java.lang.String INPUTTYPE_TEXT
setInputType
method.
INPUTTYPE_TEXT
indicates that a simple edit box will be used to display the field's value.
public static final java.lang.String INPUTTYPE_TEXTAREA
setInputType
method.
INPUTTYPE_TEXTAREA
indicates that a memo-style edit box will be used to display the field's value.
public static final java.lang.String INPUTTYPE_SELECT
setInputType
method.
INPUTTYPE_SELECT
indicates that a drop-down listbox will be used to display the field's value.
public static final java.lang.String INPUTTYPE_MULTISELECT
setInputType
method.
INPUTTYPE_MULTISELECT
indicates that a multi-select listbox will be used to display the field's
value.
public static final java.lang.String INPUTTYPE_RADIO
setInputType
method.
INPUTTYPE_RADIO
indicates that a group of radio buttons will be used to display the field's value.
public static final java.lang.String INPUTTYPE_CHECKBOX
setInputType
method.
INPUTTYPE_CHECKBOX
indicates that a checkbox will be used to display the field's value.
public static final java.lang.String INPUTTYPE_HIDDEN
setInputType
method.
INPUTTYPE_HIDDEN
indicates that the field's value will be present on the input form but hidden.
This is used frequently in ColdFusion for transferring data from one form to the next, etc.
public CSObjectDefinition()
CSObjectDefinition
object.
Use the various set methods provided to initialise the CSObjectDefinition
object prior to invoking
any of its query methods.
public CSObjectDefinition(java.lang.String strPropertyFile)
CSObjectDefinition
object, specifying a property file that contains all of the
database connection details.
Use the various set methods provided to initialise the CSObjectDefinition
object prior to invoking
any of its query methods.
strPropertyFile
- the name of the property file from which the database connection details are to be readpublic java.util.Hashtable getChildEmptyObjects()
public void setReadOnly()
public boolean getReadOnly()
true
if the instance is read onlypublic void setTopLevelOnly(boolean bTopLevelOnly)
bTopLevelOnly
- Set to false
if only the definition of the top-most object is required. By default, all
child definitions will be retrieved.public boolean getTopLevelOnly()
true
if all child definitions are currently retrieved.public void setType(java.lang.String strType)
strType
- The object definition's textual identifier, 'UserProfile' for example.public 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 setNameList(java.lang.Object[] arrNameList)
'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.
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 void setDataType(java.lang.String strObject, java.lang.String strDataType) throws CSParameterException
Valid values are :
CSObjectDefinition.DATATYPE_STRING
- alphanumeric field
CSObjectDefinition.DATATYPE_CHAR
- alphanumeric field (deprecated)
CSObjectDefinition.DATATYPE_LONGCHAR
- long alphanumeric field (deprecated)
CSObjectDefinition.DATATYPE_INTEGER
- numeric field (deprecated)
CSObjectDefinition.DATATYPE_NUMBER
- numeric field
CSObjectDefinition.DATATYPE_DATETIME
- date/time field (deprecated)
CSObjectDefinition.DATATYPE_OBJECT
- a container for a set of one or more fields
CSObjectDefinition.DATATYPE_ARRAY
- a container for an array of fields or sets of 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 getDataType(java.lang.String strObject) throws CSParameterException
Valid values are :
CSObjectDefinition.DATATYPE_STRING
- alphanumeric field
CSObjectDefinition.DATATYPE_CHAR
- alphanumeric field (deprecated)
CSObjectDefinition.DATATYPE_LONGCHAR
- long alphanumeric field (deprecated)
CSObjectDefinition.DATATYPE_INTEGER
- numeric field (deprecated)
CSObjectDefinition.DATATYPE_NUMBER
- numeric field
CSObjectDefinition.DATATYPE_DATETIME
- date/time field (deprecated)
CSObjectDefinition.DATATYPE_OBJECT
- a container for a set of one or more fields
CSObjectDefinition.DATATYPE_ARRAY
- a container for an array of fields or sets of 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 setDataSubtype(java.lang.String strObject, java.lang.String strDataSubtype) 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 examplestrDataSubtype
- The field's data typeCSParameterException
- if there are any problems locating the specified fieldpublic 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 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 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 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 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 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 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 setInputType(java.lang.String strObject, java.lang.String strInputType) throws CSParameterException
Valid values are :
CSObjectDefinition.INPUTTYPE_TEXT
- a standard edit box
CSObjectDefinition.INPUTTYPE_TEXTAREA
- a memo edit box capable of handling larger amounts of
data
CSObjectDefinition.INPUTTYPE_SELECT
- a combo/drop-down list box
CSObjectDefinition.INPUTTYPE_MULTISELECT
- a multi-select list box
CSObjectDefinition.INPUTTYPE_RADIO
- a group of radio buttons
CSObjectDefinition.INPUTTYPE_CHECKBOX
- a check box
CSObjectDefinition.INPUTTYPE_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 getInputType(java.lang.String strObject) throws CSParameterException
Valid values are :
CSObjectDefinition.INPUTTYPE_TEXT
- a standard edit box
CSObjectDefinition.INPUTTYPE_TEXTAREA
- a memo edit box capable of handling larger amounts of
data
CSObjectDefinition.INPUTTYPE_SELECT
- a combo/drop-down list box
CSObjectDefinition.INPUTTYPE_MULTISELECT
- a multi-select list box
CSObjectDefinition.INPUTTYPE_RADIO
- a group of radio buttons
CSObjectDefinition.INPUTTYPE_CHECKBOX
- a check box
CSObjectDefinition.INPUTTYPE_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 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 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 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 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 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 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 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 getObjectName(java.lang.String strObject) throws CSParameterException
strObject
- fully qualified field name, 'BILLTO.ELECTRONICINFO.EMAIL'
for example'EMAIL'
for example.CSParameterException
- 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 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 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 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 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 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 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 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 setDetailLevel(int nDetailLevel) throws CSParameterException
get
method.
Valid detail levels for an object definition are :
LEVEL_ALL - all details are processed
setDetailLevel
in class CSDatabaseItem
nDetailLevel
- The detail level to be usedCSParameterException
- if an invalid detail level is specified.public boolean exist() throws CSException
Use setTypeID
followed by exist
to determine whether a definition with the
specified ID exists on the database.
Use setType
followed by exist
to determine whether a definition with the
specified textual ID (e.g. 'UserProfile') exists on the database.
exist
in class CSItem
true
if the definition exists on the databaseCSParameterException
- if an invalid combination of key information has been suppliedCSDatabaseException
- if there are problems accessing the databaseCSException
- the base class for exceptions thrown by this method.public void get() throws CSException
Use setTypeID
followed by get
to populate this
CSObjectDefinition
object with the definition identified by the specified numeric ID.
Use setType
followed by get
to populate this
CSObjectDefinition
object with the definition identified by the specified textual ID e.g.
'UserProfile'.
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 definition cannot be found on the database.CSSecurityException
- if security has been breached.CSException
- the base class for exceptions thrown by this method.public void update() throws CSException
CSObjectDefinition
.
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 the specified feature cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSObjectDefinition
.
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 the specified feature cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void cacheAll() throws java.sql.SQLException, CSException
java.sql.SQLException
- SQLExceptionCSException
- CSExceptionpublic void decacheAll()
public java.util.Map<java.lang.String,java.lang.Integer> getAvailableTypes() throws CSDatabaseException, CSException, java.sql.SQLException
CSParameterException
- CSParameterExceptionCSDatabaseException
- CSDatabaseExceptionjava.sql.SQLException
- SQLExceptionCSException
public boolean isPathValidForDefinition(java.lang.String flattenedObjectKey) throws CSParameterException
flattenedObjectKey
- The key for the object whose path we're checking. For example, "CONTACT.EMAIL" or "CONTACT[2].EMAIL".CSParameterException
- CSParameterExceptionpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException, java.lang.OutOfMemoryError
CSObjectDefinition
object.
clone
in class CSDatabaseItem
CSObjectDefinition
object.java.lang.CloneNotSupportedException
- if cloning is not supported/allowed.java.lang.OutOfMemoryError
- if there are any problems allocating memory.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.