public class Relation extends BaseFormsObject
In some cases, using methods on this class may result in a
JdapiIllegalStateException being thrown. When this happens, you are using
an object that refers to a Forms object that has been deleted - your
reference is no longer valid. You can check if an instance of this
class is valid by using the isValidFormsObject()
method.
If you code correctly, this should not happen. It will tend to happen
if you keep references (for extended periods) to Forms objects rather
than look them up dynamically. Of course you will only have this
problem if you destroy Forms objects.
BaseAPI
m_clientInfo, m_pd2fob
PROPERTY_DEFAULT_VALUE, PROPERTY_INHERITED_VALUE, PROPERTY_OVERRIDDEN_DEFAULT_VALUE, PROPERTY_OVERRIDDEN_INHERITED_VALUE, PROPERTY_STATE_UNKNOWN
Modifier | Constructor and Description |
---|---|
|
Relation(Block parent,
java.lang.String name)
Constructor used to create Relation objects in the context of
a Block parent object.
|
|
Relation(Block parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Relation objects in the context of a
Block parent object.
|
|
Relation(Block parent,
java.lang.String name,
Relation base)
Constructor used to create Relation objects in the context of a
Block parent object.
|
protected |
Relation(long pd2frel)
Protected constructor, used internally to create Relation
objects.
|
Modifier and Type | Method and Description |
---|---|
Relation |
clone(Block parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static Relation |
find(Block parent,
java.lang.String name)
Find an instance of Relation that is a child of a Block.
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID).
|
int |
getDeleteRecord()
Get number property DeleteRecord (DELETE_RECORD_PTID).
|
java.lang.String |
getDetailBlock()
Get text property DetailBlock (DETAIL_BLOCK_PTID).
|
java.lang.String |
getDetailItemref()
Get text property DetailItemref (DETAIL_ITEMREF_PTID).
|
java.lang.String |
getJoinCondition()
Get text property JoinCondition (JOIN_CONDITION_PTID).
|
JdapiObject |
getModule()
Get object property Module (MODULE_PTID).
|
java.lang.String |
getName()
Get text property Name (NAME_PTID).
|
JdapiObject |
getOwner()
Get object property Owner (OWNER_PTID).
|
int |
getPersistentClientInfoLength()
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
int |
getRelationType()
Get number property RelationType (RELATION_TYPE_PTID).
|
JdapiObject |
getSource()
Get object property Source (SOURCE_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
boolean |
isAutoQuery()
Get boolean property AutoQuery (AUTO_QUERY_PTID).
|
boolean |
isDeferred()
Get boolean property Deferred (DEFERRED_PTID).
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isPreventMasterlessOperations()
Get boolean property PreventMasterlessOperations (PREVENT_MASTERLESS_OPERATIONS_PTID).
|
boolean |
isSubclassSubObject()
Get boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
|
void |
setAutoQuery(boolean value)
Sets boolean property AutoQuery (AUTO_QUERY_PTID).
|
void |
setComment(java.lang.String value)
Sets text property Comment (COMMENT_PTID).
|
void |
setDeferred(boolean value)
Sets boolean property Deferred (DEFERRED_PTID).
|
void |
setDeleteRecord(int value)
Sets number property DeleteRecord (DELETE_RECORD_PTID).
|
void |
setDetailBlock(java.lang.String value)
Sets text property DetailBlock (DETAIL_BLOCK_PTID).
|
void |
setDetailItemref(java.lang.String value)
Sets text property DetailItemref (DETAIL_ITEMREF_PTID).
|
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
setJoinCondition(java.lang.String value)
Sets text property JoinCondition (JOIN_CONDITION_PTID).
|
void |
setName(java.lang.String value)
Sets text property Name (NAME_PTID).
|
void |
setPersistentClientInfoLength(int value)
Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
void |
setPreventMasterlessOperations(boolean value)
Sets boolean property PreventMasterlessOperations (PREVENT_MASTERLESS_OPERATIONS_PTID).
|
void |
setRelationType(int value)
Sets number property RelationType (RELATION_TYPE_PTID).
|
void |
setSubclassSubObject(boolean value)
Sets boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
|
changeOwner, clearObjectPointer, clone, createSubclassedChild, destroy, equals, getBooleanProperty, getChildObjectProperty, getClassName, getClientInfo, getIntegerProperty, getIntegerPropertyString, getJdapiMetaObject, getMetaProperties, getObjectPointer, getObjectProperty, getObjProp, getOwnedObjects, getPersistentClientInfoBlob, getPersistentClientInfoObject, getPropertyState, getPropertyValueName, getQualifiedName, getStringIDProperty, getStringProperty, getSubclassParent, hasDefaultedProperty, hasInheritedProperty, hasOverriddenProperty, hasProperty, inheritProperty, isSubclassed, isValidFormsObject, move, queryType, reattach, setBooleanProperty, setClientInfo, setIntegerProperty, setObjectProperty, setObjProp, setPersistentClientInfo, setPersistentClientInfo, setStringProperty, setSubclassParent, toString, unsetSubclassParent
public Relation(Block parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Relation(Block parent, java.lang.String name, Relation base)
parent
- Parent objectname
- Name of the new objectbase
- Relation object to derive frompublic Relation(Block parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive fromprotected Relation(long pd2frel)
Do NOT use this constructor, even within the Jdapi package. If you have a pointer and need to instantiate it's Java representation, get the object via the context cache, e.g.
myBaseObject = Jdapi.getObject(myPointer);
pd2frel
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public Relation clone(Block parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static Relation find(Block parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getDetailBlock()
public void setDetailBlock(java.lang.String value)
value
- Value to set property topublic java.lang.String getDetailItemref()
public void setDetailItemref(java.lang.String value)
value
- Value to set property topublic java.lang.String getJoinCondition()
public void setJoinCondition(java.lang.String value)
value
- Value to set property topublic java.lang.String getName()
getName
in interface JdapiObject
getName
in class BaseFormsObject
public void setName(java.lang.String value)
value
- Value to set property topublic int getDeleteRecord()
public void setDeleteRecord(int value)
value
- Value to set property topublic int getPersistentClientInfoLength()
public void setPersistentClientInfoLength(int value)
value
- Value to set property topublic int getRelationType()
public void setRelationType(int value)
value
- Value to set property topublic boolean isAutoQuery()
public void setAutoQuery(boolean value)
value
- Value to set property topublic boolean isDeferred()
public void setDeferred(boolean value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isPreventMasterlessOperations()
public void setPreventMasterlessOperations(boolean value)
value
- Value to set property topublic boolean isSubclassSubObject()
public void setSubclassSubObject(boolean value)
value
- Value to set property topublic JdapiObject getModule()
getModule
in interface JdapiObject
getModule
in class BaseFormsObject
public JdapiObject getOwner()
getOwner
in interface JdapiObject
getOwner
in class BaseFormsObject
public JdapiObject getSource()