[This is preliminary documentation and is subject to change.]
This class represents a full reference to an object whose original
is in a foreign domain.
Declaration Syntax| C# |
public class ForeignReference : IReference
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | Class | Gets the ObjectClass to which the
object referenced by this ForeignReference belongs. |
| Database | Gets the Database on which the local
copy of the object referenced by this ForeignReference is stored.
|
 | DeReference(Persistent) |
Dereferences this ForeignReference to get the referenced object.
|
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| IsForeign |
Always returns true.
|
| IsPersisted | Gets a value indicating whether a local copy of the object has
been persisted to a local database. |
| IsProvisional | Gets a value indicating whether any local copy of the object is
still provisional - has not been persisted to a local database. |
| IsRetrieved |
Determines whether the object referenced by this ForeignReference has a
local copy.
|
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| ObjectNumber | Gets the object number from the object's local Reference. This identifies an object within its
database and class. |
| OwningDomain | Gets the Domain to which the object
referenced by this ForeignReference belongs. |
 | ReadFromMessage(Message) | Recreates a ForeignReference from serialised data in a Message. |
| SaveToMessage(Message) | Serialises this ForeignReference to a message. |
| ToReference()()()() | Creates a Reference to the object
referenced by this object. |
| ToString()()()() | (Inherited from Object.) |
RemarksThis class can reference the original as well as the local copy. The object referenced by this ForeignReference may or may not have a local copy of the object. However, if it does not, then the localCopy reference, must have at least the domain number (in the same field as the database number for standard references)
THIS CLASS IS NOT YET OPERATIONAL
Inheritance Hierarchy| Object | |
 | ForeignReference |