com.tenduke.events.api.model.data.UserIdFields Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of events-api Show documentation

Objects and interfaces describing data communicated in the 10Duke Event Data system API

There is a newer version: 1.9.0

package com.tenduke.events.api.model.data;

import com.fasterxml.jackson.annotation.JsonInclude;

/**
 * Event data user identification fields.
 * @author jarkko
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public interface UserIdFields {

    /**
     * Indicates if the user is a technical user. THIS FIELD TO BE DEPRECATED AS BEING REPLACED WITH userType. 
     * @return {@code true} if {@code userId} is known to refer to a technical user.
     *
     */
    Boolean isTechnicalUser();

    /**
     * 
     * Gets identifier of the user in the client system.
     * 
     * 
     * This user id should be permanent.
     * 
     * @return The client user id.
     */
    String getUserId();

    /**
     * 
     * Gets type of the user.
     * 
     * 
     * 
     * @return The user type.
     */
    String getUserType();
}