ListOfObjCN Class Reference

A version of the <CLASS>Collection.ListOfObj</CLASS> collection class that stores class names in OIDs. More...

Inheritance diagram for ListOfObjCN:

Collaboration diagram for ListOfObjCN:

Public Member Functions
_.Library.String	Find (_.Library.ObjectIdentity element, _.Library.Integer key)
	Starting from, but not including, position key, Find finds. More...
_.Library.String	Serialize (_.Library.Integer force)
	Serialize() constructs a serialized form of the collection as a string.
Public Member Functions inherited from ListOfObj
_.Library.Integer	Count ()
	Returns the number of elements contained in the list.
_.Library.Status	DeSerialize (_.Library.String serialized)
	Deserialize from string created with <method>Serialize</method> back to collection.
_.Library.String	FindObjectId (_.Library.String id, _.Library.Integer key)
	Starting from, but not including, position key, FindObjectId finds. More...
_.Library.String	FindOref (_.Library.RegisteredObject oref, _.Library.Integer key, _.Library.String id)
	Starting from, but not including, location key,. More...
_.Library.RegisteredObject	GetAt (_.Library.Integer key)
	Finds and returns the OREF value referring to the object at position. More...
_.Library.RegisteredObject	GetNext (_.Library.Integer key)
	Finds and returns the OREF value referring to the object at the position after key More...
_.Library.ObjectIdentity	GetObjectAt (_.Library.Integer key, _.Library.Integer force)
	Finds and returns the OID value referring to the object at position. More...
_.Library.String	GetObjectIdAt (_.Library.Integer key, _.Library.Integer force)
	Finds and returns the ID value referring to the object at position. More...
_.Library.String	GetObjectIdNext (_.Library.Integer key)
	Finds and returns the ID value referring to the object at the position after key More...
_.Library.String	GetObjectIdPrevious (_.Library.Integer key)
	Finds and returns the ID value referring to the object at the position before key More...
_.Library.ObjectIdentity	GetObjectNext (_.Library.Integer key)
	Finds and returns the OID value referring to the object at the position after key More...
_.Library.ObjectIdentity	GetObjectPrevious (_.Library.Integer key)
	Finds and returns the OID value referring to the object at the position before key More...
_.Library.RegisteredObject	GetPrevious (_.Library.Integer key)
	Finds and returns the OREF value referring to the object at the position before key More...
_.Library.Status	Insert (_.Library.RegisteredObject oref)
	Inserts an element with OREF value oref at the end of the list. More...
_.Library.Status	InsertAt (_.Library.RegisteredObject oref, _.Library.Integer key)
	Inserts an element with OREF value oref at position key. More...
_.Library.Status	InsertObject (_.Library.ObjectIdentity oid)
	Inserts an element with OID value oid at the end of the list. More...
_.Library.Status	InsertObjectAt (_.Library.ObjectIdentity oid, _.Library.Integer key)
	Inserts an element with OID value oid at position key. More...
_.Library.Status	InsertObjectId (_.Library.String id)
	Inserts an element with ID value id at the end of the list. More...
_.Library.Status	InsertObjectIdAt (_.Library.String id, _.Library.Integer key)
	Inserts an element with ID value id at position key. More...
_.Library.Boolean	IsDefined (_.Library.Integer key)
	Returns true (1) if a value is defined at location key,. More...
_.Library.Integer	Next (_.Library.Integer key)
	Finds and returns the index value of the element at the location following key in the list. More...
_.Library.Integer	Previous (_.Library.Integer key)
	Finds and returns the index value of the element at the location preceding key in the list. More...
_.Library.ObjectIdentity	RemoveAt (_.Library.Integer key, _.Library.Boolean success)
	Removes the element at position key in the list. More...
_.Library.Status	SetAt (_.Library.RegisteredObject oref, _.Library.Integer key)
	Sets the OREF value of the element at position key to oref. More...
_.Library.Status	SetObjectAt (_.Library.ObjectIdentity oid, _.Library.Integer key)
	Sets the OID value of the element at position key to oid. More...
_.Library.Status	SetObjectIdAt (_.Library.String id, _.Library.Integer key)
	Sets the ID value of the element at position key to id. More...
Public Member Functions inherited from AbstractList
_.Library.Status	Clear ()
	Clears the contents of the list. More...
_.Library.String	Find (_.Library.RawString element, _.Library.Integer key)
	Starting from, but not including, position key, Find finds. More...
_.Library.Status	Insert (_.Library.RawString element)
	Inserts an element with value element at the end of the list. More...
_.Library.Status	InsertAt (_.Library.RawString element, _.Library.Integer key)
	Inserts an element with value element at position key. More...
_.Library.Status	InsertList (_.Library.RawString inslist)
	Inserts a list with value inslist at the end of the list. More...
_.Library.Status	InsertOrdered (_.Library.RawString element)
	Inserts an element with value element into the list at the correct ordered. More...
_.Library.RawString	RemoveAt (_.Library.Integer key)
	Removes the element at position key in the list. More...
_.Library.Status	SetAt (_.Library.RawString element, _.Library.Integer key)
	Sets the value of the element at position key to element. More...
Public Member Functions inherited from AbstractIterator
_.Library.RawString	GetAt (_.Library.RawString key)
	Definition of iterator methods that all our collections classes use to ensure consistency. More...
_.Library.RawString	GetNext (_.Library.RawString key)
	Finds and returns the value of the element at the location after key More...
_.Library.RawString	Next (_.Library.RawString key)
	Finds and returns the key value of the element at the location following key in the iteration. More...
Public Member Functions inherited from Super
_.Library.Status	Clear ()
	Clears the contents of the array. More...
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...

Additional Inherited Members
Static Public Member Functions inherited from AbstractList
_.Library.Status	BuildValueArray (_.Library.Binary serialized, _.Library.Binary array)
	Constructs array(key)=value for each element in the serialval value. More...
_.Library.String	LogicalToOdbc (_.Library.String val, _.Library.String delim, _.Library.String class, _.Library.String method)
	Converts the serial state of this list object to a delimited string. More...
_.Library.String	OdbcToLogical (_.Library.String val, _.Library.String delim, _.Library.String class, _.Library.String method)
	Converts the value of an incoming delimited string to a serialized state. More...
Public Attributes inherited from ListOfObj
	Size
	Size is the number of elements contained in the list. More...
Public Attributes inherited from Super
	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 inherited from ListOfObj
	IdCollection = None
	If true then in the container we have an array of id's rather than an array of oid's.
Static Public Attributes inherited from Super
	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...

Detailed Description

A version of the <CLASS>Collection.ListOfObj</CLASS> collection class that stores class names in OIDs.

These Collection classes can only be used when you have a collection property of another object as they rely on storing the data inside the parent object, they can not be used as 'stand alone' collections, for this use the <class>ListOfObjectsWithClassName</class>.

Member Function Documentation

Find()

_.Library.String Find	(	_.Library.ObjectIdentity	element,
		_.Library.Integer	key
	)

Starting from, but not including, position key, Find finds.

the next element in the list whose OID value equals element. If key is a null string, Find starts at the beginning of the list.

Find returns the position of the found element or null string ("") if no element was found.

Reimplemented from ListOfObj.