public interface IDfType extends IDfPersistentObject
Modifier and Type | Field and Description |
---|---|
static int |
DF_BOOLEAN
Represents the boolean datatype.
|
static int |
DF_DOUBLE
Represents the double datatype.
|
static int |
DF_ID
Represents the ID datatype.
|
static int |
DF_INTEGER
Represents the integer datatype.
|
static int |
DF_STRING
Represents the string datatype.
|
static int |
DF_TIME
Represents the time, or date, datatype.
|
static int |
DF_UNDEFINED
Represents an undefined datatype.
|
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
int |
findTypeAttrIndex(java.lang.String attrName)
Returns the index of an attribute.
|
java.lang.String |
getDescription()
Returns the user-defined label for a type.
|
java.lang.String |
getName()
Returns a type's name.
|
java.lang.String |
getSuperName()
Returns the name of a type's supertype.
|
IDfType |
getSuperType()
Returns a type's super type.
|
IDfAttr |
getTypeAttr(int attrIndex)
Returns an IDfAttr representing the type's attribute located at the position
attrIndex in
this object's list of attributes. |
IDfList |
getTypeAttrAssistanceWithValues(java.lang.String attrName,
IDfId policyId,
java.lang.String state,
IDfList depAttrNameList,
IDfList depAttrValueListList)
Deprecated.
|
IDfList |
getTypeAttrAsstDependencies(java.lang.String attrName,
IDfId policyId,
java.lang.String state)
Deprecated.
|
int |
getTypeAttrCount()
Returns the number of attributes in a type.
|
int |
getTypeAttrDataType(java.lang.String attrName)
Returns the datatype of an attribute.
|
int |
getTypeAttrDataTypeAt(int index)
Returns the datatype of an attribute.
|
java.lang.String |
getTypeAttrDescription(java.lang.String attrName)
Returns the user-defined label for an attribute.
|
java.lang.String |
getTypeAttrDescriptionAt(int index)
Returns the user-defined label for an attribute.
|
int |
getTypeAttrLength(java.lang.String attrName)
Returns the maximum number of characters in a string-valued attribute.
|
int |
getTypeAttrLengthAt(int index)
Returns the maximum number of characters in a string-valued attribute.
|
java.lang.String |
getTypeAttrNameAt(int index)
Returns an attribute name for a type.
|
IDfValidator |
getTypeValidator(IDfId policyId,
java.lang.String state)
Returns the IDfValidator that is assocated with this IDfType.
|
java.lang.String |
getTypeWidgetType(int environment,
java.lang.String attrName,
IDfId policyId,
java.lang.String state)
Deprecated.
|
boolean |
isSubTypeOf(java.lang.String typeName)
Indicates whether a type is a subtype of type
typeName . |
boolean |
isTypeAttrRepeating(java.lang.String attrName)
Indicates whether an attribute is repeating.
|
boolean |
isTypeAttrRepeatingAt(int index)
Indicates whether an attribute is repeating.
|
boolean |
isTypeOf(java.lang.String typeName)
Returns true if an object of this type is also an object of type
typeName . |
void |
validateTypeAttrRulesWithValue(java.lang.String attrName,
IDfId policyId,
java.lang.String state,
java.lang.String value,
IDfList depAttrNameList,
IDfList depAttrValueListList,
int stopAfterNumOfErrors)
Deprecated.
|
void |
validateTypeAttrRulesWithValues(java.lang.String attrName,
IDfId policyId,
java.lang.String state,
IDfList values,
IDfList depAttrNameList,
IDfList depAttrValueListList,
int stopAfterNumOfErrors)
Deprecated.
|
void |
validateTypeObjRulesWithValues(IDfList attrNameList,
IDfId policyId,
java.lang.String state,
IDfList valueListList,
int stopAfterNumOfErrors)
Deprecated.
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
static final int DF_BOOLEAN
static final int DF_INTEGER
static final int DF_STRING
static final int DF_ID
static final int DF_TIME
static final int DF_DOUBLE
static final int DF_UNDEFINED
java.lang.String getName() throws DfException
DfException
- if a server error occursjava.lang.String getSuperName() throws DfException
DfException
- if a server error occursjava.lang.String getDescription() throws DfException
DfException
- if a server error occursIDfType getSuperType() throws DfException
NULL
.DfException
- thrown if the supertype exists but cannot be found or if a server error occursboolean isTypeOf(java.lang.String typeName) throws DfException
typeName
.DfException
- if an error occursboolean isSubTypeOf(java.lang.String typeName) throws DfException
typeName
.
Note: This method returns false if its argument is not a direct supertype
of the given type.DfException
- if a server error occursint findTypeAttrIndex(java.lang.String attrName) throws DfException
This method returns -1 if the specified attribute does not exist.
DfException
- if a server error occursint getTypeAttrCount() throws DfException
DfException
- if a server error occursIDfAttr getTypeAttr(int attrIndex) throws DfException
attrIndex
in
this object's list of attributes.attrIndex
- the index position of the attribute among the object's typesDfException
- if a server error occursfindTypeAttrIndex(java.lang.String)
java.lang.String getTypeAttrNameAt(int index) throws DfException
DfException
- if a server error occursint getTypeAttrDataType(java.lang.String attrName) throws DfException
Value Datatype 0 Boolean 1 Integer 2 String 3 ID 4 Time, or date 5 Double 6 Undefined
DfException
- if a server error occursint getTypeAttrDataTypeAt(int index) throws DfException
Value Datatype 0 Boolean 1 Integer 2 String 3 ID 4 Time, or date 5 Double 6 Undefined
DfException
- if a server error occursboolean isTypeAttrRepeating(java.lang.String attrName) throws DfException
DfException
- if a server error occursboolean isTypeAttrRepeatingAt(int index) throws DfException
DfException
- if a server error occursint getTypeAttrLength(java.lang.String attrName) throws DfException
This method returns 0 for all attributes storing non-string values.
DfException
- if a server error occursint getTypeAttrLengthAt(int index) throws DfException
This method returns 0 for all attributes storing non-string values.
DfException
- if a server error occursjava.lang.String getTypeAttrDescription(java.lang.String attrName) throws DfException
DfException
- if a server error occursjava.lang.String getTypeAttrDescriptionAt(int index) throws DfException
DfException
- if a server error occursIDfValidator getTypeValidator(IDfId policyId, java.lang.String state) throws DfException
DfException
void validateTypeAttrRulesWithValue(java.lang.String attrName, IDfId policyId, java.lang.String state, java.lang.String value, IDfList depAttrNameList, IDfList depAttrValueListList, int stopAfterNumOfErrors) throws DfException
DfException
void validateTypeAttrRulesWithValues(java.lang.String attrName, IDfId policyId, java.lang.String state, IDfList values, IDfList depAttrNameList, IDfList depAttrValueListList, int stopAfterNumOfErrors) throws DfException
DfException
void validateTypeObjRulesWithValues(IDfList attrNameList, IDfId policyId, java.lang.String state, IDfList valueListList, int stopAfterNumOfErrors) throws DfException
stopAfterNumOfErrors
- The maximum number of violations this method will detect Pass zero to this
parameter if you want the method to finish validating regardless of the
number of violationsDfException
IDfList getTypeAttrAsstDependencies(java.lang.String attrName, IDfId policyId, java.lang.String state) throws DfException
DfException
- if a server error occursIDfList getTypeAttrAssistanceWithValues(java.lang.String attrName, IDfId policyId, java.lang.String state, IDfList depAttrNameList, IDfList depAttrValueListList) throws DfException
getTypeAttrAssistance(String attrName, IDfId
policyId, String state).getList(0)
will return a list of possible actual values;
getTypeAttrAssistance(String attrName, IDfId policyId, String state).getList(1)
will
return a list of value-mapped possible values. THIS METHOD IS DEPRECATED -- use getTypeValidator and
then call getValueAssistance on IDfValidator with the appropriate parameters to get
IDfValueAssistance.DfException
- if a server error occursjava.lang.String getTypeWidgetType(int environment, java.lang.String attrName, IDfId policyId, java.lang.String state) throws DfException
DfException
- if a server error occursCopyright 1994-2023 OpenText Corporation. All rights reserved.