com.liferay.change.tracking.spi.display.CTDisplayRendererRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.change.tracking.spi Show documentation
Liferay Change Tracking SPI
The newest version!
/**
 * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
 * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
 */

package com.liferay.change.tracking.spi.display;

import com.liferay.change.tracking.model.CTCollection;
import com.liferay.change.tracking.model.CTEntry;
import com.liferay.portal.kernel.change.tracking.sql.CTSQLModeThreadLocal;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.model.BaseModel;
import com.liferay.portal.kernel.model.change.tracking.CTModel;
import com.liferay.portal.kernel.service.change.tracking.CTService;

import java.io.Serializable;

import java.util.Locale;
import java.util.Map;
import java.util.Set;

import javax.servlet.http.HttpServletRequest;

/**
 * @author Pei-Jung Lan
 */
public interface CTDisplayRendererRegistry {

	public > T fetchCTModel(
		long ctCollectionId, CTSQLModeThreadLocal.CTSQLMode ctSQLMode,
		long modelClassNameId, long modelClassPK);

	public > T fetchCTModel(
		long modelClassNameId, long modelClassPK);

	public > Map fetchCTModelMap(
		long ctCollectionId, CTSQLModeThreadLocal.CTSQLMode ctSQLMode,
		long modelClassNameId, Set primaryKeys);

	public > String[] getAvailableLanguageIds(
		long ctCollectionId, CTSQLModeThreadLocal.CTSQLMode ctSQLMode, T model,
		long modelClassNameId);

	public > int getChangeType(CTEntry ctEntry, T model);

	public long getCtCollectionId(CTCollection ctCollection, CTEntry ctEntry)
		throws PortalException;

	public > CTDisplayRenderer getCTDisplayRenderer(
		long modelClassNameId);

	public CTService getCTService(CTModel ctModel);

	public CTSQLModeThreadLocal.CTSQLMode getCTSQLMode(
		long ctCollectionId, CTEntry ctEntry);

	public > String getDefaultLanguageId(
		T model, long modelClassNameId);

	public > CTDisplayRenderer getDefaultRenderer();

	public > String getEditURL(
		HttpServletRequest httpServletRequest, CTEntry ctEntry);

	public > String getEditURL(
		long ctCollectionId, CTSQLModeThreadLocal.CTSQLMode ctsqlMode,
		HttpServletRequest httpServletRequest, T model, long modelClassNameId);

	public String getEntryDescription(
		HttpServletRequest httpServletRequest, CTEntry ctEntry);

	public > String getTitle(
		long ctCollectionId, CTEntry ctEntry, Locale locale);

	public > String getTitle(
		long ctCollectionId, CTSQLModeThreadLocal.CTSQLMode ctSQLMode,
		Locale locale, T model, long modelClassNameId);

	public > String getTypeName(
		Locale locale, long modelClassNameId);

	public > boolean isHideable(
		T model, long modelClassNameId);

	public > boolean isMovable(
		T model, long modelClassNameId);

	public > boolean isWorkflowEnabled(
		CTEntry ctEntry, T model);

}