 | RpObject Methods |
The RpObject type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AckAttrUpdate |
Is called by BeginS2CTransaction(S2CTransactionStatus, Int32)
(if this object is involved in the transaction) for each attribute involved in the
server to component transaction - except if the transaction has been
aborted.
If a notification cycle or an asynchronous rollback is performed, the attribute is actually modified if and only if this method returns true. |
 | AckOpenView |
This function is called by Rogue Wave Server in order to acknowledge or
rollback a view opening performed with the acknoledged openView
method.This function has an empty implementation and can be overriden.
|
| AfterInit |
Called immediately after an object has been created when
a representation object is instantiated by the server.
|
| BeforeDeletion |
Called between the beginS2CUpdate and the endS2CUpdate in
the transaction that delete the RpObject.
|
| BeginC2SUpdate |
Initializes a buffer for updates on representation objects.
|
| BeginS2CUpdate |
Called by the transaction mechanism if this object is
involved.
|
| Deletion |
This hook method is called when the object is "deleted".
When the component receives the order of deletion or when the garbage collector reclaims the object. |
| DiscardC2SUpdate |
Discards the modifications stored in the update
buffer.
|
| EndC2SUpdate |
Commits the updates performed on the representation object
by flushing the update buffer.
|
| EndS2CUpdate |
Is called automatically once the server has finished
updating a representation object after a server component transaction.
This method is empty. |
| ExecAsyncCallback |
This function executes a given function in asynchronous mode on the
Server object associated with the representation object.
|
| ExecCallback |
This function executes a given function in asynchronous mode on the
Server object associated with the representation object.
|
| ExecDuplexCallback |
This callback executes an asynchronous call to the funName
function on the Server object associated with the representation object.
The result of the function is sent back to the caller through a call to
the duplex global function duplexFunName.
|
| ExecSyncCallback |
This function executes a given function in synchronous mode on the Server
object associated with the representation object.
|
| Finalize |
Performs finalization.
(Overrides ObjectFinalize.) |
| GetAttributeId(String) |
Gets the attribute identifier corresponding to the
attribute label.
|
| GetAttributeId(String, Int32) |
Gets the attribute identifier corresponding to an indexed
attribute label.
|
| GetAttributeKind |
Gets the type identifier of an attribute attached to this
representation object.
|
 | ILS_RP_ATTR_BOOLEAN |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_CHAR |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_DOUBLE |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_FLOAT |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_HREF |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_INT |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_LONG |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_MVVALUE |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_REF(String, String, String) |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_REF(String, String, String, String) |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_STRING |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_ATTR_USERTYPE |
Defines an attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_DEFAULT_ATTR_BOOLEAN |
Defines default boolean attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_CHAR |
Defines default char attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_DOUBLE |
Defines default double attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_FLOAT |
Defines default float attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_INT |
Defines default int attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_LONG |
Defines default long attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_MVVALUE |
Defines default MvValue attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_REF |
Defines default ref attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_STRING |
Defines default string attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_ATTR_USERTYPE |
Defines default usertype attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_BOOL |
Defines default indexed boolean attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_CHAR |
Defines default indexed char attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_DOUBLE |
Defines default indexed double attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_FLOAT |
Defines default indexed float attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_INT |
Defines default indexed int attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_LONG |
Defines default indexed long attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_MVVALUE |
Defines default indexed MvValue attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_REF |
Defines default indexed ref attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_STRING |
Defines default indexed string attribute accessor accName
to the class clName.
|
| ILS_RP_DEFAULT_INDEXED_ATTR_USERTYPE |
Defines default indexed usertype attribute accessor accName
to the class clName.
|
| ILS_RP_INDEXED_ATTR_BOOLEAN |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_CHAR |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_DOUBLE |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_FLOAT |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_HREF |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_INT |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_LONG |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_MVVALUE |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_REF |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_STRING |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| ILS_RP_INDEXED_ATTR_USERTYPE |
Defines an indexed attribute attrName to the class clName
with accessor accName.
|
| IsEditable |
Indicates if an attribute is editable.
|
| IsMatchingHRef |
This function tests whether the id attribute can be assigned a given
hyper-reference. More specifically, it checks whether the update might
impair the type integrity of the server.
|
| IsMatchingRef |
This function tests whether the id attribute can be
assigned the value of the object. More specifically, it checks whether
the update might impair the type integrity of the server.
|
| OnAddToCollection |
This method should be called each time the application component adds a
representation object to the object collection. It allows the server to
be notified about this modification.
|
| OnDereference(Int32, MvValue, Boolean) |
This method lets you open a view by dereferencing a hyper-reference (see
"Semantics of Dynamic View Type Specifications").
|
| OnDereference(Int32, MvValue, MvValue, Int32, Boolean) |
Lets you open a view by dereferencing a hyper-reference (see
"Semantics of Dynamic View Type Specifications").
|
| OnNullifyRef |
Should be called when the application component needs to
reset the id reference attribute to null. It allows the
server to be notified about this modification.
|
| OnRmFromCollection |
This method should be called every time the application component removes
a representation object from a given collection of objects.
|
| OnRmRepresentation |
Called when the representation that owns the representation object is destroyed.
This function can be overridden. |
| OnSuppress |
Notifies the server about the destruction of this
representation object.
|
| OnUpdate(Int32, Object) |
Should be called when the application component needs to
set the value of an attribute. It allows the server to be notified about
this modification.
|
| OnUpdate(Int32, RpObject, Int32) |
Called when the application component needs to replace
the target object of a server relation.
|
| OpenView(String, MvValue, Boolean) |
Requests the server to open a view on the server object
associated with this representation object.
|
| OpenView(String, MvValue, MvValue, Int32, Boolean) |
Requests the server to open a view on the server object
associated with this representation object.
|
| SetAny |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetAttributeValue |
This function sets the value of an attribute when no modifier is found.
The default behavior consists in using the mechanism associated with the ILS_RP_DEFAULT_XXX set of macros. This function can be redefined, especially if you use another mapping. |
| SetBoolean |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetChar |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetConstAttribute |
Sets the value of a constant attribute for a representation
object.
|
| SetConstAttributes |
Sets the value of the constant attributes of a
representation object.
|
| SetDouble |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetFloat |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetHRef |
Called by the server to set the value this attribute when it
has no associated modifier.
|
| SetLong |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetMvValue |
Called by the server to set the value this attribute when it
has no associated modifier.
|
| SetReference |
Called by the server to set the value this attribute when it
has no associated modifier.
|
| SetShort |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetString |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetUserTypeValue |
Called by the server to set the value this attribute when it has no
associated modifier.
|
| SetValue |
This function is called by the server to set the value of this attribute
when it has no associated modifier.
|
| TestCollection |
This method tests whether the representation object can be added to a
given collection of objects.
|
| ToString |
Returns a string representation of this instance.
(Overrides ObjectToString.) |
See Also