public class PlsqlModule extends JdapiModule
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 |
---|---|
protected |
PlsqlModule(long pd2flib)
Protected constructor, used internally to create PlsqlModule
objects.
|
Modifier and Type | Method and Description |
---|---|
PlsqlModule |
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 PlsqlModule |
find(java.lang.String name)
Find an instance of PlsqlModule.
|
JdapiIterator |
getAttachedLibraries()
Accessor for child AttachedLibrary objects (ATTACHMENT_LIBRARY_PTID).
|
java.lang.String |
getLibraryLocation()
Get text property LibraryLocation (LIBRARY_LOCATION_PTID).
|
int |
getLibrarySource()
Get number property LibrarySource (LIBRARY_SOURCE_PTID).
|
JdapiIterator |
getProgramUnits()
Accessor for child ProgramUnit objects (LIBRARY_PROGRAM_UNIT_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
static PlsqlModule |
open(java.io.File file)
Loads a PlsqlModule module from the filesystem or from the loaded
modules list.
|
static PlsqlModule |
open(java.io.File file,
java.lang.String formsPath)
Loads a PlsqlModule module from the filesystem or from the loaded
modules list.
|
static PlsqlModule |
open(java.lang.String fileName)
Loads a PlsqlModule module from the filesystem or from the loaded
modules list.
|
static PlsqlModule |
open(java.lang.String fileName,
java.lang.String formsPath)
Loads a PlsqlModule module from the filesystem or from the loaded
modules list.
|
void |
save(java.lang.String fileName)
Saves the module to the filesystem.
|
compile_all, destroy, getAbsolutePath, getModulesProductVersion, openModule, openModule, openModule, openModule, setAbsolutePath
changeOwner, clearObjectPointer, clone, createSubclassedChild, equals, getBooleanProperty, getChildObjectProperty, getClassName, getClientInfo, getIntegerProperty, getIntegerPropertyString, getJdapiMetaObject, getMetaProperties, getModule, getName, getObjectPointer, getObjectProperty, getObjProp, getOwnedObjects, getOwner, 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
protected PlsqlModule(long pd2flib)
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);
pd2flib
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public static PlsqlModule open(java.lang.String fileName)
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.
fileName
- File name of PlsqlModule to loadpublic static PlsqlModule open(java.io.File file)
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.
file
- File representing PlsqlModule to loadpublic static PlsqlModule open(java.lang.String fileName, java.lang.String formsPath)
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.
fileName
- Filename of PlsqlModule to loadformsPath
- Path to use to look for modules that have been
subclassed from. 'null' means use the default
FORMS70_PATH.public static PlsqlModule open(java.io.File file, java.lang.String formsPath)
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.
file
- File representing PlsqlModule to loadformsPath
- Path to use to look for modules that have been
subclassed from. 'null' means use the default
FORMS70_PATH.public void save(java.lang.String fileName)
Note that this method is currently unsupported for PlsqlModule types, and if called, a JdapiUnsupportedOperationException will be thrown.
save
in class JdapiModule
fileName
- Filename to save aspublic void compile()
compile
in class JdapiModule
public PlsqlModule clone(java.lang.String newName)
newName
- Name of object that's being createdpublic static PlsqlModule find(java.lang.String name)
name
- Name of object you wish to findpublic java.lang.String getLibraryLocation()
public int getLibrarySource()
public JdapiIterator getAttachedLibraries()
public JdapiIterator getProgramUnits()