Package com.rometools.modules.sle

Interface SimpleListExtension

All Superinterfaces:

Cloneable, CopyFrom, Module, Serializable

All Known Implementing Classes:

SimpleListExtensionImpl

public interface SimpleListExtension
extends Module

This is the primary module interface for the MS Simple List Extensions.

Field Summary

Fields

Modifier and Type	Field	Description
static String	URI	"http://www.microsoft.com/schemas/rss/core/2005"

Method Summary

Modifier and Type	Method	Description
Group[]	getGroupFields()	The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property.
Sort[]	getSortFields()	The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable” – that is, that the client should provide a user interface that allows the user to sort on that property.
String	getTreatAs()	This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list.
void	setGroupFields(Group[] groupFields)	The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property.
void	setSortFields(Sort[] sortFields)	The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable” – that is, that the client should provide a user interface that allows the user to sort on that property.
void	setTreatAs(String value)	This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list.

Methods inherited from interface com.rometools.rome.feed.CopyFrom

copyFrom, getInterface

Methods inherited from interface com.rometools.rome.feed.module.Module

clone, getUri

Field Detail

URI

static final String URI

"http://www.microsoft.com/schemas/rss/core/2005"

See Also:

Constant Field Values

Method Detail

setGroupFields

void setGroupFields(Group[] groupFields)

The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of discrete values (e.g. book genres are perfect for groups).

Parameters:

groupFields - Array of types.Group objects.

getGroupFields

Group[] getGroupFields()

The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of discrete values (e.g. book genres are perfect for groups).

Returns:

Array of types.Group objects.

setSortFields

void setSortFields(Sort[] sortFields)

The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable” – that is, that the client should provide a user interface that allows the user to sort on that property.

Parameters:

sortFields - Array of types.Sort objects

getSortFields

Sort[] getSortFields()

The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable” – that is, that the client should provide a user interface that allows the user to sort on that property.

Returns:

Array of types.Sort objects

setTreatAs

void setTreatAs(String value)

This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list. (defaults to "list" )

Parameters:

value - treatAs value

getTreatAs

String getTreatAs()

This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list.

Returns:

treatAs value.