org.apache.shindig.social.opensocial.model

Interface ListField

All Known Subinterfaces:

Url

All Known Implementing Classes:

ListFieldImpl, UrlImpl

public interface ListField

A Interface to represent list fields where there is potential for one of the items to have a primary or preferred status. Used where the List is a list of string values.

Introduced in v0.8.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ListField.Field The fields that represent the ListField object in serialized form.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getPrimary() Get Boolean value indicating whether this instance of the Plural Field is the primary or preferred value of for this field, e.g. the preferred mailing address or primary e-mail address.
String	getType() The type of field for this instance, usually used to label the preferred function of the given contact information.
String	getValue() Get the primary value of this field, e.g. the actual e-mail address, phone number, or URL.
void	setPrimary(Boolean primary)
void	setType(String type) Set the type of the field.
void	setValue(String value)

Method Detail

getType

String getType()

The type of field for this instance, usually used to label the preferred function of the given contact information. Unless otherwise specified, this string value specifies Canonical Values of work, home, and other.

Returns:

the type of the field

setType

void setType(String type)

Set the type of the field.

Parameters:

type - the type of the field

getValue

String getValue()

Get the primary value of this field, e.g. the actual e-mail address, phone number, or URL. When specifying a sortBy field in the Query Parameters for a Plural Field, the default meaning is to sort based on this value sub-field. Each non-empty Plural Field value MUST contain at least the value sub-field, but all other sub-fields are optional.

Returns:

the value of the field

setValue

void setValue(String value)

Parameters:

value - the value of the field

See Also:

getValue()

getPrimary

Boolean getPrimary()

Get Boolean value indicating whether this instance of the Plural Field is the primary or preferred value of for this field, e.g. the preferred mailing address or primary e-mail address. Service Providers MUST NOT mark more than one instance of the same Plural Field as primary="true", and MAY choose not to mark any fields as primary, if this information is not available. For efficiency, Service Providers SHOULD NOT mark all non-primary fields with primary="false", but should instead omit this sub-field for all non-primary instances.

Returns:

true if this is a primary or preferred value

setPrimary

void setPrimary(Boolean primary)

Parameters:

primary - set to true if a primary or preferred value

See Also:

getPrimary()