org.apache.shindig.social.opensocial.model
Interface Organization

All Known Implementing Classes:

OrganizationImpl

public interface Organization

Describes a current or past organizational affiliation of this contact. Service Providers that support only a single Company Name and Job Title field should represent them with a single organization element with name and title properties, respectively. see http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Organization

Nested Class Summary

static class

Organization.Field An Enumeration of field names for Organization.

Method Summary

Address	getAddress() Get the address of the organization, specified as an Address.
String	getDescription() Get a description or notes about the person's work in the organization, specified as a string.
Date	getEndDate() Get the date the person stopped at the organization, specified as a Date.
String	getField() Get the field the organization is in, specified as a string.
String	getName() Get the name of the organization, specified as a string.
Boolean	getPrimary() Get Boolean value indicating whether this instance of the Plural Field is the primary or preferred Organization.
String	getSalary() Get the salary the person receives from the organization, specified as a string.
Date	getStartDate() Get the date the person started at the organization, specified as a Date.
String	getSubField() Get the subfield the Organization is in, specified as a string.
String	getTitle() Get the title or role the person has in the organization, specified as a string.
String	getType() Get the type of field for this instance, usually used to label the preferred function of the given contact information.
String	getWebpage() Get a webpage related to the organization, specified as a string.
void	setAddress(Address address) Set the address of the organization, specified as an Address.
void	setDescription(String description) Set a description or notes about the person's work in the organization, specified as a string.
void	setEndDate(Date endDate) Set the date the person stopped at the organization, specified as a Date.
void	setField(String field) Set the field the organization is in, specified as a string.
void	setName(String name) Set the name of the organization, specified as a string.
void	setPrimary(Boolean primary) Set Boolean value indicating whether this instance of the Plural Field is the primary or preferred Organization.
void	setSalary(String salary) Set the salary the person receives from the organization, specified as a string.
void	setStartDate(Date startDate) Set the date the person started at the organization, specified as a Date.
void	setSubField(String subField) Set the subfield the Organization is in, specified as a string.
void	setTitle(String title) Set the title or role the person has in the organization, specified as a string.
void	setType(String type) Set the type of field for this instance, usually used to label the preferred function of the given contact information.
void	setWebpage(String webpage) Get a webpage related to the organization, specified as a string.

Method Detail

getAddress

Address getAddress()

Get the address of the organization, specified as an Address. Container support for this field is OPTIONAL.

Returns:

the Address of the organization

setAddress

void setAddress(Address address)

Set the address of the organization, specified as an Address. Container support for this field is OPTIONAL.

Parameters:

address - the address of the organization

getDescription

String getDescription()

Get a description or notes about the person's work in the organization, specified as a string. This could be the courses taken by a student, or a more detailed description about a Organization role. Container support for this field is OPTIONAL.

Returns:

a description about the persons work in the organization

setDescription

void setDescription(String description)

Set a description or notes about the person's work in the organization, specified as a string. This could be the courses taken by a student, or a more detailed description about a Organization role. Container support for this field is OPTIONAL.

Parameters:

description - a description about the persons work in the organization

getEndDate

Date getEndDate()

Get the date the person stopped at the organization, specified as a Date. A null date indicates that the person is still involved with the organization. Container support for this field is OPTIONAL.

Returns:

the date the person stopped at the organization

setEndDate

void setEndDate(Date endDate)

Set the date the person stopped at the organization, specified as a Date. A null date indicates that the person is still involved with the organization. Container support for this field is OPTIONAL.

Parameters:

endDate - the date the person stopped at the organization

getField

String getField()

Get the field the organization is in, specified as a string. This could be the degree pursued if the organization is a school. Container support for this field is OPTIONAL.

Returns:

the field the organization is in

setField

void setField(String field)

Set the field the organization is in, specified as a string. This could be the degree pursued if the organization is a school. Container support for this field is OPTIONAL.

Parameters:

field - the field the organization is in

getName

String getName()

Get the name of the organization, specified as a string. For example, could be a school name or a job company. Container support for this field is OPTIONAL.

Returns:

the name of the organization

setName

void setName(String name)

Set the name of the organization, specified as a string. For example, could be a school name or a job company. Container support for this field is OPTIONAL.

Parameters:

name - the name of the organization

getSalary

String getSalary()

Get the salary the person receives from the organization, specified as a string. Container support for this field is OPTIONAL.

Returns:

the salary the person receives

setSalary

void setSalary(String salary)

Set the salary the person receives from the organization, specified as a string. Container support for this field is OPTIONAL.

Parameters:

salary - the salary the person receives

getStartDate

Date getStartDate()

Get the date the person started at the organization, specified as a Date. Container support for this field is OPTIONAL.

Returns:

the start date at the organization

setStartDate

void setStartDate(Date startDate)

Set the date the person started at the organization, specified as a Date. Container support for this field is OPTIONAL.

Parameters:

startDate - the start date at the organization

getSubField

String getSubField()

Get the subfield the Organization is in, specified as a string. Container support for this field is OPTIONAL.

Returns:

the subfield the Organization is in

setSubField

void setSubField(String subField)

Set the subfield the Organization is in, specified as a string. Container support for this field is OPTIONAL.

Parameters:

subField - the subfield the Organization is in

getTitle

String getTitle()

Get the title or role the person has in the organization, specified as a string. This could be graduate student, or software engineer. Container support for this field is OPTIONAL.

Returns:

the title or role the person has in the organization

setTitle

void setTitle(String title)

Set the title or role the person has in the organization, specified as a string. This could be graduate student, or software engineer. Container support for this field is OPTIONAL.

Parameters:

title - the title or role the person has in the organization

getWebpage

String getWebpage()

Get a webpage related to the organization, specified as a string. Container support for this field is OPTIONAL.

Returns:

the URL of a webpage related to the organization

setWebpage

void setWebpage(String webpage)

Get a webpage related to the organization, specified as a string. Container support for this field is OPTIONAL.

Parameters:

webpage - the URL of a webpage related to the organization

getType

String getType()

Get the type of field for this instance, usually used to label the preferred function of the given contact information. The type of organization, with Canonical Values job and school.

Returns:

the type of the field

setType

void setType(String type)

Set the type of field for this instance, usually used to label the preferred function of the given contact information. The type of organization, with Canonical Values job and school.

Parameters:

type - the type of the field

getPrimary

Boolean getPrimary()

Get Boolean value indicating whether this instance of the Plural Field is the primary or preferred Organization.

Returns:

true if this is a primary or preferred value

setPrimary

void setPrimary(Boolean primary)

Set Boolean value indicating whether this instance of the Plural Field is the primary or preferred Organization.

Parameters:

primary - true if this is a primary or preferred value