oracle.forms.jdapi
Class FormModule

java.lang.Object
  |
  +--oracle.forms.jdapi.BaseFormsObject
        |
        +--oracle.forms.jdapi.JdapiModule
              |
              +--oracle.forms.jdapi.FormModule
All Implemented Interfaces:
JdapiObject

public class FormModule
extends JdapiModule

Object to represent a Forms FormModule object. This is an encapsulation of the Forms C API d2ffmd.

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.

See Also:
BaseAPI

Fields inherited from class oracle.forms.jdapi.JdapiModule
m_clientInfo, m_pd2fob
 
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
protected FormModule(long pd2ffmd)
          Protected constructor, used internally to create FormModule objects.
  FormModule(java.lang.String name)
          Constructor used to create FormModule objects.
 
Method Summary
 FormModule clone(java.lang.String newName)
          Creates a copy of the object as a child of 'parent'.
 void compile()
          Compiles the module to the filesystem.
static FormModule find(java.lang.String name)
          Find an instance of FormModule.
 JdapiIterator getAlerts()
          Accessor for child Alert objects (ALERT_PTID).
 JdapiIterator getAttachedLibraries()
          Accessor for child AttachedLibrary objects (ATTACHMENT_LIBRARY_PTID).
 JdapiIterator getBlocks()
          Accessor for child Block objects (BLOCK_PTID).
 JdapiIterator getCanvases()
          Accessor for child Canvas objects (CANVAS_PTID).
 java.lang.String getComment()
          Get text property Comment (COMMENT_PTID).
 java.lang.String getConsoleWindow()
          Get text property ConsoleWindow (CONSOLE_WINDOW_PTID).
 int getCursorMode()
          Get number property CursorMode (CURSOR_MODE_PTID).
 JdapiIterator getEditors()
          Accessor for child Editor objects (EDITOR_PTID).
 java.lang.String getFirstNavigationBlockName()
          Get text property FirstNavigationBlockName (FIRST_NAVIGATION_BLOCK_NAME_PTID).
 Block getFirstNavigationBlockObject()
          Get object property FirstNavigationBlockObject (FIRST_NAVIGATION_BLOCK_OBJECT_PTID).
 java.lang.String getHelpBookTitle()
          Get text property HelpBookTitle (HELP_BOOK_TITLE_PTID).
 java.lang.String getHorizontalToolbarCanvas()
          Get text property HorizontalToolbarCanvas (HORIZONTAL_TOOLBAR_CANVAS_PTID).
 java.lang.String getInitializeMenu()
          Get text property InitializeMenu (INITIALIZE_MENU_PTID).
 int getInteractionMode()
          Get number property InteractionMode (INTERACTION_MODE_PTID).
 int getIsolationMode()
          Get number property IsolationMode (ISOLATION_MODE_PTID).
 int getLanguageDirection()
          Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
 JdapiIterator getLOVs()
          Accessor for child LOV objects (LOV_PTID).
 int getMaximumQueryTime()
          Get number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
 int getMaximumRecordsFetched()
          Get number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID).
 java.lang.String getMenuModule()
          Get text property MenuModule (MENU_MODULE_PTID).
 java.lang.String getMenuRole()
          Get text property MenuRole (MENU_ROLE_PTID).
 JdapiIterator getMenus()
          Accessor for child Menu objects (MENU_PTID).
 JdapiIterator getModuleParameters()
          Accessor for child ModuleParameter objects (FORM_PARAMETER_PTID).
 int getMouseNavigationLimit()
          Get number property MouseNavigationLimit (MOUSE_NAVIGATION_LIMIT_PTID).
 java.lang.String getName()
          Get text property Name (NAME_PTID).
 int getNewdeferReqEnf()
          Get number property NewdeferReqEnf (NEWDEFER_REQ_ENF_PTID).
 JdapiIterator getObjectGroups()
          Accessor for child ObjectGroup objects (OBJECT_GROUP_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).
 int getPersistentClientInfoLength()
          Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
 JdapiIterator getProgramUnits()
          Accessor for child ProgramUnit objects (PROGRAM_UNIT_PTID).
 JdapiIterator getPropertyClasses()
          Accessor for child PropertyClass objects (PROPERTY_CLASS_PTID).
 JdapiIterator getRecordGroups()
          Accessor for child RecordGroup objects (RECORD_GROUP_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 getReports()
          Accessor for child Report objects (REPORT_PTID).
 int getRuntimeComp()
          Get number property RuntimeComp (RUNTIME_COMP_PTID).
 java.lang.String getTitle()
          Get text property Title (TITLE_PTID).
 TranslationTable getTranslationTable()
          Get a TranslationTable object representing the translations for this module.
 JdapiIterator getTriggers()
          Accessor for child Trigger objects (TRIGGER_PTID).
 int getTypeId()
          Gets the HtmlForms object type ID.
 int getValidationUnit()
          Get number property ValidationUnit (VALIDATION_UNIT_PTID).
 java.lang.String getVerticalToolbarCanvas()
          Get text property VerticalToolbarCanvas (VERTICAL_TOOLBAR_CANVAS_PTID).
 JdapiIterator getVisualAttributes()
          Accessor for child VisualAttribute objects (VISUAL_ATTRIBUTE_PTID).
 JdapiIterator getWindows()
          Accessor for child Window objects (WINDOW_PTID).
 boolean isDirtyInfo()
          Get boolean property DirtyInfo (DIRTY_INFO_PTID).
 boolean isSavepointMode()
          Get boolean property SavepointMode (SAVEPOINT_MODE_PTID).
 boolean isUse3dControls()
          Get boolean property Use3dControls (USE_3D_CONTROLS_PTID).
static FormModule open(java.io.File file)
          Loads a FormModule module from the filesystem or from the loaded modules list.
static FormModule open(java.io.File file, java.lang.String formsPath)
          Loads a FormModule module from the filesystem or from the loaded modules list.
static FormModule open(java.lang.String fileName)
          Loads a FormModule module from the filesystem or from the loaded modules list.
static FormModule open(java.lang.String fileName, java.lang.String formsPath)
          Loads a FormModule module from the filesystem or from the loaded modules list.
 void save(java.lang.String fileName)
          Saves the module to the filesystem.
 void setComment(java.lang.String value)
          Sets text property Comment (COMMENT_PTID).
 void setConsoleWindow(java.lang.String value)
          Sets text property ConsoleWindow (CONSOLE_WINDOW_PTID).
 void setDirtyInfo(boolean value)
          Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
 void setFirstNavigationBlockName(java.lang.String value)
          Sets text property FirstNavigationBlockName (FIRST_NAVIGATION_BLOCK_NAME_PTID).
 void setFirstNavigationBlockObject(Block value)
          Set object property FirstNavigationBlockObject (FIRST_NAVIGATION_BLOCK_OBJECT_PTID).
 void setHelpBookTitle(java.lang.String value)
          Sets text property HelpBookTitle (HELP_BOOK_TITLE_PTID).
 void setHorizontalToolbarCanvas(java.lang.String value)
          Sets text property HorizontalToolbarCanvas (HORIZONTAL_TOOLBAR_CANVAS_PTID).
 void setInitializeMenu(java.lang.String value)
          Sets text property InitializeMenu (INITIALIZE_MENU_PTID).
 void setInteractionMode(int value)
          Sets number property InteractionMode (INTERACTION_MODE_PTID).
 void setIsolationMode(int value)
          Sets number property IsolationMode (ISOLATION_MODE_PTID).
 void setLanguageDirection(int value)
          Sets number property LanguageDirection (LANGUAGE_DIRECTION_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 setMenuModule(java.lang.String value)
          Sets text property MenuModule (MENU_MODULE_PTID).
 void setMenuRole(java.lang.String value)
          Sets text property MenuRole (MENU_ROLE_PTID).
 void setMouseNavigationLimit(int value)
          Sets number property MouseNavigationLimit (MOUSE_NAVIGATION_LIMIT_PTID).
 void setName(java.lang.String value)
          Sets text property Name (NAME_PTID).
 void setNewdeferReqEnf(int value)
          Sets number property NewdeferReqEnf (NEWDEFER_REQ_ENF_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 setPersistentClientInfoLength(int value)
          Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_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 setRuntimeComp(int value)
          Sets number property RuntimeComp (RUNTIME_COMP_PTID).
 void setTitle(java.lang.String value)
          Sets text property Title (TITLE_PTID).
 void setUse3dControls(boolean value)
          Sets boolean property Use3dControls (USE_3D_CONTROLS_PTID).
 void setValidationUnit(int value)
          Sets number property ValidationUnit (VALIDATION_UNIT_PTID).
 void setVerticalToolbarCanvas(java.lang.String value)
          Sets text property VerticalToolbarCanvas (VERTICAL_TOOLBAR_CANVAS_PTID).
 
Methods inherited from class oracle.forms.jdapi.JdapiModule
changeOwner, clearObjectPointer, clone, createSubclassedChild, destroy, equals, getAbsolutePath, getBooleanProperty, getChildObjectProperty, getClassName, getClientInfo, getIntegerProperty, getIntegerPropertyString, getJdapiMetaObject, getMetaProperties, getModule, getModulesProductVersion, getObjectPointer, getObjectProperty, getObjProp, getOwnedObjects, getOwner, getPersistentClientInfoBlob, getPersistentClientInfoObject, getPropertyState, getPropertyValueName, getQualifiedName, getStringIDProperty, getStringProperty, getSubclassParent, hasDefaultedProperty, hasInheritedProperty, hasOverriddenProperty, hasProperty, inheritProperty, isSubclassed, isValidFormsObject, move, openModule, openModule, openModule, openModule, queryType, reattach, setAbsolutePath, setBooleanProperty, setClientInfo, setIntegerProperty, setObjectProperty, setObjProp, setPersistentClientInfo, setPersistentClientInfo, setStringProperty, setSubclassParent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FormModule

public FormModule(java.lang.String name)
Constructor used to create FormModule objects.
Parameters:
name - Name of the new object

FormModule

protected FormModule(long pd2ffmd)
Protected constructor, used internally to create FormModule objects. This doesn't actually create a new FormModule, it just creates a Java instance for an already existing Forms object.

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);
 
Parameters:
pd2fctx - C pointer to Forms context
pd2ffmd - C pointer to Forms object
Method Detail

getTypeId

public int getTypeId()
Gets the HtmlForms object type ID.
Overrides:
getTypeId in class oracle.forms.jdapi.BaseFormsObject
Returns:
X_OTID ID for this object type

open

public static FormModule open(java.lang.String fileName)
Loads a FormModule module from the filesystem or from the loaded modules list.

A runtime exception is thrown if a module the file has subclassed from cannot be found on the Forms path. This behaviour can be suppressed with the Jdapi.setFailSubclassLoad() method.

Parameters:
fileName - File name of FormModule to load
Returns:
FormModule object

open

public static FormModule open(java.io.File file)
Loads a FormModule module from the filesystem or from the loaded modules list.

A runtime exception is thrown if a module the file has subclassed from cannot be found on the Forms path. This behaviour can be suppressed with the Jdapi.setFailSubclassLoad() method.

Parameters:
fileName - File representing FormModule to load
Returns:
FormModule object

open

public static FormModule open(java.lang.String fileName,
                              java.lang.String formsPath)
Loads a FormModule module from the filesystem or from the loaded modules list.

A runtime exception is thrown if a module the file has subclassed from cannot be found on the Forms path. This behaviour can be suppressed with the Jdapi.setFailSubclassLoad() method.

Parameters:
fileName - Filename of FormModule to load
formsPath - Path to use to look for modules that have been subclassed from. 'null' means use the default FORMS70_PATH.
Returns:
FormModule object

open

public static FormModule open(java.io.File file,
                              java.lang.String formsPath)
Loads a FormModule module from the filesystem or from the loaded modules list.

A runtime exception is thrown if a module the file has subclassed from cannot be found on the Forms path. This behaviour can be suppressed with the Jdapi.setFailSubclassLoad() method.

Parameters:
File - File representing FormModule to load
formsPath - Path to use to look for modules that have been subclassed from. 'null' means use the default FORMS70_PATH.
Returns:
FormModule object

save

public void save(java.lang.String fileName)
Saves the module to the filesystem.
Overrides:
save in class JdapiModule
Parameters:
fileName - Filename to save as

compile

public void compile()
Compiles the module to the filesystem.
Overrides:
compile in class JdapiModule
Parameters:
fileName - name of file to compile

clone

public FormModule clone(java.lang.String newName)
Creates a copy of the object as a child of 'parent'.
Parameters:
newName - Name of object that's being created
Returns:
Replicant object

find

public static FormModule find(java.lang.String name)
Find an instance of FormModule.
Parameters:
parent - Parent object of object you wish to find
name - Name of object you wish to find
Returns:
Object instance you are looking for, or null if none was found

getTranslationTable

public TranslationTable getTranslationTable()
Get a TranslationTable object representing the translations for this module.
Returns:
TranslationTable

getComment

public java.lang.String getComment()
Get text property Comment (COMMENT_PTID).
Returns:
Value of property

setComment

public void setComment(java.lang.String value)
Sets text property Comment (COMMENT_PTID).
Parameters:
value - Value to set property to

getConsoleWindow

public java.lang.String getConsoleWindow()
Get text property ConsoleWindow (CONSOLE_WINDOW_PTID).
Returns:
Value of property

setConsoleWindow

public void setConsoleWindow(java.lang.String value)
Sets text property ConsoleWindow (CONSOLE_WINDOW_PTID).
Parameters:
value - Value to set property to

getFirstNavigationBlockName

public java.lang.String getFirstNavigationBlockName()
Get text property FirstNavigationBlockName (FIRST_NAVIGATION_BLOCK_NAME_PTID).
Returns:
Value of property

setFirstNavigationBlockName

public void setFirstNavigationBlockName(java.lang.String value)
Sets text property FirstNavigationBlockName (FIRST_NAVIGATION_BLOCK_NAME_PTID).
Parameters:
value - Value to set property to

getHelpBookTitle

public java.lang.String getHelpBookTitle()
Get text property HelpBookTitle (HELP_BOOK_TITLE_PTID).
Returns:
Value of property

setHelpBookTitle

public void setHelpBookTitle(java.lang.String value)
Sets text property HelpBookTitle (HELP_BOOK_TITLE_PTID).
Parameters:
value - Value to set property to

getHorizontalToolbarCanvas

public java.lang.String getHorizontalToolbarCanvas()
Get text property HorizontalToolbarCanvas (HORIZONTAL_TOOLBAR_CANVAS_PTID).
Returns:
Value of property

setHorizontalToolbarCanvas

public void setHorizontalToolbarCanvas(java.lang.String value)
Sets text property HorizontalToolbarCanvas (HORIZONTAL_TOOLBAR_CANVAS_PTID).
Parameters:
value - Value to set property to

getInitializeMenu

public java.lang.String getInitializeMenu()
Get text property InitializeMenu (INITIALIZE_MENU_PTID).
Returns:
Value of property

setInitializeMenu

public void setInitializeMenu(java.lang.String value)
Sets text property InitializeMenu (INITIALIZE_MENU_PTID).
Parameters:
value - Value to set property to

getMenuModule

public java.lang.String getMenuModule()
Get text property MenuModule (MENU_MODULE_PTID).
Returns:
Value of property

setMenuModule

public void setMenuModule(java.lang.String value)
Sets text property MenuModule (MENU_MODULE_PTID).
Parameters:
value - Value to set property to

getMenuRole

public java.lang.String getMenuRole()
Get text property MenuRole (MENU_ROLE_PTID).
Returns:
Value of property

setMenuRole

public void setMenuRole(java.lang.String value)
Sets text property MenuRole (MENU_ROLE_PTID).
Parameters:
value - Value to set property to

getName

public java.lang.String getName()
Get text property Name (NAME_PTID).
Overrides:
getName in class oracle.forms.jdapi.BaseFormsObject
Returns:
Value of property

setName

public void setName(java.lang.String value)
Sets text property Name (NAME_PTID).
Parameters:
value - Value to set property to

getParentFilename

public java.lang.String getParentFilename()
Get text property ParentFilename (PARENT_FILENAME_PTID).
Returns:
Value of property

setParentFilename

public void setParentFilename(java.lang.String value)
Sets text property ParentFilename (PARENT_FILENAME_PTID).
Parameters:
value - Value to set property to

getParentFilepath

public java.lang.String getParentFilepath()
Get text property ParentFilepath (PARENT_FILEPATH_PTID).
Returns:
Value of property

setParentFilepath

public void setParentFilepath(java.lang.String value)
Sets text property ParentFilepath (PARENT_FILEPATH_PTID).
Parameters:
value - Value to set property to

getParentModule

public java.lang.String getParentModule()
Get text property ParentModule (PARENT_MODULE_PTID).
Returns:
Value of property

setParentModule

public void setParentModule(java.lang.String value)
Sets text property ParentModule (PARENT_MODULE_PTID).
Parameters:
value - Value to set property to

getParentName

public java.lang.String getParentName()
Get text property ParentName (PARENT_NAME_PTID).
Returns:
Value of property

setParentName

public void setParentName(java.lang.String value)
Sets text property ParentName (PARENT_NAME_PTID).
Parameters:
value - Value to set property to

getRecordVisualAttributeGroupName

public java.lang.String getRecordVisualAttributeGroupName()
Get text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID).
Returns:
Value of property

setRecordVisualAttributeGroupName

public void setRecordVisualAttributeGroupName(java.lang.String value)
Sets text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID).
Parameters:
value - Value to set property to

