javascript::IlsRpObject Class Reference

The base class for any representation object. More...

#include <javascript/clientside.h>

Public Member Functions
void	execCallback (String callbackName,...)
	Calls a user-defined callback on the server. More...
IlsRepresentation	getRepresentation ()
	Returns the representation that owns the current representation object. More...
void	openView (String viewName, Boolean force=false,...)
	Opens a new view named viewName with the current representation object as its origin. You can pass up to 10 String arguments to this method. More...
void	setRpStatus (Int value)
	Sets the rpStatus attribute associated with the representation object. More...

Detailed Description

The base class for any representation object.

This class defines a generic object API underlying the interaction protocol between a dynamic server and application components.

Warning

This class is a JavaScript class, not a C++ one.

See also

IlsRepresentation (JavaScript), IlsRpObject (C++).

Member Function Documentation

execCallback()

void javascript::IlsRpObject::execCallback	(	String	callbackName,
			...
	)

Calls a user-defined callback on the server.

Example

rpobj.execCallback("mycallback", 1, obj.name);

Parameters

callbackName	callback name
...	The arguments callbackArg1 to callbackArg10 are optional. They are converted into an array of IlsMvValue and passed to the user-defined callback on the server. All optional callback arguments must be entered as strings, which will be converted to the correct type when used.

getRepresentation()

IlsRepresentation javascript::IlsRpObject::getRepresentation

(

)

Returns the representation that owns the current representation object.

Returns

the representation that owns the current representation object.

openView()

void javascript::IlsRpObject::openView	(	String	viewName,
		Boolean	force = false,
			...
	)

Opens a new view named viewName with the current representation object as its origin. You can pass up to 10 String arguments to this method.

Parameters

viewName	view name
force	true if you want to force to reopen a already opened view.
...	up to 10 String arguments

setRpStatus()

void javascript::IlsRpObject::setRpStatus

(

Int

value

)

Sets the rpStatus attribute associated with the representation object.

Example

rpobj.setRpStatus(2);

Parameters

value

value to set to the rpStatus attribute