Chat now with support
Chat with Support

Foglight 7.1.0 - Web Component Tutorial

Introducing the Web Component Framework The Web Component Framework Configuring Views and Context Queries Functions Bindings Additional Components

Enumeration Types

Enumeration values can be specified for Enumeration types.

At least one enum value must be defined. The following attributes may be set:

Value: The value that represents the enum value
Name: The display name of the enum value. The value specified in the editor is used as the value for the base locale.
Description: The description of the enum value. The value specified in the editor is used as the value for the base locale.

Creating a Data Object of your Type

Instances of your type are created in one of the following ways:

In JavaTM or Groovy WCF via the FunctionHelper’s createDataObject() method.

Parameters to the creation mechanism are:

Type: The type you want to create. You can only select from Data Object types (not including Enum types) from the Common Data Source or other UI Types.
Storage: This is the persistence mechanism to use to “save” this object. The create method will try to load this object from the storage mechanism specified and create a new instance of it if it does not exist.
None: This object cannot be stored and is meant to be transitory (used on the page or passed through the context).
Site: Enables the object to be stored in a global location that is accessible to all users. If multiple users are changing the object at once from different sessions then the last copy of the object saved will be persisted.
User: This object is stored per user so that each user has a different copy of this object. This is useful to remember a user’s particular choices.
Session: This object is stored in the user’s http session. Calling save is not necessary to persist changes, since the single live instance is stored in a session-owned cache. The object is released when the user logs out or the object’s remove method is called.
Object ID: It should use the form XXXXX-YYYYY, where:
XXXXX is your domain identifier. For example, java, oracle, ops, admin
YYYYY is the identifier for the object. For example preferences, socFilter, etc.

An object that is created from scratch has all of its properties set to their default values.

Objects created using this mechanism are not time range sensitive.

Objects loaded from the Site and User Storage mechanisms are always loaded from the store and not persisted in any cache other than the Web Component Framework page context if they are used within it. Note that these object are not in Web Component Framework pages in the same way that Topology objects are.


Data Objects created through this mechanism are considered equal if their uniqueIds are equal.

Saving Data Objects

Changes to an object are persisted when the object is acted upon by calling the object’s save()method or by using the WCF/Common/Save Data Object function to do this for you.

An object that has not been created with a storage mechanism of either Site, User, or Session cannot be saved.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating