com.webmethods.caf.faces.data
Interface IContentProvider

All Known Subinterfaces:

IAddressableTableContentProvider, ICalendarProvider, IFilterableTableContentProvider, IPageableTableContentProvider, IRefreshableContentProvider, ISelectableTableContentProvider, ISelectableTreeContentProvider, ISortableTableContentProvider, ITableContentProvider, ITaskContentProvider, ITaskSearchContentProvider, ITaskSearchPagingContentProvider, ITransactionalContentProvider, ITreeContentProvider, IUpdateableContentProvider, IUpdateableTableContentProvider

All Known Implementing Classes:

AbstractTaskContentProvider, AtomEntriesExportProvider, AtomEntriesTableExportProvider, AtomFeedExportProvider, AtomFeedTableExportProvider, BaseAppNavBean.PagesContentProvider, BaseAppNavBean.SubNavsContentProvider, BaseIteratorTableContentProvider, BaseTaskSearchContentProvider, BaseTaskWorkloadProvider, BaseViewBean.ClientIdsContentProvider, BaseWSClientContentProvider, BaseXMLNode, BoundChildrenNode.PermissiveContentProviderWrapper, BoundChildrenTreeContentProvider, BoundPropertiesContentProvider, BoundPropertiesTableContentProvider, BusinessCalendarModel, ChildrenTableContentProvider, CSPContent, CSPContentDefinition, CSPContentSearchProvider, CSPIndexDefinitionProvider, CSVExportProvider, CSVTableExportProvider, DataModelTableContentProvider, DataTableExportProvider, DefaultCalendarProvider, DirectorySearchProvider, ELPropertyContentProvider, EmptyContentProvider, EmptyResourcesContentProvider, FilterableListTableContentProvider, FilterableListTreeContentProvider, FilterableSelectableListTableContentProvider, FilteredPortalContainerModel, GlueWSClientContentProvider, GlueWSClientContentProvider.OutputProvider, GlueWSClientContentProvider.ParametersProvider, JcrNodeProvider, LazyNodeTreeContentProvider, LimitedPropertiesContentProvider, LimitedPropertiesTableContentProvider, ListTableContentProvider, ListTreeContentProvider, MapContentProvider, NewsfeedContentProvider, NodeTreeContentProvider, ObjectMethodContentProvider, PageableExportProvider, PageableTableContentProvider, PeopleSearchProvider, PortalContainerModel, PortalItemModel, ProcessSearchProvider, ResourceBundleContentProvider, RowSetTableContentProvider, ScalarTableContentProvider, SearchTableContentProvider, SelectableListTableContentProvider, SimpleTaskContentProvider, SortInfo.AscendingsContentProvider, SortInfo.OrdinalsContentProvider, TableTreeContentProvider, TaskAuditContentProvider, TaskBusinessCalendarModel, TaskContentProvider, TaskContentProviderExtended, TaskData, TaskInboxIndexedSearchContentProvider, TaskInboxQueueWorkloadProvider, TaskInboxSearchContentProvider, TaskIndexedSearchContentProvider, TaskRoundRobinWorkloadProvider, TaskSavedSearchContentProvider, TaskSearchContentProvider, UpdateablePortalItemModel, VersionHistoryTableContentProvider, XMLDOMNode2, XMLElementNode2, XMLTableContentProvider, XMLTreeContentProvider

public interface IContentProvider

Main content provider interface.

Content provider wraps an underlying structured content coming from a data source. It provides access to this content using properties. Each property is identified by property key which is typically a String name or an Integer index of the property. Content provider exposes list of all properties it supports and types of those properties. It also allows to get property value by its key.

Method Summary

Object[]	getPropertyKeys() Returns list of properties supported by this content provider.
Class	getType(Object propertyKey) Returns java type of the given property
Object	getValue(Object propertyKey) Returns value of the given property
boolean	hasProperty(Object propertyKey) Checks if the given property is supported by this content provider
String	toString() Returns string representation of content.

Method Detail

getPropertyKeys

Object[] getPropertyKeys()

Returns list of properties supported by this content provider. Can return Object[0], never null.

Returns:

array of property keys which is typically of type String or Integer

hasProperty

boolean hasProperty(Object propertyKey)

Checks if the given property is supported by this content provider

Parameters:

propertyKey - property key of type String or Integer

Returns:

true if property is supported

getValue

Object getValue(Object propertyKey)
                throws EvaluationException,
                       PropertyNotFoundException

Returns value of the given property

Parameters:

propertyKey - the property key of type String or Integer

Returns:

value of the property, can be null

Throws:

EvaluationException - if error during property evaluation

PropertyNotFoundException - if property is not supported

getType

Class getType(Object propertyKey)
              throws PropertyNotFoundException

Returns java type of the given property

Parameters:

propertyKey - the property key of type String or Integer

Returns:

property java Class

Throws:

PropertyNotFoundException - if property is not supported

toString

String toString()

Returns string representation of content.

Overrides:

toString in class Object

Returns:

String representation of the wrapped content