org.xwiki.livedata.rest

Interface LiveDataPropertyTypeResource

@Unstable
public interface LiveDataPropertyTypeResource

Represents a live data property type.

Since:

12.10

Version:

$Id: 49b5381ea531da4881d0ccd5599f3b6575faa1e4 $

Method Summary

Modifier and Type	Method and Description
PropertyDescriptor	getType(String sourceId, String namespace, String typeId) Provides information about the specified live data property type.

Method Detail

getType

PropertyDescriptor getType(String sourceId,
                           String namespace,
                           String typeId)
                    throws Exception

Provides information about the specified live data property type.

Parameters:

sourceId - indicates the LiveDataSource component implementation

namespace - the component manager name-space where to look for LiveDataSource implementations; if not specified then the context / current name-space is used

typeId - identifies the property type

Returns:

the descriptor of the specified property type

Throws:

Exception - if retrieving the property type fails