com.formkiq.server.service.SystemPropertyService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of formkiq-server Show documentation

Server-side integration for the FormKiQ ios application

There is a newer version: 0.6.1

package com.formkiq.server.service;

import com.formkiq.server.domain.type.SystemPropertyListDTO;

/**
 * Lookup for System Properties.
 *
 */
public interface SystemPropertyService {

    /** Hostname property. */
    String KEY_HOSTNAME = "hostname";

    /** Version property. */
    String KEY_VERSION = "version";

    /** Version property. */
    String INVITE_ONLY = "inviteonly";

    /**
     * Delete Key.
     * @param key {@link String}
     */
    void delete(String key);

    /**
     * Get Properties.
     * @return {@link SystemPropertyListDTO}
     */
    SystemPropertyListDTO getProperties();

    /**
     * @return {@link String}
     */
    String getSystemHostname();

    /**
     * System Version Number.
     * @return {@link String}
     */
    String getVersion();

    /**
     * Whether system is invite only.
     * @return boolean
     */
    boolean isInviteOnly();

    /**
     * Save System Property.
     * @param key {@link String}
     * @param value {@link String}
     */
    void save(String key, String value);

    /**
     * Sets invite only flag.
     * @param inviteOnly boolean
     */
    void setInviteOnly(boolean inviteOnly);

    /**
     * Sets System Host name.
     * @param hostname {@link String}
     */
    void setSystemHostname(String hostname);
}