getTitle

public java.lang.String getTitle()
Get text property Title (TITLE_PTID).
Returns:
Value of property

setTitle

public void setTitle(java.lang.String value)
Sets text property Title (TITLE_PTID).
Parameters:
value - Value to set property to

getVerticalToolbarCanvas

public java.lang.String getVerticalToolbarCanvas()
Get text property VerticalToolbarCanvas (VERTICAL_TOOLBAR_CANVAS_PTID).
Returns:
Value of property

setVerticalToolbarCanvas

public void setVerticalToolbarCanvas(java.lang.String value)
Sets text property VerticalToolbarCanvas (VERTICAL_TOOLBAR_CANVAS_PTID).
Parameters:
value - Value to set property to

getCursorMode

public int getCursorMode()
Get number property CursorMode (CURSOR_MODE_PTID).
Returns:
Value of property

getInteractionMode

public int getInteractionMode()
Get number property InteractionMode (INTERACTION_MODE_PTID).
Returns:
Value of property

setInteractionMode

public void setInteractionMode(int value)
Sets number property InteractionMode (INTERACTION_MODE_PTID).
Parameters:
value - Value to set property to

getIsolationMode

public int getIsolationMode()
Get number property IsolationMode (ISOLATION_MODE_PTID).
Returns:
Value of property

