|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.forms.jdapi.BaseFormsObject | +--oracle.forms.jdapi.Block
Object to represent a Forms Block object. This is an encapsulation of the Forms C API d2fblk.
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
Field Summary | |
protected java.lang.Object |
m_clientInfo
Client info object held against this Forms object. |
protected long |
m_pd2fob
This is the d2fob pointer in the C ifjapi60 for the object that is derived from this class. |
Fields inherited from interface oracle.forms.jdapi.JdapiObject |
PROPERTY_DEFAULT_VALUE, PROPERTY_INHERITED_VALUE, PROPERTY_OVERRIDDEN_DEFAULT_VALUE, PROPERTY_OVERRIDDEN_INHERITED_VALUE, PROPERTY_STATE_UNKNOWN |
Constructor Summary | |
|
Block(FormModule parent,
java.lang.String name)
Constructor used to create Block objects in the context of a FormModule parent object. |
|
Block(FormModule parent,
java.lang.String name,
Block base)
Constructor used to create Block objects in the context of a FormModule parent object. |
|
Block(FormModule parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Block objects in the context of a FormModule parent object. |
protected |
Block(long pd2fblk)
Protected constructor, used internally to create Block objects. |
|
Block(ObjectGroup parent,
java.lang.String name)
Constructor used to create Block objects in the context of a ObjectGroup parent object. |
|
Block(ObjectGroup parent,
java.lang.String name,
Block base)
Constructor used to create Block objects in the context of a ObjectGroup parent object. |
|
Block(ObjectGroup parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Block objects in the context of a ObjectGroup parent object. |
|
Block(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name)
Constructor used to create Block objects in the context of an ObjectLibraryTab parent object. |
|
Block(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
Block base)
Constructor used to create Block objects in the context of an ObjectLibraryTab parent object. |
|
Block(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
PropertyClass base)
Constructor used to create Block objects in the context of an ObjectLibraryTab parent object. |
Method Summary | |
void |
changeOwner(JdapiObject newOwner)
Assigns a new owner to the referred object. |
protected void |
clearObjectPointer()
Used internally to flag this object as an invalid object. |
Block |
clone(FormModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent' |
JdapiObject |
clone(JdapiObject parent,
java.lang.String newName)
Creates a clone of the specified object, creating a new object with the given name and owner. |
Block |
clone(ObjectGroup parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent' |
Block |
clone(ObjectLibraryTab parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent' |
JdapiObject |
createSubclassedChild(JdapiObject childOwner,
java.lang.String childName)
Subclass the referred object. |
void |
destroy()
Destroys the object - this removes the object from it's context. |
boolean |
equals(JdapiObject obj)
Compares two objects and determines if they are equal. |
static Block |
find(FormModule parent,
java.lang.String name)
Find an instance of Block that is a child of a FormModule. |
static Block |
find(ObjectGroup parent,
java.lang.String name)
Find an instance of Block that is a child of a ObjectGroup. |
static Block |
find(ObjectLibraryTab parent,
java.lang.String name)
Find an instance of Block that is a child of a ObjectLibraryTab. |
java.lang.String |
getAlias()
Get text property Alias (ALIAS_PTID). |
java.lang.String |
getBackColor()
Get text property BackColor (BACK_COLOR_PTID). |
boolean |
getBooleanProperty(int propertyTypeId)
Retrieves a boolean property from the referred object. |
JdapiIterator |
getChildObjectProperty(int propertyTypeId)
Retrieves child objects for a given property value. |
java.lang.String |
getClassName()
Gets the class name of the object. |
java.lang.Object |
getClientInfo()
Returns the client info object associated with this Object. |
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID). |
JdapiIterator |
getDeleteDataSourceArguments()
Accessor for child DeleteDataSourceArgument objects (DELETE_DATA_SOURCE_ARGUMENT_PTID). |
JdapiIterator |
getDeleteDataSourceColumns()
Accessor for child DeleteDataSourceColumn objects (DELETE_DATA_SOURCE_COLUMN_PTID). |
java.lang.String |
getDeleteProcedureName()
Get text property DeleteProcedureName (DELETE_PROCEDURE_NAME_PTID). |
int |
getDMLArraySize()
Get number property DMLArraySize (DML_ARRAY_SIZE_PTID). |
java.lang.String |
getDMLDataName()
Get text property DMLDataName (DML_DATA_NAME_PTID). |
int |
getDMLDataType()
Get number property DMLDataType (DML_DATA_TYPE_PTID). |
java.lang.String |
getFillPattern()
Get text property FillPattern (FILL_PATTERN_PTID). |
java.lang.String |
getFontName()
Get text property FontName (FONT_NAME_PTID). |
int |
getFontSize()
Get number property FontSize (FONT_SIZE_PTID). |
int |
getFontSpacing()
Get number property FontSpacing (FONT_SPACING_PTID). |
int |
getFontStyle()
Get number property FontStyle (FONT_STYLE_PTID). |
int |
getFontWeight()
Get number property FontWeight (FONT_WEIGHT_PTID). |
java.lang.String |
getForegroundColor()
Get text property ForegroundColor (FOREGROUND_COLOR_PTID). |
JdapiIterator |
getInsertDataSourceArguments()
Accessor for child InsertDataSourceArgument objects (INSERT_DATA_SOURCE_ARGUMENT_PTID). |
JdapiIterator |
getInsertDataSourceColumns()
Accessor for child InsertDataSourceColumn objects (INSERT_DATA_SOURCE_COLUMN_PTID). |
java.lang.String |
getInsertProcedureName()
Get text property InsertProcedureName (INSERT_PROCEDURE_NAME_PTID). |
int |
getIntegerProperty(int propertyTypeId)
Retrieves an integer property from the referred object. |
java.lang.String |
getIntegerPropertyString(int propertyTypeId)
Gets a numeric ( long ) property value's text
representation. |
JdapiIterator |
getItems()
Accessor for child Item objects (ITEM_PTID). |
JdapiMetaObject |
getJdapiMetaObject()
Gets the metadata object for the specified object. |
int |
getKeyMode()
Get number property KeyMode (KEY_MODE_PTID). |
int |
getLanguageDirection()
Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID). |
JdapiIterator |
getLockDataSourceArguments()
Accessor for child LockDataSourceArgument objects (LOCK_DATA_SOURCE_ARGUMENT_PTID). |
JdapiIterator |
getLockDataSourceColumns()
Accessor for child LockDataSourceColumn objects (LOCK_DATA_SOURCE_COLUMN_PTID). |
int |
getLockMode()
Get number property LockMode (LOCK_MODE_PTID). |
java.lang.String |
getLockProcedureName()
Get text property LockProcedureName (LOCK_PROCEDURE_NAME_PTID). |
int |
getMaximumQueryTime()
Get number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID). |
int |
getMaximumRecordsFetched()
Get number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID). |
JdapiIterator |
getMetaProperties()
Return an iterator over the meta properties in object referred. |
JdapiObject |
getModule()
Get object property Module (MODULE_PTID). |
java.lang.String |
getName()
Get text property Name (NAME_PTID). |
int |
getNavigationStyle()
Get number property NavigationStyle (NAVIGATION_STYLE_PTID). |
java.lang.String |
getNextNavigationBlockName()
Get text property NextNavigationBlockName (NEXT_NAVIGATION_BLOCK_NAME_PTID). |
Block |
getNextNavigationBlockObject()
Get object property NextNavigationBlockObject (NEXT_NAVIGATION_BLOCK_OBJECT_PTID). |
protected long |
getObjectPointer()
Gets the Forms API pointer for this object. |
JdapiObject |
getObjectProperty(int propertyTypeId)
Retrieves a JdapiObject property from the referred object. |
protected long |
getObjProp(int propertyTypeId)
Internal method used to get an object property value. |
java.lang.String |
getOptionHint()
Get text property OptionHint (OPTION_HINT_PTID). |
java.lang.String |
getOrderByClause()
Get text property OrderByClause (ORDER_BY_CLAUSE_PTID). |
JdapiIterator |
getOwnedObjects()
Get the object instances owned by this particular object. |
JdapiObject |
getOwner()
Get object property Owner (OWNER_PTID). |
java.lang.String |
getParentFilename()
Get text property ParentFilename (PARENT_FILENAME_PTID). |
java.lang.String |
getParentFilepath()
Get text property ParentFilepath (PARENT_FILEPATH_PTID). |
java.lang.String |
getParentModule()
Get text property ParentModule (PARENT_MODULE_PTID). |
int |
getParentModuleType()
Get number property ParentModuleType (PARENT_MODULETYPE_PTID). |
java.lang.String |
getParentName()
Get text property ParentName (PARENT_NAME_PTID). |
int |
getParentType()
Get number property ParentType (PARENT_TYPE_PTID). |
Blob |
getPersistentClientInfoBlob()
Returns the persistent client info Blob associated with this object. |
int |
getPersistentClientInfoLength()
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID). |
java.lang.Object |
getPersistentClientInfoObject()
Returns the persistent client info Java object associated with this object. |
java.lang.String |
getPreviousNavigationBlockName()
Get text property PreviousNavigationBlockName (PREVIOUS_NAVIGATION_BLOCK_NAME_PTID). |
Block |
getPreviousNavigationBlockObject()
Get object property PreviousNavigationBlockObject (PREVIOUS_NAVIGATION_BLOCK_OBJECT_PTID). |
int |
getPropertyState(int propertyTypeId)
Returns the current state of the specified property. |
java.lang.String |
getPropertyValueName(int propertyTypeId,
int val)
Gets the string representation of a given property's value. |
java.lang.String |
getQualifiedName(boolean includeModule)
Gets a fully qualified name for the object in the format of: MODULE.OBJECT.CHILD.CHILD... |
JdapiIterator |
getQueryDataSourceArguments()
Accessor for child QueryDataSourceArgument objects (QUERY_DATA_SOURCE_ARGUMENT_PTID). |
JdapiIterator |
getQueryDataSourceColumns()
Accessor for child QueryDataSourceColumn objects (QUERY_DATA_SOURCE_COLUMN_PTID). |
java.lang.String |
getQueryDataSourceName()
Get text property QueryDataSourceName (QUERY_DATA_SOURCE_NAME_PTID). |
int |
getQueryDataSourceType()
Get number property QueryDataSourceType (QUERY_DATA_SOURCE_TYPE_PTID). |
int |
getRecordOrientation()
Get number property RecordOrientation (RECORD_ORIENTATION_PTID). |
int |
getRecordsBufferedCount()
Get number property RecordsBufferedCount (RECORDS_BUFFERED_COUNT_PTID). |
int |
getRecordsDisplayCount()
Get number property RecordsDisplayCount (RECORDS_DISPLAY_COUNT_PTID). |
int |
getRecordsFetchedCount()
Get number property RecordsFetchedCount (RECORDS_FETCHED_COUNT_PTID). |
java.lang.String |
getRecordVisualAttributeGroupName()
Get text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID). |
VisualAttribute |
getRecordVisualAttributeGroupObject()
Get object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID). |
JdapiIterator |
getRelations()
Accessor for child Relation objects (RELATION_PTID). |
java.lang.String |
getScrollbarCanvasName()
Get text property ScrollbarCanvasName (SCROLLBAR_CANVAS_NAME_PTID). |
Canvas |
getScrollbarCanvasObject()
Get object property ScrollbarCanvasObject (SCROLLBAR_CANVAS_OBJECT_PTID). |
int |
getScrollbarLength()
Get number property ScrollbarLength (SCROLLBAR_LENGTH_PTID). |
int |
getScrollbarOrientation()
Get number property ScrollbarOrientation (SCROLLBAR_ORIENTATION_PTID). |
java.lang.String |
getScrollbarTabPageName()
Get text property ScrollbarTabPageName (SCROLLBAR_TABPAGE_NAME_PTID). |
TabPage |
getScrollbarTabPageObject()
Get object property ScrollbarTabPageObject (SCROLLBAR_TABPAGE_OBJECT_PTID). |
int |
getScrollbarWidth()
Get number property ScrollbarWidth (SCROLLBAR_WIDTH_PTID). |
int |
getScrollbarXPosition()
Get number property ScrollbarXPosition (SCROLLBAR_X_POSITION_PTID). |
int |
getScrollbarYPosition()
Get number property ScrollbarYPosition (SCROLLBAR_Y_POSITION_PTID). |
JdapiObject |
getSource()
Get object property Source (SOURCE_PTID). |
int |
getStringIDProperty(int propertyTypeId)
Retrieves a special String ID (integer) property from the referred object. |
java.lang.String |
getStringProperty(int propertyTypeId)
Retrieves a string property from the referred object. |
JdapiObject |
getSubclassParent()
Get Source (SOURCE_PTID) object property, i.e. |
JdapiIterator |
getTriggers()
Accessor for child Trigger objects (TRIGGER_PTID). |
int |
getTypeId()
Gets the HtmlForms object type ID. |
JdapiIterator |
getUpdateDataSourceArguments()
Accessor for child UpdateDataSourceArgument objects (UPDATE_DATA_SOURCE_ARGUMENT_PTID). |
JdapiIterator |
getUpdateDataSourceColumns()
Accessor for child UpdateDataSourceColumn objects (UPDATE_DATA_SOURCE_COLUMN_PTID). |
java.lang.String |
getUpdateProcedureName()
Get text property UpdateProcedureName (UPDATE_PROCEDURE_NAME_PTID). |
java.lang.String |
getVisualAttributeName()
Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID). |
VisualAttribute |
getVisualAttributeObject()
Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID). |
java.lang.String |
getWhereClause()
Get text property WhereClause (WHERE_CLAUSE_PTID). |
boolean |
hasDefaultedProperty(int propertyTypeId)
Checks if a property is set to it's default value. |
boolean |
hasInheritedProperty(int propertyTypeId)
Checks if a property is inherited. |
boolean |
hasOverriddenProperty(int propertyTypeId)
Determine whether the object referred has a property of the given type id with an overridden value. |
boolean |
hasProperty(int propertyTypeId)
Checks if the object has a given property. |
void |
inheritProperty(int propertyTypeId)
Resets a property to it's default value (confusing name eh?). |
boolean |
isDatabaseBlock()
Get boolean property DatabaseBlock (DATABASE_BLOCK_PTID). |
boolean |
isDeleteAllowed()
Get boolean property DeleteAllowed (DELETE_ALLOWED_PTID). |
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID). |
boolean |
isDMLReturnValue()
Get boolean property DMLReturnValue (DML_RETURN_VALUE_PTID). |
boolean |
isEnforcedColumnSecurity()
Get boolean property EnforcedColumnSecurity (ENFORCED_COLUMN_SECURITY_PTID). |
boolean |
isEnforcedPrimaryKey()
Get boolean property EnforcedPrimaryKey (ENFORCED_PRIMARY_KEY_PTID). |
boolean |
isIncludeRefitem()
Get boolean property IncludeRefitem (INCLUDE_REFITEM_PTID). |
boolean |
isInsertAllowed()
Get boolean property InsertAllowed (INSERT_ALLOWED_PTID). |
boolean |
isPrecompSummary()
Get boolean property PrecompSummary (PRECOMP_SUMMARY_PTID). |
boolean |
isQueryAllowed()
Get boolean property QueryAllowed (QUERY_ALLOWED_PTID). |
boolean |
isQueryAllRecords()
Get boolean property QueryAllRecords (QUERY_ALL_RECORDS_PTID). |
boolean |
isReverseDirection()
Get boolean property ReverseDirection (REVERSE_DIRECTION_PTID). |
boolean |
isShowScrollbar()
Get boolean property ShowScrollbar (SHOW_SCROLLBAR_PTID). |
boolean |
isSingleRecord()
Get boolean property SingleRecord (SINGLE_RECORD_PTID). |
boolean |
isSubclassed()
Checks if the object is subclassed from another object. |
boolean |
isSubclassObjectGroup()
Get boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID). |
boolean |
isUpdateAllowed()
Get boolean property UpdateAllowed (UPDATE_ALLOWED_PTID). |
boolean |
isUpdateChangedColumns()
Get boolean property UpdateChangedColumns (UPDATE_CHANGED_COLUMNS_PTID). |
boolean |
isValidFormsObject()
Determines whether this Java instance references a valid Forms object. |
void |
move(JdapiObject next)
Reorders an object with respect to its siblings in the collection it belongs to. |
int |
queryType()
Returns the FormAPI object type ID (x_OTID in JdapiTypes ). |
void |
reattach()
Reattaches subclassed object. |
void |
setAlias(java.lang.String value)
Sets text property Alias (ALIAS_PTID). |
void |
setBackColor(java.lang.String value)
Sets text property BackColor (BACK_COLOR_PTID). |
void |
setBooleanProperty(int propertyTypeId,
boolean propertyValue)
Sets the value of the specified boolean property belonging to the referred object. |
void |
setClientInfo(java.lang.Object clientInfo)
Sets the client information. |
void |
setComment(java.lang.String value)
Sets text property Comment (COMMENT_PTID). |
void |
setDatabaseBlock(boolean value)
Sets boolean property DatabaseBlock (DATABASE_BLOCK_PTID). |
void |
setDeleteAllowed(boolean value)
Sets boolean property DeleteAllowed (DELETE_ALLOWED_PTID). |
void |
setDeleteProcedureName(java.lang.String value)
Sets text property DeleteProcedureName (DELETE_PROCEDURE_NAME_PTID). |
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID). |
void |
setDMLArraySize(int value)
Sets number property DMLArraySize (DML_ARRAY_SIZE_PTID). |
void |
setDMLDataName(java.lang.String value)
Sets text property DMLDataName (DML_DATA_NAME_PTID). |
void |
setDMLDataType(int value)
Sets number property DMLDataType (DML_DATA_TYPE_PTID). |
void |
setDMLReturnValue(boolean value)
Sets boolean property DMLReturnValue (DML_RETURN_VALUE_PTID). |
void |
setEnforcedColumnSecurity(boolean value)
Sets boolean property EnforcedColumnSecurity (ENFORCED_COLUMN_SECURITY_PTID). |
void |
setEnforcedPrimaryKey(boolean value)
Sets boolean property EnforcedPrimaryKey (ENFORCED_PRIMARY_KEY_PTID). |
void |
setFillPattern(java.lang.String value)
Sets text property FillPattern (FILL_PATTERN_PTID). |
void |
setFontName(java.lang.String value)
Sets text property FontName (FONT_NAME_PTID). |
void |
setFontSize(int value)
Sets number property FontSize (FONT_SIZE_PTID). |
void |
setFontSpacing(int value)
Sets number property FontSpacing (FONT_SPACING_PTID). |
void |
setFontStyle(int value)
Sets number property FontStyle (FONT_STYLE_PTID). |
void |
setFontWeight(int value)
Sets number property FontWeight (FONT_WEIGHT_PTID). |
void |
setForegroundColor(java.lang.String value)
Sets text property ForegroundColor (FOREGROUND_COLOR_PTID). |
void |
setIncludeRefitem(boolean value)
Sets boolean property IncludeRefitem (INCLUDE_REFITEM_PTID). |
void |
setInsertAllowed(boolean value)
Sets boolean property InsertAllowed (INSERT_ALLOWED_PTID). |
void |
setInsertProcedureName(java.lang.String value)
Sets text property InsertProcedureName (INSERT_PROCEDURE_NAME_PTID). |
void |
setIntegerProperty(int propertyTypeId,
int propertyValue)
Sets the value of the specified object integer property. |
void |
setKeyMode(int value)
Sets number property KeyMode (KEY_MODE_PTID). |
void |
setLanguageDirection(int value)
Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID). |
void |
setLockMode(int value)
Sets number property LockMode (LOCK_MODE_PTID). |
void |
setLockProcedureName(java.lang.String value)
Sets text property LockProcedureName (LOCK_PROCEDURE_NAME_PTID). |
void |
setMaximumQueryTime(int value)
Sets number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID). |
void |
setMaximumRecordsFetched(int value)
Sets number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID). |
void |
setName(java.lang.String value)
Sets text property Name (NAME_PTID). |
void |
setNavigationStyle(int value)
Sets number property NavigationStyle (NAVIGATION_STYLE_PTID). |
void |
setNextNavigationBlockName(java.lang.String value)
Sets text property NextNavigationBlockName (NEXT_NAVIGATION_BLOCK_NAME_PTID). |
void |
setNextNavigationBlockObject(Block value)
Set object property NextNavigationBlockObject (NEXT_NAVIGATION_BLOCK_OBJECT_PTID). |
void |
setObjectProperty(int propertyTypeId,
JdapiObject propertyValue)
Sets the value of the specified object object property value. |
protected void |
setObjProp(int propertyTypeId,
long val)
Internal method used to set an object property. |
void |
setOptionHint(java.lang.String value)
Sets text property OptionHint (OPTION_HINT_PTID). |
void |
setOrderByClause(java.lang.String value)
Sets text property OrderByClause (ORDER_BY_CLAUSE_PTID). |
void |
setParentFilename(java.lang.String value)
Sets text property ParentFilename (PARENT_FILENAME_PTID). |
void |
setParentFilepath(java.lang.String value)
Sets text property ParentFilepath (PARENT_FILEPATH_PTID). |
void |
setParentModule(java.lang.String value)
Sets text property ParentModule (PARENT_MODULE_PTID). |
void |
setParentModuleType(int value)
Sets number property ParentModuleType (PARENT_MODULETYPE_PTID). |
void |
setParentName(java.lang.String value)
Sets text property ParentName (PARENT_NAME_PTID). |
void |
setParentType(int value)
Sets number property ParentType (PARENT_TYPE_PTID). |
void |
setPersistentClientInfo(Blob val)
Sets persistent client info for this object. |
void |
setPersistentClientInfo(java.io.Serializable obj)
Serializes any Java object which supports the Serializable interface to this object's Persistent Client Info. |
void |
setPersistentClientInfoLength(int value)
Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID). |
void |
setPrecompSummary(boolean value)
Sets boolean property PrecompSummary (PRECOMP_SUMMARY_PTID). |
void |
setPreviousNavigationBlockName(java.lang.String value)
Sets text property PreviousNavigationBlockName (PREVIOUS_NAVIGATION_BLOCK_NAME_PTID). |
void |
setPreviousNavigationBlockObject(Block value)
Set object property PreviousNavigationBlockObject (PREVIOUS_NAVIGATION_BLOCK_OBJECT_PTID). |
void |
setQueryAllowed(boolean value)
Sets boolean property QueryAllowed (QUERY_ALLOWED_PTID). |
void |
setQueryAllRecords(boolean value)
Sets boolean property QueryAllRecords (QUERY_ALL_RECORDS_PTID). |
void |
setQueryDataSourceName(java.lang.String value)
Sets text property QueryDataSourceName (QUERY_DATA_SOURCE_NAME_PTID). |
void |
setQueryDataSourceType(int value)
Sets number property QueryDataSourceType (QUERY_DATA_SOURCE_TYPE_PTID). |
void |
setRecordOrientation(int value)
Sets number property RecordOrientation (RECORD_ORIENTATION_PTID). |
void |
setRecordsBufferedCount(int value)
Sets number property RecordsBufferedCount (RECORDS_BUFFERED_COUNT_PTID). |
void |
setRecordsDisplayCount(int value)
Sets number property RecordsDisplayCount (RECORDS_DISPLAY_COUNT_PTID). |
void |
setRecordsFetchedCount(int value)
Sets number property RecordsFetchedCount (RECORDS_FETCHED_COUNT_PTID). |
void |
setRecordVisualAttributeGroupName(java.lang.String value)
Sets text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID). |
void |
setRecordVisualAttributeGroupObject(VisualAttribute value)
Set object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID). |
void |
setReverseDirection(boolean value)
Sets boolean property ReverseDirection (REVERSE_DIRECTION_PTID). |
void |
setScrollbarCanvasName(java.lang.String value)
Sets text property ScrollbarCanvasName (SCROLLBAR_CANVAS_NAME_PTID). |
void |
setScrollbarCanvasObject(Canvas value)
Set object property ScrollbarCanvasObject (SCROLLBAR_CANVAS_OBJECT_PTID). |
void |
setScrollbarLength(int value)
Sets number property ScrollbarLength (SCROLLBAR_LENGTH_PTID). |
void |
setScrollbarOrientation(int value)
Sets number property ScrollbarOrientation (SCROLLBAR_ORIENTATION_PTID). |
void |
setScrollbarTabPageName(java.lang.String value)
Sets text property ScrollbarTabPageName (SCROLLBAR_TABPAGE_NAME_PTID). |
void |
setScrollbarTabPageObject(TabPage value)
Set object property ScrollbarTabPageObject (SCROLLBAR_TABPAGE_OBJECT_PTID). |
void |
setScrollbarWidth(int value)
Sets number property ScrollbarWidth (SCROLLBAR_WIDTH_PTID). |
void |
setScrollbarXPosition(int value)
Sets number property ScrollbarXPosition (SCROLLBAR_X_POSITION_PTID). |
void |
setScrollbarYPosition(int value)
Sets number property ScrollbarYPosition (SCROLLBAR_Y_POSITION_PTID). |
void |
setShowScrollbar(boolean value)
Sets boolean property ShowScrollbar (SHOW_SCROLLBAR_PTID). |
void |
setSingleRecord(boolean value)
Sets boolean property SingleRecord (SINGLE_RECORD_PTID). |
void |
setStringProperty(int propertyTypeId,
java.lang.String propertyValue)
Sets the value of the specified string property for the object. |
void |
setSubclassObjectGroup(boolean value)
Sets boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID). |
void |
setSubclassParent(JdapiObject parent)
Change the subclassing parent of the object referred. |
void |
setUpdateAllowed(boolean value)
Sets boolean property UpdateAllowed (UPDATE_ALLOWED_PTID). |
void |
setUpdateChangedColumns(boolean value)
Sets boolean property UpdateChangedColumns (UPDATE_CHANGED_COLUMNS_PTID). |
void |
setUpdateProcedureName(java.lang.String value)
Sets text property UpdateProcedureName (UPDATE_PROCEDURE_NAME_PTID). |
void |
setVisualAttributeName(java.lang.String value)
Sets text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID). |
void |
setVisualAttributeObject(VisualAttribute value)
Set object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID). |
void |
setWhereClause(java.lang.String value)
Sets text property WhereClause (WHERE_CLAUSE_PTID). |
java.lang.String |
toString()
Converts and returns the object properties to string format. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected transient long m_pd2fob
protected transient java.lang.Object m_clientInfo
Constructor Detail |
public Block(FormModule parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Block(FormModule parent, java.lang.String name, Block base)
parent
- Parent objectname
- Name of the new objectbase
- Block object to derive frompublic Block(FormModule parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Block(ObjectGroup parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Block(ObjectGroup parent, java.lang.String name, Block base)
parent
- Parent objectname
- Name of the new objectbase
- Block object to derive frompublic Block(ObjectGroup parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Block(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectpublic Block(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, Block base)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- Block object to derive frompublic Block(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, PropertyClass base)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- PropertyClass object to derive fromprotected Block(long pd2fblk)
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);
pd2fctx
- C pointer to Forms contextpd2fblk
- C pointer to Forms objectMethod Detail |
public int getTypeId()
getTypeId
in class oracle.forms.jdapi.BaseFormsObject
public Block clone(FormModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Block clone(ObjectGroup parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Block clone(ObjectLibraryTab parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static Block find(FormModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Block find(ObjectGroup parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Block find(ObjectLibraryTab parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic java.lang.String getAlias()
public void setAlias(java.lang.String value)
value
- Value to set property topublic java.lang.String getBackColor()
public void setBackColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getDeleteProcedureName()
public void setDeleteProcedureName(java.lang.String value)
value
- Value to set property topublic java.lang.String getDMLDataName()
public void setDMLDataName(java.lang.String value)
value
- Value to set property topublic java.lang.String getFillPattern()
public void setFillPattern(java.lang.String value)
value
- Value to set property topublic java.lang.String getFontName()
public void setFontName(java.lang.String value)
value
- Value to set property topublic java.lang.String getForegroundColor()
public void setForegroundColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getInsertProcedureName()
public void setInsertProcedureName(java.lang.String value)
value
- Value to set property topublic java.lang.String getLockProcedureName()
public void setLockProcedureName(java.lang.String value)
value
- Value to set property topublic java.lang.String getName()
getName
in class oracle.forms.jdapi.BaseFormsObject
public void setName(java.lang.String value)
value
- Value to set property topublic java.lang.String getNextNavigationBlockName()
public void setNextNavigationBlockName(java.lang.String value)
value
- Value to set property topublic java.lang.String getOptionHint()
public void setOptionHint(java.lang.String value)
value
- Value to set property topublic java.lang.String getOrderByClause()
public void setOrderByClause(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentFilename()
public void setParentFilename(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentFilepath()
public void setParentFilepath(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentModule()
public void setParentModule(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentName()
public void setParentName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPreviousNavigationBlockName()
public void setPreviousNavigationBlockName(java.lang.String value)
value
- Value to set property topublic java.lang.String getQueryDataSourceName()
public void setQueryDataSourceName(java.lang.String value)
value
- Value to set property topublic java.lang.String getRecordVisualAttributeGroupName()
public void setRecordVisualAttributeGroupName(java.lang.String value)
value
- Value to set property topublic java.lang.String getScrollbarCanvasName()
public void setScrollbarCanvasName(java.lang.String value)
value
- Value to set property topublic java.lang.String getScrollbarTabPageName()
public void setScrollbarTabPageName(java.lang.String value)
value
- Value to set property topublic java.lang.String getUpdateProcedureName()
public void setUpdateProcedureName(java.lang.String value)
value
- Value to set property topublic java.lang.String getVisualAttributeName()
public void setVisualAttributeName(java.lang.String value)
value
- Value to set property topublic java.lang.String getWhereClause()
public void setWhereClause(java.lang.String value)
value
- Value to set property topublic int getDMLArraySize()
public void setDMLArraySize(int value)
value
- Value to set property topublic int getDMLDataType()
public void setDMLDataType(int value)
value
- Value to set property topublic int getFontSize()
public void setFontSize(int value)
value
- Value to set property topublic int getFontSpacing()
public void setFontSpacing(int value)
value
- Value to set property topublic int getFontStyle()
public void setFontStyle(int value)
value
- Value to set property topublic int getFontWeight()
public void setFontWeight(int value)
value
- Value to set property topublic int getKeyMode()
public void setKeyMode(int value)
value
- Value to set property topublic int getLanguageDirection()
public void setLanguageDirection(int value)
value
- Value to set property topublic int getLockMode()
public void setLockMode(int value)
value
- Value to set property topublic int getMaximumQueryTime()
public void setMaximumQueryTime(int value)
value
- Value to set property topublic int getMaximumRecordsFetched()
public void setMaximumRecordsFetched(int value)
value
- Value to set property topublic int getNavigationStyle()
public void setNavigationStyle(int value)
value
- Value to set property topublic int getParentModuleType()
public void setParentModuleType(int value)
value
- Value to set property topublic int getParentType()
public void setParentType(int value)
value
- Value to set property topublic int getPersistentClientInfoLength()
public void setPersistentClientInfoLength(int value)
value
- Value to set property topublic int getQueryDataSourceType()
public void setQueryDataSourceType(int value)
value
- Value to set property topublic int getRecordOrientation()
public void setRecordOrientation(int value)
value
- Value to set property topublic int getRecordsBufferedCount()
public void setRecordsBufferedCount(int value)
value
- Value to set property topublic int getRecordsDisplayCount()
public void setRecordsDisplayCount(int value)
value
- Value to set property topublic int getRecordsFetchedCount()
public void setRecordsFetchedCount(int value)
value
- Value to set property topublic int getScrollbarLength()
public void setScrollbarLength(int value)
value
- Value to set property topublic int getScrollbarOrientation()
public void setScrollbarOrientation(int value)
value
- Value to set property topublic int getScrollbarWidth()
public void setScrollbarWidth(int value)
value
- Value to set property topublic int getScrollbarXPosition()
public void setScrollbarXPosition(int value)
value
- Value to set property topublic int getScrollbarYPosition()
public void setScrollbarYPosition(int value)
value
- Value to set property topublic boolean isDatabaseBlock()
public void setDatabaseBlock(boolean value)
value
- Value to set property topublic boolean isDeleteAllowed()
public void setDeleteAllowed(boolean value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isDMLReturnValue()
public void setDMLReturnValue(boolean value)
value
- Value to set property topublic boolean isEnforcedColumnSecurity()
public void setEnforcedColumnSecurity(boolean value)
value
- Value to set property topublic boolean isEnforcedPrimaryKey()
public void setEnforcedPrimaryKey(boolean value)
value
- Value to set property topublic boolean isIncludeRefitem()
public void setIncludeRefitem(boolean value)
value
- Value to set property topublic boolean isInsertAllowed()
public void setInsertAllowed(boolean value)
value
- Value to set property topublic boolean isPrecompSummary()
public void setPrecompSummary(boolean value)
value
- Value to set property topublic boolean isQueryAllRecords()
public void setQueryAllRecords(boolean value)
value
- Value to set property topublic boolean isQueryAllowed()
public void setQueryAllowed(boolean value)
value
- Value to set property topublic boolean isReverseDirection()
public void setReverseDirection(boolean value)
value
- Value to set property topublic boolean isShowScrollbar()
public void setShowScrollbar(boolean value)
value
- Value to set property topublic boolean isSingleRecord()
public void setSingleRecord(boolean value)
value
- Value to set property topublic boolean isSubclassObjectGroup()
public void setSubclassObjectGroup(boolean value)
value
- Value to set property topublic boolean isUpdateAllowed()
public void setUpdateAllowed(boolean value)
value
- Value to set property topublic boolean isUpdateChangedColumns()
public void setUpdateChangedColumns(boolean value)
value
- Value to set property topublic JdapiIterator getDeleteDataSourceArguments()
public JdapiIterator getDeleteDataSourceColumns()
public JdapiIterator getInsertDataSourceArguments()
public JdapiIterator getInsertDataSourceColumns()
public JdapiIterator getItems()
public JdapiIterator getLockDataSourceArguments()
public JdapiIterator getLockDataSourceColumns()
public JdapiObject getModule()
getModule
in class oracle.forms.jdapi.BaseFormsObject
public Block getNextNavigationBlockObject()
public void setNextNavigationBlockObject(Block value)
value
- Block object to set property topublic JdapiObject getOwner()
getOwner
in class oracle.forms.jdapi.BaseFormsObject
public Block getPreviousNavigationBlockObject()
public void setPreviousNavigationBlockObject(Block value)
value
- Block object to set property topublic JdapiIterator getQueryDataSourceArguments()
public JdapiIterator getQueryDataSourceColumns()
public VisualAttribute getRecordVisualAttributeGroupObject()
public void setRecordVisualAttributeGroupObject(VisualAttribute value)
value
- VisualAttribute object to set property topublic JdapiIterator getRelations()
public Canvas getScrollbarCanvasObject()
public void setScrollbarCanvasObject(Canvas value)
value
- Canvas object to set property topublic TabPage getScrollbarTabPageObject()
public void setScrollbarTabPageObject(TabPage value)
value
- TabPage object to set property topublic JdapiObject getSource()
public JdapiIterator getTriggers()
public JdapiIterator getUpdateDataSourceArguments()
public JdapiIterator getUpdateDataSourceColumns()
public VisualAttribute getVisualAttributeObject()
public void setVisualAttributeObject(VisualAttribute value)
value
- VisualAttribute object to set property toprotected long getObjectPointer()
public int queryType()
JdapiTypes
). This should always be the
same value as returned for getTypeId
. The difference between the two methods is that
queryType calls down to the API itself; this ensures that the correct type
is returned. Because this method calls down to the API, you might find it
a little faster to use getTypeID instead.queryType
in interface JdapiObject
JdapiTypes
.public void setClientInfo(java.lang.Object clientInfo)
This client info object is not persistent and will be lost when the session ends.
setClientInfo
in interface JdapiObject
clientInfo
- client info to be associated with the object.public java.lang.Object getClientInfo()
setClientObject
.getClientInfo
in interface JdapiObject
public Blob getPersistentClientInfoBlob()
getPersistentClientInfoBlob
in interface JdapiObject
Blob
containing client info.public java.lang.Object getPersistentClientInfoObject()
getPersistentClientInfoObject
in interface JdapiObject
public void setPersistentClientInfo(Blob val)
Like the non-persistent client info methods, the client info can be any information that you want to save with the form. Unlike the non-persistent client info methods, the persistent info is saved as part of the form and will not be lost when the session is ended.
setPersistentClientInfo
in interface JdapiObject
val
- a Blob
object containing client info.public void setPersistentClientInfo(java.io.Serializable obj)
Like the non-persistent client info methods, the client info can be any information that you want to save with the form. Unlike the non-persistent client info methods, the persistent info is saved as part of the form and will not be lost when the session is ended.
setPersistentClientInfo
in interface JdapiObject
val
- any Serializable object containing client info.public boolean equals(JdapiObject obj)
equals
in interface JdapiObject
object
- object to be compared.public JdapiObject clone(JdapiObject parent, java.lang.String newName)
The new object is the same as the original object in that it has the same property values. However, subclassing information is discarded, and the inherited property values "flattened" into local values in the new object.
It is your reponsibility to pass in an appropriate parent object. If you do not do this, you will probably get a JdapiException runtime exception. If possible, use the type safe clone method that is provided on each Forms object class.
clone
in interface JdapiObject
parent
- owner of the new object.newName
- name of the new object.public void changeOwner(JdapiObject newOwner)
Set newOwner to null if you want the object to have no owner.
The only restriction on this method is that the new owner must be in the same module
as the referred object. If you attempt to assign a new owner that is in a different
module, then a JdapiException
will be thrown.
Note: If you want to assign the object to a new owner in a different module, then you will have to clone or subclass the object.
changeOwner
in interface JdapiObject
newOwner
- the new owner of referred object; specify null if you want the object to have no owner.JdapiException
- if newOwner is in a different
module.public java.lang.String toString()
toString
in interface JdapiObject
toString
in class java.lang.Object
protected void clearObjectPointer()
public boolean isValidFormsObject()
JdapiObject
For example, assume that you have a reference to a block.
If you call destroy()
on its owning module, then the module and all of its blocks
should be deleted from memory. The reference that you have no longer
refers to a valid Forms object. A call to isValidFormsObject() on the
block should return false.
isValidFormsObject
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
public void destroy()
destroy
in interface JdapiObject
public void move(JdapiObject next)
Pass null to this method to move the object to the end of the list. If the specified object and the next_object do not share the same owner, or do not have the same type, the method throws an exception.
You cannot use this method to move objects between parents. For example, it cannot be used to move an Item from one Block to another. If you want to move an object from one parent to another you will have to do something like:
// e.g. to move 'itmA' to be positioned before 'itmB' in block // 'blkB' (when 'itmA' is in another block) // copy itmA into a new parent (blkB) using same name Item newItmA = itmA.clone(blkB, itmA.getName()); newItmA.move(itmB); // move new item relative to itmB itmA.destroy(); // delete original object itmA = newItmA;
move
in interface JdapiObject
nextObject
- the object next to which the specified object
is to be moved.JdapiException
- if you attempt to
move an object next to an object that does not share the same owner or
is not of the samme type.public boolean getBooleanProperty(int propertyTypeId)
getBooleanProperty
in interface JdapiObject
propertyTypeId
- property type ID for which a boolean value is returned.public java.lang.String getStringProperty(int propertyTypeId)
getStringProperty
in interface JdapiObject
propertyTypeId
- property type ID for which a string value is returned.public int getIntegerProperty(int propertyTypeId)
... if(propClass.hasProperty(propNumber) && propClass.allowGet(propNumber)) { int propValue = propClass.getIntegerProperty(propNum); } ...
getIntegerProperty
in interface JdapiObject
propertyTypeId
- property type ID for which an integer value is returned.public int getStringIDProperty(int propertyTypeId)
This method is intended for use with the TranslationTable
object only. For a given property ID it retrieves the integer that indexes the string
property in the table for the current language.
getStringIDProperty
in interface JdapiObject
propertyTypeId
- property type ID for which a String ID value is returned.public java.lang.String getPropertyValueName(int propertyTypeId, int val)
JdapiObject
getPropertyValueName
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- Property numberval
- Value of propertypublic java.lang.String getIntegerPropertyString(int propertyTypeId)
JdapiObject
long
) property value's text
representation.getIntegerPropertyString
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- Number identifying the propertyprotected long getObjProp(int propertyTypeId)
ContextCache
to lookup/instantiate
the Java representation of the object.propertyTypeId
- Number identifying the propertyoracle.forms.builder.jfapi.ContextCache
,
#getObjectProp
public JdapiObject getObjectProperty(int propertyTypeId)
JdapiObject
getObjectProperty
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- property type ID for which a JdapiObject value is returned.public JdapiIterator getChildObjectProperty(int propertyTypeId)
JdapiObject
For example:
... // get the actual values for the current child object type, // for example, get the Items on a Block iter = jo.getChildObjectProperty(prop.getPropertyId()); ...Note, it should be (slightly) faster to call the specific method on the object, for example getBlocks() on the FormModule, as it involves fewer API calls. However, getChildObjectProperty should be sufficient if you only have a propertyTypeId available.
This method also differs from the direct accessors in that null is returned if there are no objects, not an empty iterator.
getChildObjectProperty
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- number identifying the child object property.public void setBooleanProperty(int propertyTypeId, boolean propertyValue)
JdapiObject
setBooleanProperty
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- property type ID of the property for which you want to set the boolean value.propertyValue
- the boolean value for the property.public void setStringProperty(int propertyTypeId, java.lang.String propertyValue)
JdapiObject
setStringProperty
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- property type ID of the property for which you want to set the string value.propertyValue
- the string value for the property.public void setIntegerProperty(int propertyTypeId, int propertyValue)
setIntegerProperty
in interface JdapiObject
propertyTypeId
- property type id for which we set the integer value.propertyValue
- the integer property value in property.protected void setObjProp(int propertyTypeId, long val)
propertyTypeId
- Number identifying the propertyval
- Value to set the property to#setObjectProp
public void setObjectProperty(int propertyTypeId, JdapiObject propertyValue)
setObjectProperty
in interface JdapiObject
propertyTypeId
- property type id for which we set the object property value.propertyValue
- the object property value in property.public boolean hasProperty(int propertyTypeId)
hasProperty
in interface JdapiObject
propertyTypeId
- Number identifying the propertypublic void inheritProperty(int propertyTypeId)
inheritProperty
in interface JdapiObject
propertyTypeId
- Number that identified the propertypublic boolean hasInheritedProperty(int propertyTypeId)
hasInheritedProperty
in interface JdapiObject
propertyTypeId
- Number that identified the propertypublic boolean hasOverriddenProperty(int propertyTypeId)
hasOverriddenProperty
in interface JdapiObject
propertyTypeId
- The type id of the property to
be queried.public boolean hasDefaultedProperty(int propertyTypeId)
hasDefaultedProperty
in interface JdapiObject
propertyTypeId
- Number that identified the propertypublic int getPropertyState(int propertyTypeId)
A property can be in one of the 5 states:
PROPERTY_STATE_UNKNOWN = 0;
PROPERTY_DEFAULT_VALUE = 1;
PROPERTY_OVERRIDDEN_DEFAULT_VALUE = 2;
PROPERTY_INHERITED_VALUE = 3;
PROPERTY_OVERRIDDEN_INHERITED_VALUE = 3;
getPropertyState
in interface JdapiObject
propertyTypeId
- The type id of the property.public boolean isSubclassed()
isSubclassed
in interface JdapiObject
public JdapiObject getSubclassParent()
getSubclassParent
in interface JdapiObject
public void setSubclassParent(JdapiObject parent)
The metadata associated with each object describes the types of objects that can become its subclassing parent. If the subclassing metadata associated with the refrred object doesn't indicate the objects of the given parent's type are allowed, then this method will throw an exception.
setSubclassParent
in interface JdapiObject
parent
- The parent object. If this is null, the child
the referred object will become an orphan. This is the
way to unset the subclassing parent of an object.public JdapiObject createSubclassedChild(JdapiObject childOwner, java.lang.String childName)
createSubclassedChild
in interface JdapiObject
childOwner
- The object that will own
the newly created subclassed child object.childName
- The name to be given to the newly
created child.public void reattach()
reattach
in interface JdapiObject
public JdapiIterator getOwnedObjects()
getOwnedObjects
in interface JdapiObject
public java.lang.String getClassName()
getClassName
in interface JdapiObject
public java.lang.String getQualifiedName(boolean includeModule)
getQualifiedName
in interface JdapiObject
includeModule
- Include the module namepublic JdapiMetaObject getJdapiMetaObject()
getJdapiMetaObject
in interface JdapiObject
public JdapiIterator getMetaProperties()
The various property type ids and the object-property mapping are defined by the specific implementation in the respective Constants file.
getMetaProperties
in interface JdapiObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |