Package org.wso2.carbon.registry.social.api.people.userprofile

Interface Person

public interface Person
This bean class represents People/Person

  • Field Details

    • PROFILE_URL_TYPE

      static final String PROFILE_URL_TYPE
      The type of a profile url when represented as a list field.
      See Also:

    • THUMBNAIL_PHOTO_TYPE

      static final String THUMBNAIL_PHOTO_TYPE
      The type of thumbnail photo types when represented as list fields.
      See Also:

  • Method Details

    • getDisplayName

      String getDisplayName()
      The display name for the user.
      Returns:
      the display name

    • setDisplayName

      void setDisplayName(String displayName)
      Set the display name.
      Parameters:
      displayName - the new display name.

    • getAboutMe

      String getAboutMe()
      Get a general statement about the person, specified as a string. Container support for this field is OPTIONAL.
      Returns:
      the value of aboutMe

    • setAboutMe

      void setAboutMe(String aboutMe)
      Set a general statement about the person, specified as a string. Container support for this field is OPTIONAL.
      Parameters:
      aboutMe - the value of aboutMe

    • getAccounts

      List<Account> getAccounts()
      Get the list of online accounts held by this person.
      Returns:
      a list of Account objects

    • setAccounts

      void setAccounts(List<Account> accounts)
      Set the list of online accounts held by this person.
      Parameters:
      accounts - a list of Account objects

    • getActivities

      List<String> getActivities()
      Get the person's favorite activities, specified as an List of strings. Container support for this field is OPTIONAL.
      Returns:
      list of activities.

    • setActivities

      void setActivities(List<String> activities)
      Set the person's favorite activities, specified as an List of strings.
      Parameters:
      activities - a list of activities

    • getAddresses

      List<Address> getAddresses()
      Get addresses associated with the person, specified as an List of Address objects. Container support for this field is OPTIONAL.
      Returns:
      a List of address objects

    • setAddresses

      void setAddresses(List<Address> addresses)
      Set addresses associated with the person, specified as an List of Address objects. Container support for this field is OPTIONAL.
      Parameters:
      addresses - a list of address objects

    • getAge

      Integer getAge()
      Get the person's age, specified as a number. Container support for this field is OPTIONAL.
      Returns:
      the persons age

    • setAge

      void setAge(Integer age)
      Set the person's age, specified as a number. Container support for this field is OPTIONAL.
      Parameters:
      age - the persons age

    • getAppData

      Map<String,? extends Object> getAppData()
      Get app data for the person.
      Returns:
      the app data, possibly a subset.

    • setAppData

      void setAppData(Map<String,? extends Object> appData)
      Sets app data for the person.
      Parameters:
      appData - the app data, possibly a subset

    • getBirthday

      Date getBirthday()
      Get the person's date of birth, specified as a Date object. Container support for this field is OPTIONAL.
      Returns:
      the person's data of birth

    • setBirthday

      void setBirthday(Date birthday)
      Set the person's date of birth, specified as a Date object. Container support for this field is OPTIONAL.
      Parameters:
      birthday - the person's data of birth

    • getBodyType

      BodyType getBodyType()
      Get the person's body characteristics, specified as an BodyType. Container support for this field is OPTIONAL.
      Returns:
      the BodyType

    • setBodyType

      void setBodyType(BodyType bodyType)
      Set the person's body characteristics, specified as an BodyType. Container support for this field is OPTIONAL.
      Parameters:
      bodyType - the person's BodyType

    • getBooks

      List<String> getBooks()
      Get the person's favorite books, specified as an List of strings. Container support for this field is OPTIONAL.
      Returns:
      list of books as strings

    • setBooks

      void setBooks(List<String> books)
      Set the person's favorite books, specified as an List of strings. Container support for this field is OPTIONAL.
      Parameters:
      books - a list of the person's books

    • getCars

      List<String> getCars()
      Get the person's favorite cars, specified as an List of strings. Container support for this field is OPTIONAL.
      Returns:
      the persons favorite cars

    • setCars

      void setCars(List<String> cars)
      Set the person's favorite cars, specified as an List of strings. Container support for this field is OPTIONAL.
      Parameters:
      cars - a list of the persons favorite cars

    • getChildren

      String getChildren()
      Get a description of the person's children, specified as a string. Container support for this field is OPTIONAL.
      Returns:
      the persons children

    • setChildren

      void setChildren(String children)
      Set a description of the person's children, specified as a string. Container support for this field is OPTIONAL.
      Parameters:
      children - the persons children

    • getCurrentLocation

      Address getCurrentLocation()
      Get the person's current location, specified as an Address. Container support for this field is OPTIONAL.
      Returns:
      the persons current location

    • setCurrentLocation

      void setCurrentLocation(Address currentLocation)
      Set the person's current location, specified as an Address. Container support for this field is OPTIONAL.
      Parameters:
      currentLocation - the persons current location

    • getDrinker

      Enum<Drinker> getDrinker()
      Get the person's drinking status, specified as an Enum with the enum's key referencing Drinker. Container support for this field is OPTIONAL.
      Returns:
      the persons drinking status

    • setDrinker

      void setDrinker(Enum<Drinker> newDrinker)
      Get the person's drinking status, specified as an Enum with the enum's key referencing Drinker. Container support for this field is OPTIONAL.
      Parameters:
      newDrinker - the persons drinking status

    • getEmails

      List<ListField> getEmails()
      Get the person's Emails associated with the person. Container support for this field is OPTIONAL.
      Returns:
      a list of the person's emails

    • setEmails

      void setEmails(List<ListField> emails)
      Set the person's Emails associated with the person. Container support for this field is OPTIONAL.
      Parameters:
      emails - a list of the person's emails

    • getEthnicity

      String getEthnicity()
      Get the person's ethnicity, specified as a string. Container support for this field is OPTIONAL.
      Returns:
      the person's ethnicity

    • setEthnicity

      void setEthnicity(String ethnicity)
      Set the person's ethnicity, specified as a string. Container support for this field is OPTIONAL.
      Parameters:
      ethnicity - the person's ethnicity

    • getFashion

      String getFashion()
      Get the person's thoughts on fashion, specified as a string. Container support for this field is OPTIONAL.
      Returns:
      the person's thoughts on fashion

    • setFashion

      void setFashion(String fashion)
      Set the person's thoughts on fashion, specified as a string. Container support for this field is OPTIONAL.
      Parameters:
      fashion - the person's thoughts on fashion

    • getFood

      List<String> getFood()
      Get the person's favorite food, specified as an List of strings. Container support for this field is OPTIONAL.
      Returns:
      the person's favorite food

    • setFood

      void setFood(List<String> food)
      Set the person's favorite food, specified as an List of strings. Container support for this field is OPTIONAL.
      Parameters:
      food - the person's favorite food

    • getGender

      Person.Gender getGender()
      Get a person's gender, specified as an Person.Gender.
      Returns:
      the person's gender

    • setGender

      void setGender(Person.Gender newGender)
      Set a person's gender, specified as an Person.Gender.
      Parameters:
      newGender - the person's gender

    • getHappiestWhen

      String getHappiestWhen()
      Get a description of when the person is happiest, specified as a string. Container support for this field is OPTIONAL.
      Returns:
      a description of when the person is happiest

    • setHappiestWhen

      void setHappiestWhen(String happiestWhen)
      Set a description of when the person is happiest, specified as a string. Container support for this field is OPTIONAL.
      Parameters:
      happiestWhen - a description of when the person is happiest

    • getHasApp

      Boolean getHasApp()
      Get if the person has used the current app. Container support for this field is OPTIONAL. Has app needs to take account of the context of the application that is performing the query on this person object.
      Returns:
      true the current app has been used

    • setHasApp

      void setHasApp(Boolean hasApp)
      Set if the person has used the current app. Container support for this field is OPTIONAL.
      Parameters:
      hasApp - set true the current app has been used

    • getHeroes

      List<String> getHeroes()
      Get a person's favorite heroes, specified as an Array of strings. Container support for this field is OPTIONAL.
      Returns:
      a list of the person's favorite heroes

    • setHeroes

      void setHeroes(List<String> heroes)
      Set a person's favorite heroes, specified as an Array of strings. Container support for this field is OPTIONAL.
      Parameters:
      heroes - a list of the person's favorite heroes

    • getHumor

      String getHumor()
      Get the person's thoughts on humor, specified as a string. Container support for this field is OPTIONAL.
      Returns:
      the person's thoughts on humor

    • setHumor

      void setHumor(String humor)
      Set the person's thoughts on humor, specified as a string. Container support for this field is OPTIONAL.
      Parameters:
      humor - the person's thoughts on humor

    • getId

      String getId()
      Get A string ID that can be permanently associated with this person. Container support for this field is REQUIRED.
      Returns:
      the permanent ID of the person

    • setId

      void setId(String id)
      Set A string ID that can be permanently associated with this person. Container support for this field is REQUIRED.
      Parameters:
      id - the permanent ID of the person

    • getIms

      List<ListField> getIms()
      Get a list of Instant messaging address for this Person. No official canonicalization rules exist for all instant messaging addresses, but Service Providers SHOULD remove all whitespace and convert the address to lowercase, if this is appropriate for the service this IM address is used for. Instead of the standard Canonical Values for type, this field defines the following Canonical Values to represent currently popular IM services: aim, gtalk, icq, xmpp, msn, skype, qq, and yahoo.
      Returns:
      A list of IM addresses

    • setIms

      void setIms(List<ListField> ims)
      Set a list of Instant messaging address for this Person. No official canonicalization rules exist for all instant messaging addresses, but Service Providers SHOULD remove all whitespace and convert the address to lowercase, if this is appropriate for the service this IM address is used for. Instead of the standard Canonical Values for type, this field defines the following Canonical Values to represent currently popular IM services: aim, gtalk, icq, xmpp, msn, skype, qq, and yahoo.
      Parameters:
      ims - a list ListFields representing IM addresses.

    • getInterests

      List<String> getInterests()
      Get the person's interests, hobbies or passions, specified as an List of strings. Container support for this field is OPTIONAL.
      Returns:
      the person's interests, hobbies or passions

    • setInterests

      void setInterests(List<String> interests)
      Set the person's interests, hobbies or passions, specified as an List of strings. Container support for this field is OPTIONAL.
      Parameters:
      interests - the person's interests, hobbies or passions

    • getJobInterests

      String getJobInterests()
      Get the Person's favorite jobs, or job interests and skills, specified as a string. Container support for this field is OPTIONAL
      Returns:
      the Person's favorite jobs, or job interests and skills

    • setJobInterests

      void setJobInterests(String jobInterests)
      Set the Person's favorite jobs, or job interests and skills, specified as a string. Container support for this field is OPTIONAL
      Parameters:
      jobInterests - the Person's favorite jobs, or job interests and skills

    • getLanguagesSpoken

      List<String> getLanguagesSpoken()
      Get a List of the languages that the person speaks as ISO 639-1 codes, specified as an List of strings. Container support for this field is OPTIONAL.
      Returns:
      a List of the languages that the person speaks

    • setLanguagesSpoken

      void setLanguagesSpoken(List<String> languagesSpoken)
      Set a List of the languages that the person speaks as ISO 639-1 codes, specified as an List of strings. Container support for this field is OPTIONAL.
      Parameters:
      languagesSpoken - a List of the languages that the person speaks

    • getUpdated

      Date getUpdated()
      The time this person was last updated.
      Returns:
      the last update time

    • setUpdated

      void setUpdated(Date updated)
      Set the time this record was last updated.
      Parameters:
      updated - the last update time

    • getLivingArrangement

      String getLivingArrangement()
      Get a description of the person's living arrangement, specified as a string. Container support for this field is OPTIONAL.
      Returns:
      a description of the person's living arrangement

    • setLivingArrangement

      void setLivingArrangement(String livingArrangement)
      Set a description of the person's living arrangement, specified as a string. Container support for this field is OPTIONAL.
      Parameters:
      livingArrangement - a description of the person's living arrangement

    • getLookingFor

      List<Enum<LookingFor>> getLookingFor()
      Get a person's statement about who or what they are looking for, or what they are interested in meeting people for. Specified as an List of Enum with the enum's key referencing LookingFor Container support for this field is OPTIONAL.
      Returns:
      person's statement about who or what they are looking for

    • setLookingFor

      void setLookingFor(List<Enum<LookingFor>> lookingFor)
      Get a person's statement about who or what they are looking for, or what they are interested in meeting people for. Specified as an List of Enum with the enum's key referencing LookingFor Container support for this field is OPTIONAL.
      Parameters:
      lookingFor - person's statement about who or what they are looking for

    • getMovies

      List<String> getMovies()
      Get the Person's favorite movies, specified as an List of strings. Container support for this field is OPTIONAL.
      Returns:
      the Person's favorite movies

    • setMovies

      void setMovies(List<String> movies)
      Set the Person's favorite movies, specified as an List of strings. Container support for this field is OPTIONAL.
      Parameters:
      movies - the Person's favorite movies

    • getMusic

      List<String> getMusic()
      Get the Person's favorite music, specified as an List of strings Container support for this field is OPTIONAL.
      Returns:
      Person's favorite music

    • setMusic

      void setMusic(List<String> music)
      Set the Person's favorite music, specified as an List of strings Container support for this field is OPTIONAL.
      Parameters:
      music - Person's favorite music

    • getName

      Name getName()
      Get the person's name Container support for this field is REQUIRED.
      Returns:
      the person's name

    • setName

      void setName(Name name)
      Set the person's name Container support for this field is REQUIRED.
      Parameters:
      name - the person's name

    • getNetworkPresence

      Enum<NetworkPresence> getNetworkPresence()
      Get the person's current network status. Specified as an Enum with the enum's key referencing NetworkPresence. Container support for this field is OPTIONAL.
      Returns:
      the person's current network status

    • setNetworkPresence

      void setNetworkPresence(Enum<NetworkPresence> networkPresence)
      Set the person's current network status. Specified as an Enum with the enum's key referencing NetworkPresence. Container support for this field is OPTIONAL.
      Parameters:
      networkPresence - the person's current network status

    • getNickname

      String getNickname()
      Get the person's nickname. Container support for this field is REQUIRED.
      Returns:
      the person's nickname.

    • setNickname

      void setNickname(String nickname)
      Set the the person's nickname. Container support for this field is REQUIRED.
      Parameters:
      nickname - the person's nickname.

    • getOrganizations

      List<Organization> getOrganizations()
      Get a list of current or past organizational affiliations of this Person.
      Returns:
      a list of Organization objects

    • setOrganizations

      void setOrganizations(List<Organization> organizations)
      Set a list of current or past organizational affiliations of this Person.
      Parameters:
      organizations - a list of Organisation objects

    • getPets

      String getPets()
      Get a description of the person's pets Container support for this field is OPTIONAL.
      Returns:
      a description of the person's pets

    • setPets

      void setPets(String pets)
      Set a description of the person's pets Container support for this field is OPTIONAL.
      Parameters:
      pets - a description of the person's pets

    • getPhoneNumbers

      List<ListField> getPhoneNumbers()
      Get the Phone numbers associated with the person.
      Returns:
      the Phone numbers associated with the person

    • setPhoneNumbers

      void setPhoneNumbers(List<ListField> phoneNumbers)
      Set the Phone numbers associated with the person.
      Parameters:
      phoneNumbers - the Phone numbers associated with the person

    • getPhotos

      List<ListField> getPhotos()
      URL of a photo of this person. The value SHOULD be a canonicalized URL, and MUST point to an actual image file (e.g. a GIF, JPEG, or PNG image file) rather than to a web page containing an image. Service Providers MAY return the same image at different sizes, though it is recognized that no standard for describing images of various sizes currently exists. Note that this field SHOULD NOT be used to send down arbitrary photos taken by this user, but specifically profile photos of the contact suitable for display when describing the contact.
      Returns:
      a list of Photos

    • setPhotos

      void setPhotos(List<ListField> photos)
      Set a list of Photos for the person.
      Parameters:
      photos - a list of photos.
      See Also:

    • getPoliticalViews

      String getPoliticalViews()
      Get the Person's political views, specified as a string. Container support for this field is OPTIONAL.
      Returns:
      the Person's political views

    • setPoliticalViews

      void setPoliticalViews(String politicalViews)
      Set the Person's political views, specified as a string. Container support for this field is OPTIONAL.
      Parameters:
      politicalViews - the Person's political views

    • getPreferredUsername

      String getPreferredUsername()
      Get the Person's preferred username, specified as a string. Container support for this field is OPTIONAL
      Returns:
      the Person's preferred username

    • setPreferredUsername

      void setPreferredUsername(String preferredString)
      Set the Person's preferred username, specified as a string. Container support for this field is OPTIONAL
      Parameters:
      preferredString - the Person's preferred username

    • getProfileSong

      Url getProfileSong()
      Get the Person's profile song, specified as an Url. Container support for this field is OPTIONAL.
      Returns:
      the Person's profile song

    • setProfileSong

      void setProfileSong(Url profileSong)
      Set the Person's profile song, specified as an Url. Container support for this field is OPTIONAL.
      Parameters:
      profileSong - the Person's profile song

    • getProfileVideo

      Url getProfileVideo()
      Get the Person's profile video. Container support for this field is OPTIONAL.
      Returns:
      the Person's profile video

    • setProfileVideo

      void setProfileVideo(Url profileVideo)
      Set the Person's profile video. Container support for this field is OPTIONAL.
      Parameters:
      profileVideo - the Person's profile video

    • getQuotes

      List<String> getQuotes()
      Get the person's favorite quotes Container support for this field is OPTIONAL.
      Returns:
      the person's favorite quotes

    • setQuotes

      void setQuotes(List<String> quotes)
      Set the person's favorite quotes. Container support for this field is OPTIONAL.
      Parameters:
      quotes - the person's favorite quotes

    • getRelationshipStatus

      String getRelationshipStatus()
      Get the person's relationship status. Container support for this field is OPTIONAL.
      Returns:
      the person's relationship status

    • setRelationshipStatus

      void setRelationshipStatus(String relationshipStatus)
      Set the person's relationship status. Container support for this field is OPTIONAL.
      Parameters:
      relationshipStatus - the person's relationship status

    • getReligion

      String getReligion()
      Get the person's relgion or religious views. Container support for this field is OPTIONAL.
      Returns:
      the person's relgion or religious views

    • setReligion

      void setReligion(String religion)
      Set the person's relgion or religious views. Container support for this field is OPTIONAL.
      Parameters:
      religion - the person's relgion or religious views

    • getRomance

      String getRomance()
      Get the person's comments about romance. Container support for this field is OPTIONAL.
      Returns:
      the person's comments about romance,

    • setRomance

      void setRomance(String romance)
      Set a the person's comments about romance, Container support for this field is OPTIONAL.
      Parameters:
      romance - the person's comments about romance,

    • getScaredOf

      String getScaredOf()
      Get what the person is scared of Container support for this field is OPTIONAL.
      Returns:
      what the person is scared of

    • setScaredOf

      void setScaredOf(String scaredOf)
      Set what the person is scared of Container support for this field is OPTIONAL.
      Parameters:
      scaredOf - what the person is scared of

    • getSexualOrientation

      String getSexualOrientation()
      Get the person's sexual orientation. Container support for this field is OPTIONAL.
      Returns:
      the person's sexual orientation

    • setSexualOrientation

      void setSexualOrientation(String sexualOrientation)
      Set the person's sexual orientation Container support for this field is OPTIONAL.
      Parameters:
      sexualOrientation - the person's sexual orientation

    • getSmoker

      Enum<Smoker> getSmoker()
      Get the person's smoking status. Container support for this field is OPTIONAL.
      Returns:
      the person's smoking status

    • setSmoker

      void setSmoker(Enum<Smoker> newSmoker)
      Set the person's smoking status. Container support for this field is OPTIONAL.
      Parameters:
      newSmoker - the person's smoking status

    • getSports

      List<String> getSports()
      Get the person's favorite sports. Container support for this field is OPTIONAL.
      Returns:
      the person's favorite sports

    • setSports

      void setSports(List<String> sports)
      Set the person's favorite sports. Container support for this field is OPTIONAL.
      Parameters:
      sports - the person's favorite sports

    • getStatus

      String getStatus()
      Get the person's status, headline or shoutout. Container support for this field is OPTIONAL.
      Returns:
      the person's status, headline or shoutout

    • setStatus

      void setStatus(String status)
      Set the person's status, headline or shoutout. Container support for this field is OPTIONAL.
      Parameters:
      status - the person's status, headline or shoutout

    • getTags

      List<String> getTags()
      Get arbitrary tags about the person. Container support for this field is OPTIONAL.
      Returns:
      arbitrary tags about the person.

    • setTags

      void setTags(List<String> tags)
      Set arbitrary tags about the person. Container support for this field is OPTIONAL.
      Parameters:
      tags - arbitrary tags about the person.

    • getUtcOffset

      Long getUtcOffset()
      Get the Person's time zone, specified as the difference in minutes between Greenwich Mean Time (GMT) and the user's local time. Container support for this field is OPTIONAL.
      Returns:
      the Person's time zone

    • setUtcOffset

      void setUtcOffset(Long utcOffset)
      Set the Person's time zone, specified as the difference in minutes between Greenwich Mean Time (GMT) and the user's local time. Container support for this field is OPTIONAL.
      Parameters:
      utcOffset - the Person's time zone

    • getTurnOffs

      List<String> getTurnOffs()
      Get the person's turn offs. Container support for this field is OPTIONAL.
      Returns:
      the person's turn offs

    • setTurnOffs

      void setTurnOffs(List<String> turnOffs)
      Set the person's turn offs. Container support for this field is OPTIONAL.
      Parameters:
      turnOffs - the person's turn offs

    • getTurnOns

      List<String> getTurnOns()
      Get the person's turn ons. Container support for this field is OPTIONAL.
      Returns:
      the person's turn ons

    • setTurnOns

      void setTurnOns(List<String> turnOns)
      Set the person's turn ons. Container support for this field is OPTIONAL.
      Parameters:
      turnOns - the person's turn ons

    • getTvShows

      List<String> getTvShows()
      Get the person's favorite TV shows. Container support for this field is OPTIONAL.
      Returns:
      the person's favorite TV shows.

    • setTvShows

      void setTvShows(List<String> tvShows)
      Set the person's favorite TV shows. Container support for this field is OPTIONAL.
      Parameters:
      tvShows - the person's favorite TV shows.

    • getUrls

      List<Url> getUrls()
      Get the URLs related to the person, their webpages, or feeds Container support for this field is OPTIONAL.
      Returns:
      the URLs related to the person, their webpages, or feeds

    • setUrls

      void setUrls(List<Url> urls)
      Set the URLs related to the person, their webpages, or feeds Container support for this field is OPTIONAL.
      Parameters:
      urls - the URLs related to the person, their webpages, or feeds

    • getIsOwner

      boolean getIsOwner()
      Returns:
      true if this person object represents the owner of the current page.

    • setIsOwner

      void setIsOwner(boolean isOwner)
      Set the owner flag.
      Parameters:
      isOwner - the isOwnerflag

    • getIsViewer

      boolean getIsViewer()
      Returns true if this person object represents the currently logged in user.
      Returns:
      true if the person accessing this object is a viewer.

    • setIsViewer

      void setIsViewer(boolean isViewer)
      Returns true if this person object represents the currently logged in user.
      Parameters:
      isViewer - the isViewer Flag

    • getProfileUrl

      String getProfileUrl()
      Get the person's profile URL. This URL must be fully qualified. Relative URLs will not work in gadgets. This field MUST be stored in the urls list with a type of "profile".

      Container support for this field is OPTIONAL.

      Returns:
      the person's profile URL

    • setProfileUrl

      void setProfileUrl(String profileUrl)
      Set the person's profile URL. This URL must be fully qualified. Relative URLs will not work in gadgets. This field MUST be stored in the urls list with a type of "profile".

      Container support for this field is OPTIONAL.

      Parameters:
      profileUrl - the person's profile URL

    • getThumbnailUrl

      String getThumbnailUrl()
      Get the person's photo thumbnail URL, specified as a string. This URL must be fully qualified. Relative URLs will not work in gadgets. This field MUST be stored in the photos list with a type of "thumbnail".

      Container support for this field is OPTIONAL.

      Returns:
      the person's photo thumbnail URL

    • setThumbnailUrl

      void setThumbnailUrl(String thumbnailUrl)
      Set the person's photo thumbnail URL, specified as a string. This URL must be fully qualified. Relative URLs will not work in gadgets. This field MUST be stored in the photos list with a type of "thumbnail".

      Container support for this field is OPTIONAL.

      Parameters:
      thumbnailUrl - the person's photo thumbnail URL