/*
 * Copyright (C) 2014 Jan Pokorsky
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package cz.cas.lib.proarc.webapp.server.rest;

import cz.cas.lib.proarc.common.user.UserProfile;
import cz.cas.lib.proarc.webapp.shared.rest.UserResourceApi;
import java.net.URI;
import java.sql.Timestamp;
import java.util.Date;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;

/**
 * Helper class to annotate {@link UserProfile} properties.
 *
 * @see JacksonProvider
 *
 * @author Jan Pokorsky
 */
@XmlAccessorType(XmlAccessType.NONE)
public abstract class AnnotatedUser extends UserProfile {

    @XmlElement(name = UserResourceApi.USER_ID)
    @Override
    public abstract Integer getId();

    @XmlElement(name = UserResourceApi.USER_HOME)
    @Override
    public abstract String getUserHome();

    @XmlElement(name = UserResourceApi.USER_NAME)
    @Override
    public abstract String getUserName();

    @XmlElement(name = UserResourceApi.USER_REMOTENAME)
    @Override
    public abstract String getRemoteName();

    @XmlElement(name = UserResourceApi.USER_REMOTETYPE)
    @Override
    public abstract String getRemoteType();

    @XmlElement(name = UserResourceApi.USER_CREATED)
    @Override
    public abstract Date getCreated();

    @XmlElement(name = UserResourceApi.USER_EMAIL)
    @Override
    public abstract String getEmail();

    @XmlElement(name = UserResourceApi.USER_FORENAME)
    @Override
    public abstract String getForename();

    @XmlElement(name = UserResourceApi.USER_SURNAME)
    @Override
    public abstract String getSurname();

    @XmlElement(name = UserResourceApi.USER_LASTLOGIN)
    @Override
    public abstract Date getLastLogin();

    @XmlElement(name = UserResourceApi.USER_STATUS)
    @Override
    public abstract String getStatus();

    @XmlElement(name = UserResourceApi.USER_DEFAULTGROUP)
    @Override
    public abstract Integer getDefaultGroup();

    @XmlElement(name = UserResourceApi.USER_USERGROUP)
    @Override
    public abstract Integer getUserGroup();

    @XmlElement(name = UserResourceApi.USER_TIMESTAMP)
    @Override
    public abstract Timestamp getTimestamp();

    @XmlTransient
    @Override
    public abstract URI getImportFolder();

    @XmlTransient
    @Override
    public abstract URI getExportFolder();

    @XmlTransient
    @Override
    public abstract String getUserNameAsPid();

    @XmlTransient
    @Override
    public abstract String getUserPassword();

    @XmlTransient
    @Override
    public abstract String getUserPasswordDigest();

}