fr.ird.observe.entities.referential.ReferentialEntity Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-persistence Show documentation

ObServe Toolkit Common Persistence module

There is a newer version: 4.34

package fr.ird.observe.entities.referential;

/*-
 * #%L
 * ObServe Toolkit :: Common Persistence
 * %%
 * Copyright (C) 2017 - 2020 IRD, Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import fr.ird.observe.dto.reference.ReferentialDtoReference;
import fr.ird.observe.dto.reference.ReferentialDtoReferenceAware;
import fr.ird.observe.dto.referential.ReferenceStatus;
import fr.ird.observe.dto.referential.ReferentialDto;
import fr.ird.observe.dto.referential.ReferentialLocale;
import fr.ird.observe.entities.EntityToDto;

public interface ReferentialEntity> extends EntityToDto, ReferentialDtoReferenceAware {

    String PROPERTY_CODE = "code";

    String PROPERTY_URI = "uri";

    String PROPERTY_NEED_COMMENT = "needComment";

    String PROPERTY_STATUS = "status";

    String getCode();

    void setCode(String code);

    String getUri();

    void setUri(String uri);

    boolean isNeedComment();

    void setNeedComment(boolean needComment);

    ReferenceStatus getStatus();

    void setStatus(ReferenceStatus status);

     void fromDto(ReferentialLocale referentialLocale, D dto);

     void toDto(ReferentialLocale referentialLocale, D dto);

    default boolean isEnabled() {
        return ReferenceStatus.enabled == getStatus();
    }

    default boolean isDisabled() {
        return ReferenceStatus.disabled == getStatus();
    }

}