org.apache.shindig.social.opensocial.model

Interface Account

All Known Implementing Classes:

AccountImpl

public interface Account

The Account interface describes the an account held by a person. Describes an account held by a Person, which MAY be on the Service Provider's service, or MAY be on a different service. The service provider does not have a requirement to verify that the account actually belongs to the person that the account is connected to, and consumers are appropriately warned of this in the Specification.

For each account, the domain is the top-most authoritative domain for this account, e.g. yahoo.com or reader.google.com, and MUST be non-empty. Each account must also contain a non-empty value for either username or userid, and MAY contain both, in which case the two values MUST be for the same account. These accounts can be used to determine if a user on one service is also known to be the same person on a different service, to facilitate connecting to people the user already knows on different services.

Since V0.8.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Account.Field The fields that represent the account object in json form.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDomain() The top-most authoritative domain for this account, e.g.
String	getUserId() A user ID number, usually chosen automatically, and usually numeric but sometimes alphanumeric, e.g. "12345" or "1Z425A".
String	getUsername() An alphanumeric user name, usually chosen by the user, e.g.
void	setDomain(String domain) The top-most authoritative domain for this account, e.g.
void	setUserId(String userId) A user ID number, usually chosen automatically, and usually numeric but sometimes alphanumeric, e.g. "12345" or "1Z425A".
void	setUsername(String username) An alphanumeric user name, usually chosen by the user, e.g.

Method Detail

getDomain

String getDomain()

The top-most authoritative domain for this account, e.g. "twitter.com". This is the Primary Sub-Field for this field, for the purposes of sorting and filtering.

Returns:

the domain

setDomain

void setDomain(String domain)

The top-most authoritative domain for this account, e.g. "twitter.com". This is the Primary Sub-Field for this field, for the purposes of sorting and filtering. *

Parameters:

domain - the domain

getUserId

String getUserId()

A user ID number, usually chosen automatically, and usually numeric but sometimes alphanumeric, e.g. "12345" or "1Z425A".

Returns:

the userId

setUserId

void setUserId(String userId)

A user ID number, usually chosen automatically, and usually numeric but sometimes alphanumeric, e.g. "12345" or "1Z425A".

Parameters:

userId - the userId

getUsername

String getUsername()

An alphanumeric user name, usually chosen by the user, e.g. "jsmarr".

Returns:

the username

setUsername

void setUsername(String username)

An alphanumeric user name, usually chosen by the user, e.g. "jsmarr".

Parameters:

username - the username