oracle.forms.jdapi
Class JdapiMetaObject

java.lang.Object
  |
  +--oracle.forms.jdapi.JdapiMetaObject

public class JdapiMetaObject
extends java.lang.Object

This class represents the metadata for a Forms object (for example, a Block). It describes the object in terms of its properties. The metaproperty types that the object can contain can be categorized as boolean, child object, integer, object, and string. This class contains methods that let you retrieve the metaproperties of each type. The methods typically occur in pairs:


Method Summary
 JdapiIterator getBooleanMetaProperties()
          Returns an iterator over the boolean properties belonging to this Forms object.
 JdapiMetaProperty getBooleanMetaProperty(int propertyTypeId)
          Returns a boolean property belonging to this object.
 JdapiIterator getChildObjectMetaProperties()
          Retrieves an iterator over the child object properties belonging to this Forms object.
 JdapiMetaProperty getChildObjectMetaProperty(int propertyTypeId)
          Returns a child object property belonging to this object.
 java.lang.String getClassName()
          Returns the class name for this Forms object.
 JdapiIterator getIntegerMetaProperties()
          Returns an iterator over the integer properties belonging to this Forms object.
 JdapiMetaProperty getIntegerMetaProperty(int propertyTypeId)
          Returns an integer property belonging to this object.
 JdapiIterator getMetaProperties()
          Returns an iterator over the entire set of properties belonging to this Forms object.
 JdapiMetaProperty getMetaProperty(int propertyTypeId)
          Returns a meta property belonging to this object, irresprctive of its type.
 JdapiIterator getObjectMetaProperties()
          Returns an iterator over the object properties belonging to this Forms object.
 JdapiMetaProperty getObjectMetaProperty(int propertyTypeId)
          Returns an object property belonging to this object.
 java.lang.Class[] getParentClasses()
          Returns an the array of classes that can potentially be parent objects of the referred object.
 JdapiIterator getStringMetaProperties()
          Returns an iterator over the String properties belonging to this Forms object.
 JdapiMetaProperty getStringMetaProperty(int propertyTypeId)
          Returns a string property belonging to this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getClassName

public java.lang.String getClassName()
Returns the class name for this Forms object.
Returns:
the class name for the Forms object.

getMetaProperties

public JdapiIterator getMetaProperties()
Returns an iterator over the entire set of properties belonging to this Forms object. The iterator cycles through the properties in the order: string, boolean, integer, object, and child object.
Returns:
an iterator over the set of properties belonging to this object.

getStringMetaProperties

public JdapiIterator getStringMetaProperties()
Returns an iterator over the String properties belonging to this Forms object. For example:
     ...
    JdapiMetaObject meta = JdapiMetadata.getJdapiMetaObject(jo.getClass());    
    JdapiIterator props = meta.getStringMetaProperties(); 
    ...
 
Returns:
an iterator over a set of string metaproperties.

getBooleanMetaProperties

public JdapiIterator getBooleanMetaProperties()
Returns an iterator over the boolean properties belonging to this Forms object. For example:
   ...
   JdapiMetaObject meta = JdapiMetadata.getJdapiMetaObject(jo.getClass());    
   JdapiIterator props = meta.getBooleanMetaProperties(); 
   ...
 
Returns:
an iterator over a set of boolean metaproperties.

getIntegerMetaProperties

public JdapiIterator getIntegerMetaProperties()
Returns an iterator over the integer properties belonging to this Forms object. For example:
   ...
   JdapiMetaObject meta = JdapiMetadata.getJdapiMetaObject(jo.getClass());    
   JdapiIterator props = meta.getIntegerMetaProperties(); 
   ...
 
Returns:
an iterator over a set of integer metaproperties.

getObjectMetaProperties

public JdapiIterator getObjectMetaProperties()
Returns an iterator over the object properties belonging to this Forms object. For example:
   ...
   JdapiMetaObject meta = JdapiMetadata.getJdapiMetaObject(jo.getClass());    
   JdapiIterator props = meta.getObjectMetaProperties(); 
   ...
 
Returns:
an iterator over a set of object metaproperties.

getChildObjectMetaProperties

public JdapiIterator getChildObjectMetaProperties()
Retrieves an iterator over the child object properties belonging to this Forms object. For example:
   ...
   JdapiMetaObject meta = JdapiMetadata.getJdapiMetaObject(jo.getClass());    
   JdapiIterator props = meta.getChildObjectMetaProperties(); 
   ...
  
Returns:
an iterator over a set of child object metaproperties.

getStringMetaProperty

public JdapiMetaProperty getStringMetaProperty(int propertyTypeId)
Returns a string property belonging to this object. The string property is determined by the value of the property type ID that is passed to the method. The method returns null if the object does not have a property corresponding to the property type ID.
Parameters:
propertyTypeId - the property type number ID.
Returns:
the property as a JdapiMetaProperty, or null if the object does not have that property.

getIntegerMetaProperty

public JdapiMetaProperty getIntegerMetaProperty(int propertyTypeId)
Returns an integer property belonging to this object. The integer property is determined by the value of the property type ID that is passed to the method. The method returns null if the object does not have a property corresponding to the property type ID.
Parameters:
propertyTypeId - the property type number ID.
Returns:
the property as a JdapiMetaProperty, or null if the object does not have that property.

getBooleanMetaProperty

public JdapiMetaProperty getBooleanMetaProperty(int propertyTypeId)
Returns a boolean property belonging to this object. The boolean property is determined by the value of the property type ID that is passed to the method. The method returns null if the object does not have a property corresponding to the property type ID.
Parameters:
propertyTypeId - the property type number ID.
Returns:
the property as a JdapiMetaProperty, or null if the object does not have that property.

getObjectMetaProperty

public JdapiMetaProperty getObjectMetaProperty(int propertyTypeId)
Returns an object property belonging to this object. The object property is determined by the value of the property type ID that is passed to the method. The method returns null if the object does not have a property corresponding to the property type ID.
Parameters:
propertyTypeId - the property type number ID.
Returns:
the property or null if the object does not have that property.

getChildObjectMetaProperty

public JdapiMetaProperty getChildObjectMetaProperty(int propertyTypeId)
Returns a child object property belonging to this object. The child object property is determined by the value of the property type ID that is passed to the method. The method returns null if the object does not have a property corresponding to the property type ID.
Parameters:
propertyTypeId - the property type number ID.
Returns:
the property as a JdapiMetaProperty, or null if the object does not have that property.

getMetaProperty

public JdapiMetaProperty getMetaProperty(int propertyTypeId)
Returns a meta property belonging to this object, irresprctive of its type. The property is determined by the value of the property type ID that is passed to the method. The method returns null if the object does not have a property corresponding to the property type ID.
Parameters:
propertyTypeId - the property type number ID.
Returns:
the property as a JdapiMetaProperty, or null if the object does not have that property.

getParentClasses

public java.lang.Class[] getParentClasses()
Returns an the array of classes that can potentially be parent objects of the referred object. For example, if this method is applied to a Trigger, the returned array would contain the classes for Block, Item, Form, and so on.
Returns:
Array or classes