Representation Class |
Namespace: RW.Server.Component
The Representation type exposes the following members.
Name | Description | |
---|---|---|
Representation |
Initializes a new Representation instance.
|
Name | Description | |
---|---|---|
Closed |
Gets a value that indicates if a representation is closed.
| |
Component |
Gets a reference to the dynamic representation
model associated with this representation.
| |
InC2STransaction |
Gets a value that indicates if this representation is being
updated by the component.
| |
InS2CTransaction |
Gets a value that indicates if the representation is being
updated by a server.
| |
Label |
Gets the label of the representation object.
(Inherited from RpObject.) | |
Objects |
Gets all the representation objects owned by this
representation.
| |
Reference |
Gets a reference which identifies this representation
object in the server/component protocol.
(Inherited from RpObject.) | |
Representation |
Gets the owning representation.
(Inherited from RpObject.) | |
RepresentationId |
Gets or sets the representation identifier.
| |
RpModel |
Gets a reference to the dynamic representation
model associated with this representation.
| |
RpObjectId |
Gets the representation object identifier.
(Inherited from RpObject.) | |
RpObjModel |
Gets the runtime representation object model associated with
this representation object.
(Inherited from RpObject.) | |
RpStatus |
Requests modification of the representation status of the server
object associated with the representation object in the view to
which the representation is attached.
(Inherited from RpObject.) |
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.
(Inherited from RpObject.)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.
(Inherited from RpObject.) | |
AddOrigin |
Requests that the server add the server object associated with
a representation object as an origin of the view associated to
the corresponding representation.
| |
AfterInit |
Called immediately after an object has been created when
a representation object is instantiated by the server.
(Inherited from RpObject.) | |
BeforeDeletion |
Called between the beginS2CUpdate and the endS2CUpdate in
the transaction that delete the RpObject.
(Inherited from RpObject.) | |
BeginC2STransaction |
Lets you create a transaction buffer where the modifications
performed and/or required by the application component are
stored before they are sent to the server.
| |
BeginC2SUpdate |
Initializes a buffer for updates on representation objects.
(Inherited from RpObject.) | |
BeginS2CTransaction |
Called by BeginS2CTransaction(S2CTransactionStatus, Int32) on
each representation involved in a server-to-component
transaction.
| |
BeginS2CUpdate |
Called by the transaction mechanism if this object is
involved.
(Inherited from RpObject.) | |
Close |
Requests the view associated with the representation to be
closed.
| |
CommitC2STransaction |
Commits a transaction.
| |
DeleteRpObject |
Deletes representation objects.
| |
Deletion |
This hook method is called when the object is "deleted".
(Inherited from RpObject.)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.
(Inherited from RpObject.) | |
EndC2SUpdate |
Commits the updates performed on the representation object
by flushing the update buffer.
(Inherited from RpObject.) | |
EndS2CTransaction |
Called at the end of a server-to-component transaction
applying to the representation. This default implementation is
empty.
| |
EndS2CUpdate |
Is called automatically once the server has finished
updating a representation object after a server component transaction.
(Inherited from RpObject.)This method is empty. | |
ExecAsyncCallback |
This function executes a given function in asynchronous mode on the
Server object associated with the representation object.
(Inherited from RpObject.) | |
ExecCallback |
This function executes a given function in asynchronous mode on the
Server object associated with the representation object.
(Inherited from RpObject.) | |
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.
(Inherited from RpObject.) | |
ExecSyncCallback |
This function executes a given function in synchronous mode on the Server
object associated with the representation object.
(Inherited from RpObject.) | |
Finalize |
Performs finalization.
(Inherited from RpObject.) | |
GetAttributeId(String) |
Gets the attribute identifier corresponding to the
attribute label.
(Inherited from RpObject.) | |
GetAttributeId(String, Int32) |
Gets the attribute identifier corresponding to an indexed
attribute label.
(Inherited from RpObject.) | |
GetAttributeKind |
Gets the type identifier of an attribute attached to this
representation object.
(Inherited from RpObject.) | |
GetObject |
Gets the representation object identified by
an identifier.
| |
IsEditable |
Indicates if an attribute is editable.
(Inherited from RpObject.) | |
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.
(Inherited from RpObject.) | |
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.
(Inherited from RpObject.) | |
NewRpObject |
Creates representation objects.
| |
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.
(Inherited from RpObject.) | |
OnDereference(Int32, MvValue, Boolean) |
This method lets you open a view by dereferencing a hyper-reference (see
"Semantics of Dynamic View Type Specifications").
(Inherited from RpObject.) | |
OnDereference(Int32, MvValue, MvValue, Int32, Boolean) |
Lets you open a view by dereferencing a hyper-reference (see
"Semantics of Dynamic View Type Specifications").
(Inherited from RpObject.) | |
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.
(Inherited from RpObject.) | |
OnRmFromCollection |
This method should be called every time the application component removes
a representation object from a given collection of objects.
(Inherited from RpObject.) | |
OnRmRepresentation |
Called when the representation that owns the representation object is destroyed.
(Inherited from RpObject.)This function can be overridden. | |
OnSuppress |
Notifies the server about the destruction of this
representation object.
(Inherited from RpObject.) | |
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.
(Inherited from RpObject.) | |
OnUpdate(Int32, RpObject, Int32) |
Called when the application component needs to replace
the target object of a server relation.
(Inherited from RpObject.) | |
OpenView(String, MvValue, Boolean) |
Requests the server to open a view on the server object
associated with this representation object.
(Inherited from RpObject.) | |
OpenView(String, MvValue, MvValue, Int32, Boolean) |
Requests the server to open a view on the server object
associated with this representation object.
(Inherited from RpObject.) | |
RemoveOrigin |
Requests the server to remove the server object associated with
a representation object as an origin of the view associated with
this corresponding representation.
| |
ResetBufferMode |
Resets the buffer-mode state on the
represented view.
| |
RollbackC2STransaction |
Rolls back a transaction that applies to a representation by
sending an asynchronous request to the object server.
| |
SetAny |
Called by the server to set the value this attribute when it has no
associated modifier.
(Inherited from RpObject.) | |
SetAttributeValue |
This function sets the value of an attribute when no modifier is found.
(Inherited from RpObject.)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.
(Inherited from RpObject.) | |
SetBufferMode |
Sets the represented view buffer mode.
| |
SetChar |
Called by the server to set the value this attribute when it has no
associated modifier.
(Inherited from RpObject.) | |
SetConstAttribute |
Sets the value of a constant attribute for a representation
object.
(Inherited from RpObject.) | |
SetConstAttributes |
Sets the value of the constant attributes of a
representation object.
(Inherited from RpObject.) | |
SetDouble |
Called by the server to set the value this attribute when it has no
associated modifier.
(Inherited from RpObject.) | |
SetFloat |
Called by the server to set the value this attribute when it has no
associated modifier.
(Inherited from RpObject.) | |
SetHRef |
Called by the server to set the value this attribute when it
has no associated modifier.
(Inherited from RpObject.) | |
SetLong |
Called by the server to set the value this attribute when it has no
associated modifier.
(Inherited from RpObject.) | |
SetMainOrigin |
Requests the server to set the server object associated with the
given representation object as the main origin of the view
associated with this representation.
| |
SetMvValue |
Called by the server to set the value this attribute when it
has no associated modifier.
(Inherited from RpObject.) | |
SetReference |
Called by the server to set the value this attribute when it
has no associated modifier.
(Inherited from RpObject.) | |
SetSelection |
Selection of a representation.
(Overrides RpObject.SetSelection.) | |
SetShort |
Called by the server to set the value this attribute when it has no
associated modifier.
(Inherited from RpObject.) | |
SetString |
Called by the server to set the value this attribute when it has no
associated modifier.
(Inherited from RpObject.) | |
SetUserTypeValue |
Called by the server to set the value this attribute when it has no
associated modifier.
(Inherited from RpObject.) | |
SetValue |
This function is called by the server to set the value of this attribute
when it has no associated modifier.
(Inherited from RpObject.) | |
Synchronize |
Synchronizes the representation and its representation objects
with updates that have been buffered on the view.
See C++ API IlsMvView::synchronize() | |
TestCollection |
This method tests whether the representation object can be added to a
given collection of objects.
(Inherited from RpObject.) | |
ToString |
Returns a string representation of this instance.
(Overrides RpObjectToString.) |
Name | Description | |
---|---|---|
RpObjectCreated |
Event triggered when an RObject has been created.
The event is triggered once the initial updates have been called (just after EndS2CUpdate(S2CTransactionStatus, Int32). | |
RpObjectDeleted |
Event triggered when an RObject has been deleted.
The event is triggered after the call to DeleteRpObject(RpObject) so the object is not supposed to be accessible at this moment. You cannot access the object by accessing a property or calling a method. It can just be used, for instance, to update a container that was containing it. |
It lets you control the transactions between the object server and the application component applying to representation objects. It can be subtyped so as to define runtime attributes that will be used in view specifications.
For each dynamic view, there is one and only one instance of the Representation class or of a derived class.