Class Methods
The methods defined in the Class class are summarized in the following table.
Method | Description |
---|---|
addDynamicProperty | Adds and returns a new dynamic property to a specified dynamic property cluster in the receiving class |
addDynamicPropertyCluster | Adds and returns a new dynamic property cluster to the receiving class |
allInstancesInPartition | Fills an array with instances of the receiver class stored in the specified database partition |
allInstances | Fills an array with all persistent instances of the receiver class and its subclasses |
allLocalSubclasses | Adds all subclasses in the current schema of the receiver to a collection |
allProcessTransientInstances | Fills an array with all transient instances of the receiver class created by the current process |
allProperties | Returns all properties of the class |
allPropertiesUpTo | Returns all properties of superclasses of the receiver up to the specified class |
allSharedTransientInstances | Fills an array with all shared transient instances of the receiver class |
allSubclasses | Adds all subclasses in the current schema to a collection |
allSubclassesInSubschemas | Adds all subclasses in subschemas of the receiver to a collection |
allSubclassesUpToSchema | Adds all subclasses of the receiver up to those in the specified schema to a collection |
allSuperclassesUpTo | Adds all superclasses of the receiver up to those in the specified class to a collection |
anyInstance | Returns true if any instances of the receiver class exist |
causeClassEvent | Causes a class event |
compactDynamicPropertyClusters | Compacts dynamic property clusters in which dynamic property instances were deleted |
countPersistentInstances | Returns the number of non-exclusive persistent instances of the receiver class |
countPersistentInstances64 | Returns the number of non-exclusive persistent instances of the receiver class as an |
countPersistentInstancesLim64 | Returns the number of non-exclusive persistent instances of the receiver class up to a specified limit as an |
countPersistentInstancesLimit | Returns the number of non-exclusive persistent instances of the receiver class up to a specified limit |
createPartition | Creates a new empty database partition and returns the partition identifier |
deleteDynamicProperty | Deletes a dynamic property from a cluster in the receiving class |
deleteDynamicPropertyCluster | Deletes a dynamic property cluster from the receiving class |
findConstant | Returns the constant with the specified name from the receiver class |
findDynamicPropertyCluster | Returns the dynamic property cluster with the specified name from the class of the receiver |
findLocalSubclass | Returns the subclass with the specified name from the current schema |
findMethodInSubclasses | Returns the method with the specified name from all subclasses |
findProperty | Returns the property with the specified name |
findPropertyInSubClasses | Returns the property with the specified name from all subclasses |
firstInstance | Returns the first persistent instance of the class |
firstProcessTransientInstance | Returns the first transient instance of the class in the current process |
firstSharedTransientInstance | Returns the first shared transient instance of the class |
getConstantInHTree | Returns the constant with the specified name from the receiver class, its superclasses, and from superschema copies of the receiver class and their superclasses |
getDbFile | Returns the database file to which the class is mapped |
getImplementors | Adds the classes from all schemas in the hierarchy that implement the specified method to a collection |
getMethodInHTree | Returns the method with the specified name from the receiver class, its superclasses, and from superschema copies of the receiver class and their superclasses |
getNextSubClasses | Adds the classes that are subclasses of the current class from the specified collection to a collection |
getProperties | Returns the properties of the class of the receiver |
getProperty | Returns the specified property from the class of the receiver |
getPropertyInHTree | Returns the property with the specified name from the receiver class, its superclasses, and from superschema copies of the receiver class and their superclasses |
getRpsMappingRefs | Adds RPS mappings (instances of the |
getSubclass | Returns the subclass of the specified receiver |
getSubclasses | Adds all subclasses of the receiver class to a collection |
getSubclassesUpToSchema | Adds all subclasses of the receiver up to those in the specified schema to a collection |
getSuperclass | Returns the superclass of the receiver in the highest level of the schema hierarchy |
hasInstance | Returns true if an instance of the class exists |
hasRpsReferences | Returns true if the receiver is referenced by one or more RPS mappings |
hasSubclasses | Returns true if the class has subclasses |
implementsInterface | Returns true if the receiver class implements the specified interface |
instancesExist | Returns true if any instances of the class or its subclasses exist |
lastInstance | Returns the last persistent instance of an object in the class |
lastProcessTransientInstance | Returns the last transient instance of an object in the class in the current process |
lastSharedTransientInstance | Returns the last shared transient instance of an object in the class |
needsReorg | Returns true if the class requires reorganization |
resynchInstances | Discards the replicas of instances of the class |
withAllSubclasses | Adds all subclasses of the receiver class to a collection |
withAllSuperclasses | Adds all superclasses of the receiver class to a collection |