Inheritance diagram for ListOfObjects:

[legend]

Collaboration diagram for ListOfObjects:

[legend]

Public Member Functions
_.Library.Status	OnConstructClone (_.Library.RegisteredObject oref, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	Clear ()
	Clears the contents of the array. More...

_.Library.Integer	Count ()
	Returns the number of elements contained in the list.

_.Library.String	Find (_.Library.ObjectIdentity element, _.Library.Integer key)
	Starting from, but not including, position key, Find finds. More...

_.Library.String	FindObjectId (_.Library.String id, _.Library.Integer key)
	Starting from, but not including, position key, FindObjectId finds. 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	InsertList (_.Library.RawString inslist)
	Inserts a list with value inslist at the end of the list. 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.Status	InsertOrdered (_.Library.RawString element)
	Inserts an element with value element into the list at the correct ordered. 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 AbstractListOfObj
_.Library.String	Find (_.Library.ObjectIdentity element, _.Library.Integer key)
	A list collection represents a list of data type elements, each of which is associated with a numeric position in the list. More...

_.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 value of the element at position. More...

_.Library.RegisteredObject	GetNext (_.Library.Integer key)
	Finds and returns the value of the element 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 value of the element at the position before key More...

_.Library.Status	Insert (_.Library.RegisteredObject element)
	Inserts an element with value element at the end of the list. More...

_.Library.Status	InsertAt (_.Library.RegisteredObject element, _.Library.Integer key)
	Inserts an element with value element 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.ObjectIdentity	RemoveAt (_.Library.Integer key, _.Library.Boolean success)
	Removes the element at position key in the list. More...

_.Library.Status	SetAt (_.Library.RegisteredObject element, _.Library.Integer key)
	Sets the value of the element at position key to element. 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.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.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.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 SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. 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	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...

Static Public Member Functions
_.Library.Status	BuildValueArray (_.Library.Binary serialized, _.Library.Binary array)
	Constructs array(key)=value for each element in the serialval value. More...

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...

Static Public Member Functions inherited from SerialObject
_.Library.String	LogicalToOdbc (_.Library.String val)
	Converts the serial state of this serial object to a delimited string. More...

_.Library.String	OdbcToLogical (_.Library.String val)
	Converts the value of an incoming delimited string to a serialized state. More...

Public Attributes
	Data
	Data is a private property used to hold the contents of the list. More...

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

	Oref
	Private storage area used to hold OREF values. More...

	Size
	Size is the number of elements contained in the list. More...

Static Public Attributes
	CLASSNAMEINOID = None
	This parameter determines how the collection object stores OID values. More...

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

Static Public Attributes inherited from SerialObject
	ODBCDELIMITER = None
	A serial object is converted to a delimited string containing the. More...

	SERIALDELIMITER = None
	This parameter specifies the delimiter character used when created a serialized. More...

	VALIDIFNULL = None
	If true, ValidateObject will return $$$OK for instances that are null as determined by IsNull(). More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT 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	AddToSaveSet (_.Library.Integer force, _.Library.Integer refresh)
	Overrides SerialObject implementation. More...

_.Library.Status	SerializeObject (_.Library.Binary serial, _.Library.Integer partial)
	This method retrieves all of the serial values for referenced objects and places them into the instance variables,. More...

_.Library.Status	UnSwizzleAt (_.Library.Integer key, _.Library.Integer force)
	Unswizzles (removes from memory) the individual element at position key in the list. More...

Detailed Description

For information on this class, see Working with Collections.

The <CLASS>ListOfObjects</CLASS> class represents a list of references to objects, each of which is associated with a numeric position in the list. The first element in the list is stored at position 1. The objects referred to must be registered. They can be either persistent objects or non-id objects.

Internally, a <CLASS>ListOfObjects</CLASS> object contains two lists: one for holding the OID values for the objects referred to (or their serialized state in the case of a list of non-id objects); and another for holding the OREF values for any objects that have been explicitly referred to, and hence "swizzled" into memory. Swizzling (loading an object into memory and generating an OREF value for it) happens automatically whenever the user refers to an object within the list. For example, if list is an <CLASS>ListOfObjects</CLASS> object containing a list of Doctor objects (that is a list of OID values for Doctor objects stored in the database) then the following code fragment will automatically load the Doctor object at location 7 in the list into memory and generate an OREF value referring to the in-memory version of the Doctor object. This OREF value can then be used to access the properties and methods of the Doctor object:

Set doc=list.GetAt(7) Write doc.Name

Alternatively, we could use cascading dot syntax:

Set name=list.GetAt(7).Name

When the <CLASS>ListOfObjects</CLASS> object is closed (removed from memory) it will close (call Close on) all the references it has swizzled into memory. These classes can be used 'standalone' to store a collection.

Member Function Documentation

◆ AddToSaveSet()

_.Library.Status AddToSaveSet	(	_.Library.Integer	force,
		_.Library.Integer	refresh
	)

private

Overrides SerialObject implementation.

Scans objects for modifications in the related list (Element)

and the terminated relationship list (DeleteOref). Modified/Scheduled to delete objects are added to the save graph.

Reimplemented from RegisteredObject.

◆ OnConstructClone()

_.Library.Status OnConstructClone	(	_.Library.RegisteredObject	object,
		_.Library.Boolean	deep,
		_.Library.String	cloned
	)

This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to.

provide notification that a clone of an object is being created. It passes in the oref of the object that was cloned in object.

If this method returns an error then the object will not be created.

Reimplemented from RegisteredObject.

◆ SerializeObject()

_.Library.Status SerializeObject	(	_.Library.Binary	serial,
		_.Library.Integer	partial
	)

private

This method retrieves all of the serial values for referenced objects and places them into the instance variables,.

Validates, Normalizes, and serializes the object (with a save of the persistent image if persistent).
This method is not meant to be called directly. It is called by Save and by GetSwizzleObject.

Reimplemented from RegisteredObject.

◆ UnSwizzleAt()

_.Library.Status UnSwizzleAt	(	_.Library.Integer	key,
		_.Library.Integer	force
	)

private

Unswizzles (removes from memory) the individual element at position key in the list.

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

◆ BuildValueArray()

_.Library.Status BuildValueArray	(	_.Library.Binary	serialized,
		_.Library.Binary	array
	)

static

Constructs array(key)=value for each element in the serialval value.

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

◆ Clear()

_.Library.Status Clear ( )

Clears the contents of the array.

Both the OID and OREF values are cleared.

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

Reimplemented from AbstractList.

◆ 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.

◆ FindObjectId()

_.Library.String FindObjectId	(	_.Library.String	id,
		_.Library.Integer	key
	)

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

the next element in the list whose ObjectId equals id. 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.

◆ GetAt()

_.Library.RegisteredObject GetAt ( _.Library.Integer key )

Finds and returns the OREF value referring to the object at position.

key in the list.

GetAt returns the value of the element at location key or null string ("") if no element is found.

◆ GetNext()

_.Library.RegisteredObject GetNext ( _.Library.Integer key )

Finds and returns the OREF value referring to the object at the position after key

in the list. If key is a null string (""), it returns the OREF value of the first element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the end of the list.

◆ GetObjectAt()

_.Library.ObjectIdentity GetObjectAt	(	_.Library.Integer	key,
		_.Library.Integer	force
	)

Finds and returns the OID value referring to the object at position.

key in the list.

Returns the value of the element at location key or null string ("") if no element is found.

◆ GetObjectIdAt()

_.Library.String GetObjectIdAt	(	_.Library.Integer	key,
		_.Library.Integer	force
	)

Finds and returns the ID value referring to the object at position.

key in the list.

Returns the value of the element at location key or null string ("") if no element is found.

◆ GetObjectIdNext()

_.Library.String GetObjectIdNext ( _.Library.Integer key )

Finds and returns the ID value referring to the object at the position after key

in the list. If key is a null string (""), it returns the ID value of the first element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the end of the list.

◆ GetObjectIdPrevious()

_.Library.String GetObjectIdPrevious ( _.Library.Integer key )

Finds and returns the ID value referring to the object at the position before key

in the list. If key is a null string (""), it returns the ID value of the last element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the beginning of the list.

◆ GetObjectNext()

_.Library.ObjectIdentity GetObjectNext ( _.Library.Integer key )

Finds and returns the OID value referring to the object at the position after key

in the list. If key is a null string (""), it returns the OID value of the first element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the end of the list.

◆ GetObjectPrevious()

_.Library.ObjectIdentity GetObjectPrevious ( _.Library.Integer key )

Finds and returns the OID value referring to the object at the position before key

in the list. If key is a null string (""), it returns the OID value of the last element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the beginning of the list.

◆ GetPrevious()

_.Library.RegisteredObject GetPrevious ( _.Library.Integer key )

Finds and returns the OREF value referring to the object at the position before key

in the list. If key is a null string (""), it returns the OREF value of the last element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the beginning of the list.

◆ Insert()

_.Library.Status Insert ( _.Library.RegisteredObject oref )

Inserts an element with OREF value oref at the end of the list.

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

◆ InsertAt()

_.Library.Status InsertAt	(	_.Library.RegisteredObject	oref,
		_.Library.Integer	key
	)

Inserts an element with OREF value oref at position key.

<p>To make room for the new element, the elements previously at or following position 
<var>key</var> are moved up by one position.
<p><var>key</var> must be in the following range:<br>
<p>
1 &lt;= index &lt;= Count() + 1
<br>
<p>
Returns a <CLASS>%Status</CLASS> value indicating success or failure.

◆ InsertList()

_.Library.Status InsertList ( _.Library.RawString inslist )

Inserts a list with value inslist at the end of the list.

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

◆ InsertObject()

_.Library.Status InsertObject ( _.Library.ObjectIdentity oid )

Inserts an element with OID value oid at the end of the list.

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

◆ InsertObjectAt()

_.Library.Status InsertObjectAt	(	_.Library.ObjectIdentity	oid,
		_.Library.Integer	key
	)

Inserts an element with OID value oid at position key.

<p>To make room for the new element, the elements previously at or following position 
<var>key</var> are moved up by one position.
<p><var>key</var> must be in the following range:<br>
<p>
1 &lt;= index &lt;= Count() + 1
<br>
<p>
Returns a <CLASS>%Status</CLASS> value indicating success or failure.

◆ InsertObjectId()

_.Library.Status InsertObjectId ( _.Library.String id )

Inserts an element with ID value id at the end of the list.

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

◆ InsertObjectIdAt()

_.Library.Status InsertObjectIdAt	(	_.Library.String	id,
		_.Library.Integer	key
	)

Inserts an element with ID value id at position key.

<p>To make room for the new element, the elements previously at or following position 
<var>key</var> are moved up by one position.
<p><var>key</var> must be in the following range:<br>
<p>
1 &lt;= index &lt;= Count() + 1
<br>
<p>
Returns a <CLASS>%Status</CLASS> value indicating success or failure.

◆ InsertOrdered()

_.Library.Status InsertOrdered ( _.Library.RawString element )

Inserts an element with value element into the list at the correct ordered.

position. The elements in the list are shifted to accommodate the new element as necessary.

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

◆ Next()

_.Library.Integer Next ( _.Library.Integer key )

Finds and returns the index value of the element at the location following key in the list.

If key is a null string (""), then Next returns the position of the first element in the list (1).

◆ Previous()

_.Library.Integer Previous ( _.Library.Integer key )

Finds and returns the index value of the element at the location preceding key in the list.

If key is a null string (""), then Next returns the position of the last element in the list.

◆ RemoveAt()

_.Library.ObjectIdentity RemoveAt	(	_.Library.Integer	key,
		_.Library.Boolean	success
	)

Removes the element at position key in the list.

The elements following position key are moved to fill in the resulting gap.

RemoveAt returns the OID value of the removed element or null string ("") if no element was removed. It also has a success output argument that returns true if the item was removed and false if it was not.

◆ SetAt()

_.Library.Status SetAt	(	_.Library.RegisteredObject	oref,
		_.Library.Integer	key
	)

Sets the OREF value of the element at position key to oref.

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

◆ SetObjectAt()

_.Library.Status SetObjectAt	(	_.Library.ObjectIdentity	oid,
		_.Library.Integer	key
	)

Sets the OID value of the element at position key to oid.

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

◆ SetObjectIdAt()

_.Library.Status SetObjectIdAt	(	_.Library.String	id,
		_.Library.Integer	key
	)

Sets the ID value of the element at position key to id.

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

Member Data Documentation

◆ CLASSNAMEINOID

CLASSNAMEINOID = None

static

This parameter determines how the collection object stores OID values.

If this parameter is set to 0, then partially-formed OID values, containing only an ID number, are used. If this parameter is set to 1, then fully-formed OID values, containing both a class name and an ID number, are used.

◆ Data

Data

Data is a private property used to hold the contents of the list.

◆ ElementType

ElementType

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

◆ Oref

Oref

Private storage area used to hold OREF values.

◆ Size

Size

Size is the number of elements contained in the list.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ AddToSaveSet()

◆ OnConstructClone()

◆ SerializeObject()

◆ UnSwizzleAt()

◆ BuildValueArray()

◆ Clear()

◆ Find()

◆ FindObjectId()

◆ GetAt()

◆ GetNext()

◆ GetObjectAt()

◆ GetObjectIdAt()

◆ GetObjectIdNext()

◆ GetObjectIdPrevious()

◆ GetObjectNext()

◆ GetObjectPrevious()

◆ GetPrevious()

◆ Insert()

◆ InsertAt()

◆ InsertList()

◆ InsertObject()

◆ InsertObjectAt()

◆ InsertObjectId()

◆ InsertObjectIdAt()

◆ InsertOrdered()

◆ Next()

◆ Previous()

◆ RemoveAt()

◆ SetAt()

◆ SetObjectAt()

◆ SetObjectIdAt()

Member Data Documentation

◆ CLASSNAMEINOID

◆ Data

◆ ElementType

◆ Oref

◆ Size