org.rcfaces.core.component.capability
Interface IServerDataCapability

All Known Implementing Classes:
AbstractBasicComponent, AbstractCalendarComponent, AbstractCommandComponent, AbstractConverterCommandComponent, AbstractDataComponent, AbstractGridComponent, AbstractInputComponent, AbstractItemComponent, AbstractMenuComponent, AbstractMessageComponent, AbstractMessagesComponent, AbstractOutputComponent, AbstractSelectManyComponent, BoxComponent, ButtonComponent, CalendarComponent, CardBoxComponent, CardComponent, CheckButtonComponent, ComboComponent, ComboGridComponent, ComponentsGridComponent, ComponentsListComponent, CustomButtonComponent, DataGridComponent, DateChooserComponent, DateEntryComponent, DateItemComponent, ExpandableItemComponent, ExpandBarComponent, ExternalBoxComponent, FieldSetComponent, HelpButtonComponent, HiddenValueComponent, HyperLinkComponent, ImageButtonComponent, ImageCheckButtonComponent, ImageComboComponent, ImageComponent, ImagePagerButtonComponent, ImageRadioButtonComponent, ImageResetButtonComponent, ImageSubmitButtonComponent, ItemsListComponent, ItemsToolFolderComponent, KeyEntryComponent, KeyLabelComponent, ListComponent, MenuBarComponent, MenuCheckItemComponent, MenuItemComponent, MenuRadioItemComponent, MessageComponent, MessageFieldSetComponent, MessagesComponent, NumberEntryComponent, PagerComponent, PasswordEntryComponent, ProgressBarComponent, RadioButtonComponent, ResetButtonComponent, SelectItemComponent, ServiceComponent, SpinnerComponent, StyledMessageComponent, StyledTextComponent, SubmitButtonComponent, SuggestTextEntryComponent, TabbedPaneComponent, TabComponent, TabNamingContainerComponent, TextAreaComponent, TextComponent, TextEditorComboComponent, TextEditorComponent, TextEditorImageButtonComponent, TextEditorToolFolderComponent, TextEntryComponent, TimeEntryComponent, ToolBarComponent, ToolFolderComponent, ToolItemComponent, TreeComponent, TreeNodeComponent, UIImageItemComponent, ViewErrorListenerComponent

public interface IServerDataCapability

Version:
$Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
Author:
Olivier Oeuillot (latest modification by $Author: jbmeslin $)

Method Summary
 Object getServerData(String name)
          Retrieves an object data associated to a key
 int getServerDataCount()
          Returns the number of keys associated to the component.
 Map getServerDataMap()
          Returns a Map object containing keys and associated data objects
 String[] listServerDataKeys()
          Returns a list of the keys defined for the component
 Object removeServerData(String name)
          Removes a key and the data object associated to it
 Object setServerData(String name, Object data)
          Associates and object to a key for the component on the server side
 

Method Detail

setServerData

Object setServerData(String name,
                     Object data)
Associates and object to a key for the component on the server side

Parameters:
name - key used to retrieve the object associated
data - object to associate
Returns:
the object previously associated to teh key (null if none)

removeServerData

Object removeServerData(String name)
Removes a key and the data object associated to it

Parameters:
name - the key to remove
Returns:
the data object that was associated to the key (null if none)

getServerData

Object getServerData(String name)
Retrieves an object data associated to a key

Parameters:
name - the key to retrieve
Returns:
the data object associated to the key

listServerDataKeys

String[] listServerDataKeys()
Returns a list of the keys defined for the component

Returns:
list of keys

getServerDataCount

int getServerDataCount()
Returns the number of keys associated to the component.

Returns:
number of keys

getServerDataMap

Map getServerDataMap()
Returns a Map object containing keys and associated data objects

Returns:
a map


Copyright © 2006-2011 Vedana. All Rights Reserved.