com.sap.cds.services.draft.Drafts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cds-services-api Show documentation

API of CDS Services Java

There is a newer version: 3.4.1

/**************************************************************************
 * (C) 2019-2024 SAP SE or an SAP affiliate company. All rights reserved. *
 **************************************************************************/
package com.sap.cds.services.draft;

import java.util.List;
import java.util.Map;

import com.sap.cds.CdsData;
import com.sap.cds.ql.CdsName;

/**
 * Interface for a draft enabled entity.
 */
public interface Drafts extends CdsData {

	String IS_ACTIVE_ENTITY = "IsActiveEntity";

	String HAS_ACTIVE_ENTITY = "HasActiveEntity";

	String HAS_DRAFT_ENTITY = "HasDraftEntity";

	String DRAFT_ADMINISTRATIVE_DATA_DRAFT_UUID = "DraftAdministrativeData_DraftUUID";

	String DRAFT_ADMINISTRATIVE_DATA = "DraftAdministrativeData";

	String SIBLING_ENTITY = "SiblingEntity";

	List ELEMENTS = List.of(IS_ACTIVE_ENTITY, HAS_ACTIVE_ENTITY,
			HAS_DRAFT_ENTITY, DRAFT_ADMINISTRATIVE_DATA_DRAFT_UUID,
			DRAFT_ADMINISTRATIVE_DATA, SIBLING_ENTITY);

	@CdsName(IS_ACTIVE_ENTITY)
	Boolean getIsActiveEntity();

	@CdsName(IS_ACTIVE_ENTITY)
	void setIsActiveEntity(Boolean isActiveEntity);

	@CdsName(HAS_ACTIVE_ENTITY)
	Boolean getHasActiveEntity();

	@CdsName(HAS_ACTIVE_ENTITY)
	void setHasActiveEntity(Boolean hasActiveEntity);

	@CdsName(HAS_DRAFT_ENTITY)
	Boolean getHasDraftEntity();

	@CdsName(HAS_DRAFT_ENTITY)
	void setHasDraftEntity(Boolean hasDraftEntity);

	@CdsName(SIBLING_ENTITY)
	Map getSiblingEntity();

	@CdsName(SIBLING_ENTITY)
	void setSiblingEntity(Map siblingEntity);

	@CdsName(DRAFT_ADMINISTRATIVE_DATA_DRAFT_UUID)
	String getDraftAdministrativeDataDraftUuid();

	@CdsName(DRAFT_ADMINISTRATIVE_DATA_DRAFT_UUID)
	void setDraftAdministrativeDataDraftUuid(String draftadministrativedataDraftuuid);

	@CdsName(DRAFT_ADMINISTRATIVE_DATA)
	DraftAdministrativeData getDraftAdministrativeData();

	@CdsName(DRAFT_ADMINISTRATIVE_DATA)
	void setDraftAdministrativeData(Map draftAdministrativeData);

}