IRISLIB database
Super Class Reference

Functions needed for all collection classes. More...

Inheritance diagram for Super:
Collaboration diagram for Super:

Public Member Functions

_.Library.Status Clear ()
 Clears the contents of the array. More...
 
_.Library.Status DeSerialize (_.Library.String serialized)
 Deserialize from string created with <method>Serialize</method> back to collection.
 
_.Library.String Serialize (_.Library.Integer force)
 Serialize constructs a serialized form of the collection as a string.
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Public Attributes

 ElementClassType
 The ClassType of the elements stored by this collection. More...
 
 ElementType
 The type (classname:propertyname) of the elements stored in the collection. More...
 
 LiteralBehavior
 True if this collection is a 'literal object' so the Insert/Set should make a copy of the object. More...
 
 OrefStorage
   More...
 
 Owner
 Integer version of the object that has the collection data. More...
 
 ReadOnly
 True if this collection is read only. More...
 
 Storage
   More...
 
 StreamLocation
 For stream collections this contains the stream root location. More...
 

Static Public Attributes

 ELEMENTTYPE = None
 Functions needed for all collection classes. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Private Member Functions

_.Library.Status Disconnect ()
 Called when the parent object is about to be removed so this collection can exist. More...
 
_.Library.Integer IsModified ()
 Returns true (1) if a property of this instance has been modified, otherwise false (0). More...
 

Private Attributes

 __oidData
 If the collection is disconnected this is where the oid data is stored. More...
 
 __orefData
 If the collection is disconnected this is where the oref data is stored. More...
 

Detailed Description

Functions needed for all collection classes.

Member Function Documentation

◆ Disconnect()

_.Library.Status Disconnect ( )
private

Called when the parent object is about to be removed so this collection can exist.

in a disconnected state. It makes a copy of the parents collection information.

◆ IsModified()

_.Library.Integer IsModified ( )
private

Returns true (1) if a property of this instance has been modified, otherwise false (0).

A TRUE result does not necessarily mean that any property has actually been changed. If IsModified() returns false then the object has not been modified. There are some situations where we simply cannot efficiently detect a change in value. In these cases we will set the modified status of the property.

Reimplemented from RegisteredObject.

◆ Clear()

_.Library.Status Clear ( )

Clears the contents of the array.

Both the OID value is cleared.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

Member Data Documentation

◆ ELEMENTTYPE

ELEMENTTYPE = None
static

Functions needed for all collection classes.

The type (class name) of the elements stored in the collection.

◆ ElementClassType

ElementClassType

The ClassType of the elements stored by this collection.

 

◆ ElementType

ElementType

The type (classname:propertyname) of the elements stored in the collection.

 

◆ LiteralBehavior

LiteralBehavior

True if this collection is a 'literal object' so the Insert/Set should make a copy of the object.

before inserting it.  

◆ OrefStorage

OrefStorage

 

 

◆ Owner

Owner

Integer version of the object that has the collection data.

 

◆ ReadOnly

ReadOnly

True if this collection is read only.

 

◆ Storage

Storage

 

 

◆ StreamLocation

StreamLocation

For stream collections this contains the stream root location.

 

◆ __oidData

__oidData
private

If the collection is disconnected this is where the oid data is stored.

 

◆ __orefData

__orefData
private

If the collection is disconnected this is where the oref data is stored.