EntityMeta.java

package fi.codecrew.moya.model;

import javax.json.JsonObject;

/**
 * Entities that have a JSON meta data column implement this interface.
 * 
 * Meta data can be just about anything that is not deemed to be essential
 * enough to have it's own column. Including people's shirt sizes etc.
 * 
 * @author jkj
 */
public interface EntityMeta {

    /**
     * Get JSON metadata associated with the entity.
     * 
     * @return JsonObject from meta column in DB.
     */
    public JsonObject getMeta();

    /**
     * Associate JSON metadata to entity.
     * 
     * @param meta
     *            JsonObject that goes into meta column in DB.
     */
    public void setMeta(JsonObject meta);
}