FrameworkObject Inherited Attributes

The FrameworkObject base class contains attributes that are shared by all framework objects via an inheritance relationship. The FrameworkObject shared attributes can be organized into four groups:

The attributes of the FrameworkObject are described in detail below:

Attribute

Description

appId

Identifier that partitions objects in a repository by application. The purpose of the application ID is to keep objects that belong to other applications from being loaded.

contentIds

Identifies static content for the object, including JavaScript, CSS, HTML, by a user-friendly local key.

default

Second object that contains default values for the current object. The default attribute defines a second object that contains default values. This supports functionality to restore defaults.

descriptionKey

Resource bundle key for providing an object description in admin tools.

enabledYn

The enabled flag provides a quick way to turn the object on or off in the UI without removing it. Value is true or false.

id

Repository identifier.

imageUrl

Path to object image graphic in admin tools. The imageUrl allows a graphic to represent the object.

nameKey

Resource bundle key for providing an object name in admin tools.

objectType

Object sub-class name for item-descriptor inheritance.

optionNames

Lists segmented option names for the object mapped to a user-friendly local key.

resourceBundle

Resource bundle identifier for object resources. The resource bundle identifier allows any resource bundle on the class path to be used for object string resources.

segmentName

Identifies a unique view of the object attribute values per user segment. Like segmented options, entire framework objects support segmentation. Segmentation allows objects to support different value configurations by profile group. The segment name allows objects referenced by the same logical ID to contain different values based on the profile group of the current user. The profile groups are ranked by priority: the highest-ranked profile group that the user belongs to applies. For example, the segment name could be used by a panel stack to allow different panels to show for different profile groups.

templateIds

Identifies JSP page layout templates for the object mapped to a user-friendly local key.

The extension methods of the shared by all framework objects are described in detail below:

Returns

Method

Description

Map

getContents

Returns a map of all ContentDefinition objects assigned to the framework object keyed to the logical content identifier.

Map

getOptions

Returns a map of all SegmentedOption objects assigned to the framework object keyed to the option name.

Map

getTemplates

Returns a map of all TemplateDefinition objects assigned to the framework object keyed to the logical template identifier.

Map

getFrameworkObjects

Arguments: intpItemType

Utility method that returns a map of framework objects by item type.

 
loading table of contents...