setIsolationMode

public void setIsolationMode(int value)
Sets number property IsolationMode (ISOLATION_MODE_PTID).
Parameters:
value - Value to set property to

getLanguageDirection

public int getLanguageDirection()
Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
Returns:
Value of property

setLanguageDirection

public void setLanguageDirection(int value)
Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
Parameters:
value - Value to set property to

getMaximumQueryTime

public int getMaximumQueryTime()
Get number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
Returns:
Value of property

setMaximumQueryTime

public void setMaximumQueryTime(int value)
Sets number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
Parameters:
value - Value to set property to

getMaximumRecordsFetched

public int getMaximumRecordsFetched()
Get number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID).
Returns:
Value of property

setMaximumRecordsFetched

public void setMaximumRecordsFetched(int value)
Sets number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID).
Parameters:
value - Value to set property to

getMouseNavigationLimit

public int getMouseNavigationLimit()
Get number property MouseNavigationLimit (MOUSE_NAVIGATION_LIMIT_PTID).
Returns:
Value of property

setMouseNavigationLimit

public void setMouseNavigationLimit(int value)
Sets number property MouseNavigationLimit (MOUSE_NAVIGATION_LIMIT_PTID).
Parameters:
value - Value to set property to

getNewdeferReqEnf

public int getNewdeferReqEnf()
Get number property NewdeferReqEnf (NEWDEFER_REQ_ENF_PTID).
Returns:
Value of property

setNewdeferReqEnf

public void setNewdeferReqEnf(int value)
Sets number property NewdeferReqEnf (NEWDEFER_REQ_ENF_PTID).
Parameters:
value - Value to set property to

getParentModuleType

public int getParentModuleType()
Get number property ParentModuleType (PARENT_MODULETYPE_PTID).
Returns:
Value of property

setParentModuleType

public void setParentModuleType(int value)
Sets number property ParentModuleType (PARENT_MODULETYPE_PTID).
Parameters:
value - Value to set property to

getParentType

public int getParentType()
Get number property ParentType (PARENT_TYPE_PTID).
Returns:
Value of property

setParentType

public void setParentType(int value)
Sets number property ParentType (PARENT_TYPE_PTID).
Parameters:
value - Value to set property to

getPersistentClientInfoLength

public int getPersistentClientInfoLength()
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
Returns:
Value of property

setPersistentClientInfoLength

public void setPersistentClientInfoLength(int value)
Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
Parameters:
value - Value to set property to

getRuntimeComp

public int getRuntimeComp()
Get number property RuntimeComp (RUNTIME_COMP_PTID).
Returns:
Value of property

setRuntimeComp

public void setRuntimeComp(int value)
Sets number property RuntimeComp (RUNTIME_COMP_PTID).
Parameters:
value - Value to set property to

