com.tenduke.events.api.model.data.LicenseProvisionFields 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;
import java.util.Date;

/**
 * Event data fields for license operations that contain creation and provision data.
 * @author roope
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public interface LicenseProvisionFields extends LicenseFields {

    /**
     * Gets number of license seats.
     * @return Number of license seats licensed by this object, null for unlimited number of seats.
     */
    Integer getSeatCount();

    /**
     * Gets maximum aggregate use time of licenses that users may consume together.
     * @return maximum aggregate use time of licenses that users may consume together.
     */
    Long getUseTime();

    /**
     * Gets the maximum number of times a license can be used.
     * @return The maximum use count.
     */
    Long getUseCount();


    /**
     * Gets the license validity start date.
     * @return License validity start date. If null, the license is not considered valid.
     */
    Date getValidFrom();

    /**
     * Gets the license validity end date.
     * @return License end date. If null, the license is considered perpetual (no fixed end date).
     */
    Date getValidUntil();
}