001/*
002 * flattr4j - A Java library for Flattr
003 *
004 * Copyright (C) 2012 Richard "Shred" Körber
005 *   http://flattr4j.shredzone.org
006 *
007 * This program is free software: you can redistribute it and/or modify
008 * it under the terms of the GNU General Public License / GNU Lesser
009 * General Public License as published by the Free Software Foundation,
010 * either version 3 of the License, or (at your option) any later version.
011 *
012 * Licensed under the Apache License, Version 2.0 (the "License");
013 * you may not use this file except in compliance with the License.
014 *
015 * This program is distributed in the hope that it will be useful,
016 * but WITHOUT ANY WARRANTY; without even the implied warranty of
017 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
018 */
019package org.shredzone.flattr4j.model;
020
021import java.util.Date;
022
023import org.shredzone.flattr4j.connector.FlattrObject;
024
025/**
026 * A Subscription that was made to a thing.
027 * <p>
028 * This class is not threadsafe.
029 *
030 * @author Richard "Shred" Körber
031 * @since 2.6
032 */
033public class Subscription extends Resource implements ThingId {
034    private static final long serialVersionUID = -6970294508136441692L;
035
036    private transient Thing thing = null;
037
038    public Subscription(FlattrObject data) {
039        super(data);
040    }
041
042    /**
043     * The thing that was flattred.
044     */
045    public Thing getThing() {
046        if (thing == null) {
047            thing = new Thing(data.getFlattrObject("thing"));
048        }
049        return thing;
050    }
051
052    @Override
053    public String getThingId() {
054        return getThing().getThingId();
055    }
056
057    /**
058     * Creation date of the subscription.
059     */
060    public Date getCreated() {
061        return data.getDate("created_at");
062    }
063
064    /**
065     * Starting date of the subscription.
066     */
067    public Date getStarted() {
068        return data.getDate("started_at");
069    }
070
071    /**
072     * {@code true} if the subscription is currently active, {@code false} if it is
073     * paused.
074     */
075    public boolean isActive() {
076        return data.getBoolean("active");
077    }
078
079}