Thing (flattr4j core 2.10 API)

java.lang.Object
- org.shredzone.flattr4j.model.Resource
- - org.shredzone.flattr4j.model.Thing

All Implemented Interfaces:

Serializable, CategoryId, LanguageId, ThingId, UserId
```
public class Thing
extends Resource
implements ThingId, UserId, CategoryId, LanguageId
```
A Thing that has been registered with Flattr. Two Thing are considered equal if they contain the same id. Some properties of a Thing can be modified by setters. After that, invoke FlattrService.update(org.shredzone.flattr4j.model.Thing) to persist the changes.
This class is not threadsafe.

Author:

Richard "Shred" Körber

See Also:
Serialized Form

Field Summary
- Fields inherited from class org.shredzone.flattr4j.model.Resource
  data

Constructor Summary

Constructors
Constructor and Description

Thing(FlattrObject data)

Constructors
Constructor and Description
`Thing(FlattrObject data)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTag(String tag)`
`boolean`	`equals(Object obj)`
`String`	`getCategoryId()` Category this Thing belongs to.
`int`	`getClicks()` How many times this Thing was flattred.
`Date`	`getCreated()` Creation date of the Thing.
`String`	`getDescription()` A descriptive text about the Thing.
`String`	`getImage()` URL of an image for this Thing.
`String`	`getLanguageId()` Language id of the Thing.
`Date`	`getLastFlattr()` Date of last Flattr.
`String`	`getLink()` Human readable link to this resource at Flattr.
`String`	`getQrPdfUrl()` Returns the URL of a PDF document containing a QR code of the Thing.
`String`	`getResource()` URL that returns details of this resource as JSON.
`List<String>`	`getTags()` Tags this Thing is tagged with.
`String`	`getThingId()` Thing's unique id at Flattr.
`String`	`getTitle()` Title of the Thing.
`Date`	`getUpdated()` Date of last Update.
`String`	`getUrl()` URL of the Thing.
`User`	`getUser()` User this Thing belongs to.
`String`	`getUserId()` User this Thing belongs to.
`int`	`hashCode()`
`boolean`	`isFlattred()` Is this Thing flattred?
`boolean`	`isHidden()` Is the Thing hidden from the public list of Things at Flattr?
`boolean`	`isSubscribed()` Is this Thing subscribed?
`void`	`merge(Submission submission)` Merges the contents of a submission to this `Thing`.
`void`	`setCategory(CategoryId category)`
`void`	`setDescription(String description)`
`void`	`setHidden(boolean hidden)`
`void`	`setLanguage(LanguageId language)`
`void`	`setTags(List<String> tags)`
`void`	`setTitle(String title)`
`FlattrObject`	`toUpdate()` Returns a `FlattrObject` for the updates that have been applied to this Thing.
`static ThingId`	`withId(String id)` Returns a `ThingId` for the given Thing id.

Methods inherited from class org.shredzone.flattr4j.model.Resource
toFlattrObject, toJSON

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Thing
```
public Thing(FlattrObject data)
```
- Method Detail
  - withId
```
public static ThingId withId(String id)
```
    Returns a ThingId for the given Thing id.
    
    Parameters:
    id - Thing id
    
    Returns:
    A ThingId object for this id
  - getThingId
```
public String getThingId()
```
    Thing's unique id at Flattr.
    
    Specified by:
    
    getThingId in interface ThingId
    
    Returns:
    Thing id
  - getResource
```
public String getResource()
```
    URL that returns details of this resource as JSON.
  - getLink
```
public String getLink()
```
    Human readable link to this resource at Flattr.
  - getCreated
```
public Date getCreated()
```
    Creation date of the Thing.
  - getClicks
```
public int getClicks()
```
    How many times this Thing was flattred.
  - getUrl
```
public String getUrl()
```
    URL of the Thing.
  - getTitle
```
public String getTitle()
```
    Title of the Thing.
  - setTitle
```
public void setTitle(String title)
```
  - getImage
```
public String getImage()
```
    URL of an image for this Thing. Empty string if there is none.
    
    Since:
    
    2.0
  - getUserId
```
public String getUserId()
```
    User this Thing belongs to.
    
    Specified by:
    
    getUserId in interface UserId
    
    Returns:
    User id
  - getUser
```
public User getUser()
```
    User this Thing belongs to.
    All properties are only available when the service was set to full mode!
    
    Since:
    
    2.2
  - getCategoryId
```
public String getCategoryId()
```
    Category this Thing belongs to.
    
    Specified by:
    
    getCategoryId in interface CategoryId
    
    Returns:
    Category id
  - setCategory
```
public void setCategory(CategoryId category)
```
  - getDescription
```
public String getDescription()
```
    A descriptive text about the Thing.
  - setDescription
```
public void setDescription(String description)
```
  - getTags
```
public List<String> getTags()
```
    Tags this Thing is tagged with.
  - setTags
```
public void setTags(List<String> tags)
```
  - addTag
```
public void addTag(String tag)
```
  - getLanguageId
```
public String getLanguageId()
```
    Language id of the Thing.
    
    Specified by:
    
    getLanguageId in interface LanguageId
    
    Returns:
    Language id
  - setLanguage
```
public void setLanguage(LanguageId language)
```
  - isHidden
```
public boolean isHidden()
```
    Is the Thing hidden from the public list of Things at Flattr?
  - setHidden
```
public void setHidden(boolean hidden)
```
  - isFlattred
```
public boolean isFlattred()
```
    Is this Thing flattred?
    
    Since:
    
    2.0
  - isSubscribed
```
public boolean isSubscribed()
```
    Is this Thing subscribed?
    
    Since:
    
    2.6
  - getLastFlattr
```
public Date getLastFlattr()
```
    Date of last Flattr. Only available to the owner of this Thing.
    
    Since:
    
    2.0
  - getUpdated
```
public Date getUpdated()
```
    Date of last Update. Only available to the owner of this Thing.
    
    Since:
    
    2.0
  - merge
```
public void merge(Submission submission)
```
    Merges the contents of a submission to this Thing. This method is useful if you want to modify an existing Thing by a Submission object.
    For all unset properties of Submission, the Thing properties are cleared. After merging, the Thing is in a state as if it was created with the given Submission. If you only want to change single properties of Thing, use the setters instead.
    NOTE: The URL of a Thing cannot be changed. The Submission object must contain either this Thing's URL or null (for convenience). Otherwise an IllegalArgumentException is thrown.
    
    Parameters:
    submission - Submission to merge
    Since:
    
    2.0
  - toUpdate
```
public FlattrObject toUpdate()
```
    Returns a FlattrObject for the updates that have been applied to this Thing.
    
    Returns:
    FlattrObject for the updates, or null if this Thing was not modified.
    Since:
    
    2.0
  - getQrPdfUrl
```
public String getQrPdfUrl()
```
    Returns the URL of a PDF document containing a QR code of the Thing. The PDF can be printed, sticked on the wall, and then flattered using a mobile phone.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Thing

Field Summary

Fields inherited from class org.shredzone.flattr4j.model.Resource

Constructor Summary

Method Summary

Methods inherited from class org.shredzone.flattr4j.model.Resource

Methods inherited from class java.lang.Object

Constructor Detail

Thing

Method Detail

withId

getThingId

getResource

getLink

getCreated

getClicks

getUrl

getTitle

setTitle

getImage

getUserId

getUser

getCategoryId

setCategory

getDescription

setDescription

getTags

setTags

addTag

getLanguageId

setLanguage

isHidden

setHidden

isFlattred

isSubscribed

getLastFlattr

getUpdated

merge

toUpdate

getQrPdfUrl

equals

hashCode