getValidationUnit

public int getValidationUnit()
Get number property ValidationUnit (VALIDATION_UNIT_PTID).
Returns:
Value of property

setValidationUnit

public void setValidationUnit(int value)
Sets number property ValidationUnit (VALIDATION_UNIT_PTID).
Parameters:
value - Value to set property to

isDirtyInfo

public boolean isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
Returns:
Value of property

setDirtyInfo

public void setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
Parameters:
value - Value to set property to

isSavepointMode

public boolean isSavepointMode()
Get boolean property SavepointMode (SAVEPOINT_MODE_PTID).
Returns:
Value of property

isUse3dControls

public boolean isUse3dControls()
Get boolean property Use3dControls (USE_3D_CONTROLS_PTID).
Returns:
Value of property

setUse3dControls

public void setUse3dControls(boolean value)
Sets boolean property Use3dControls (USE_3D_CONTROLS_PTID).
Parameters:
value - Value to set property to

getAlerts

public JdapiIterator getAlerts()
Accessor for child Alert objects (ALERT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Alert objects

getAttachedLibraries

public JdapiIterator getAttachedLibraries()
Accessor for child AttachedLibrary objects (ATTACHMENT_LIBRARY_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of AttachedLibrary objects

getBlocks

public JdapiIterator getBlocks()
Accessor for child Block objects (BLOCK_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Block objects

getCanvases

public JdapiIterator getCanvases()
Accessor for child Canvas objects (CANVAS_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Canvas objects

getEditors

public JdapiIterator getEditors()
Accessor for child Editor objects (EDITOR_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Editor objects

getModuleParameters

public JdapiIterator getModuleParameters()
Accessor for child ModuleParameter objects (FORM_PARAMETER_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of ModuleParameter objects

getFirstNavigationBlockObject

public Block getFirstNavigationBlockObject()
Get object property FirstNavigationBlockObject (FIRST_NAVIGATION_BLOCK_OBJECT_PTID).
Returns:
Value of property (null if none)

setFirstNavigationBlockObject

public void setFirstNavigationBlockObject(Block value)
Set object property FirstNavigationBlockObject (FIRST_NAVIGATION_BLOCK_OBJECT_PTID).
Parameters:
value - Block object to set property to

getLOVs

public JdapiIterator getLOVs()
Accessor for child LOV objects (LOV_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of LOV objects

getMenus

public JdapiIterator getMenus()
Accessor for child Menu objects (MENU_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Menu objects

getObjectGroups

public JdapiIterator getObjectGroups()
Accessor for child ObjectGroup objects (OBJECT_GROUP_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of ObjectGroup objects

getProgramUnits

public JdapiIterator getProgramUnits()
Accessor for child ProgramUnit objects (PROGRAM_UNIT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of ProgramUnit objects

getPropertyClasses

public JdapiIterator getPropertyClasses()
Accessor for child PropertyClass objects (PROPERTY_CLASS_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of PropertyClass objects

getRecordGroups

public JdapiIterator getRecordGroups()
Accessor for child RecordGroup objects (RECORD_GROUP_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of RecordGroup objects

getRecordVisualAttributeGroupObject

public VisualAttribute getRecordVisualAttributeGroupObject()
Get object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID).
Returns:
Value of property (null if none)

setRecordVisualAttributeGroupObject

public void setRecordVisualAttributeGroupObject(VisualAttribute value)
Set object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID).
Parameters:
value - VisualAttribute object to set property to

getReports

public JdapiIterator getReports()
Accessor for child Report objects (REPORT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Report objects

getTriggers

public JdapiIterator getTriggers()
Accessor for child Trigger objects (TRIGGER_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Trigger objects

getVisualAttributes

public JdapiIterator getVisualAttributes()
Accessor for child VisualAttribute objects (VISUAL_ATTRIBUTE_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of VisualAttribute objects

getWindows

public JdapiIterator getWindows()
Accessor for child Window objects (WINDOW_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Window objects