com.tenduke.events.api.model.data.LicenseFields 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 fields related and included to all licensing events.
 * @author roope
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public interface LicenseFields {

    /**
     * The license identifier.
     * @return the license id.
     */
    String getLicenseId();

    /**
     * The licensed item identifier.
     * @return the licensed item id.
     */
    String getLicensedItemId();

    /**
     * Unique id of entitlement that the license belongs to.
     * @return the entitlement id.
     */
    String getEntitlementId();

    /**
     * 
     * Id of organization owning the license.
     * 
     * 
     * License owner organization and license owner user are mutually exclusive,
     * only one of them is set.
     * 
     * @return the organization id.
     */
    String getLicenseOwnerOrganizationId();

    /**
     * 
     * Id of user owning the license.
     * 
     * 
     * License owner organization and license owner user are mutually exclusive,
     * only one of them is set.
     * 
     */
    String getLicenseOwnerUserId();
}