com.liferay.asset.publisher.util

Interface AssetPublisherHelper

@ProviderType
public interface AssetPublisherHelper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCOPE_ID_CHILD_GROUP_PREFIX
static java.lang.String	SCOPE_ID_GROUP_PREFIX
static java.lang.String	SCOPE_ID_LAYOUT_PREFIX
static java.lang.String	SCOPE_ID_LAYOUT_UUID_PREFIX
static java.lang.String	SCOPE_ID_PARENT_GROUP_PREFIX

Method Summary

Modifier and Type	Method and Description
long[]	getAssetCategoryIds(javax.portlet.PortletPreferences portletPreferences)
BaseModelSearchResult<AssetEntry>	getAssetEntries(AssetEntryQuery assetEntryQuery, Layout layout, javax.portlet.PortletPreferences portletPreferences, java.lang.String portletName, java.util.Locale locale, java.util.TimeZone timeZone, long companyId, long scopeGroupId, long userId, java.util.Map<java.lang.String,java.io.Serializable> attributes, int start, int end)
java.util.List<AssetEntry>	getAssetEntries(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, boolean deleteMissingAssetEntries, boolean checkPermission)
java.util.List<AssetEntry>	getAssetEntries(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, boolean deleteMissingAssetEntries, boolean checkPermission, boolean includeNonvisibleAssets)
java.util.List<AssetEntry>	getAssetEntries(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, boolean deleteMissingAssetEntries, boolean checkPermission, boolean includeNonvisibleAssets, int type)
java.util.List<AssetEntry>	getAssetEntries(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, long[] allCategoryIds, java.lang.String[] allTagNames, boolean deleteMissingAssetEntries, boolean checkPermission)
AssetEntryQuery	getAssetEntryQuery(javax.portlet.PortletPreferences portletPreferences, long groupId, Layout layout, long[] overrideAllAssetCategoryIds, java.lang.String[] overrideAllAssetTagNames)
AssetEntryQuery	getAssetEntryQuery(javax.portlet.PortletPreferences portletPreferences, long groupId, Layout layout, long[] overrideAllAssetCategoryIds, java.lang.String[] overrideAllAssetTagNames, java.lang.String[] overrideAllKeywords)
java.util.List<AssetEntryResult>	getAssetEntryResults(SearchContainer<AssetEntry> searchContainer, AssetEntryQuery assetEntryQuery, Layout layout, javax.portlet.PortletPreferences portletPreferences, java.lang.String portletName, java.util.Locale locale, java.util.TimeZone timeZone, long companyId, long scopeGroupId, long userId, long[] classNameIds, java.util.Map<java.lang.String,java.io.Serializable> attributes)
java.lang.String[]	getAssetTagNames(javax.portlet.PortletPreferences portletPreferences)
java.lang.String	getAssetViewURL(LiferayPortletRequest liferayPortletRequest, LiferayPortletResponse liferayPortletResponse, AssetEntry assetEntry)
java.lang.String	getAssetViewURL(LiferayPortletRequest liferayPortletRequest, LiferayPortletResponse liferayPortletResponse, AssetEntry assetEntry, boolean viewInContext)
java.lang.String	getAssetViewURL(LiferayPortletRequest liferayPortletRequest, LiferayPortletResponse liferayPortletResponse, AssetRenderer<?> assetRenderer, AssetEntry assetEntry, boolean viewInContext)
javax.portlet.PortletURL	getBaseAssetViewURL(LiferayPortletRequest liferayPortletRequest, LiferayPortletResponse liferayPortletResponse, AssetRenderer<?> assetRenderer, AssetEntry assetEntry)
long[]	getClassNameIds(javax.portlet.PortletPreferences portletPreferences, long[] availableClassNameIds)
long	getGroupIdFromScopeId(java.lang.String scopeId, long siteGroupId, boolean privateLayout)
long[]	getGroupIds(javax.portlet.PortletPreferences portletPreferences, long scopeGroupId, Layout layout)
java.lang.String[]	getKeywords(javax.portlet.PortletPreferences portletPreferences)
java.lang.String	getScopeId(Group group, long scopeGroupId)

Field Detail

SCOPE_ID_CHILD_GROUP_PREFIX

static final java.lang.String SCOPE_ID_CHILD_GROUP_PREFIX

See Also:

Constant Field Values

SCOPE_ID_GROUP_PREFIX

static final java.lang.String SCOPE_ID_GROUP_PREFIX

See Also:

Constant Field Values

SCOPE_ID_LAYOUT_PREFIX

static final java.lang.String SCOPE_ID_LAYOUT_PREFIX

See Also:

Constant Field Values

SCOPE_ID_LAYOUT_UUID_PREFIX

static final java.lang.String SCOPE_ID_LAYOUT_UUID_PREFIX

See Also:

Constant Field Values

SCOPE_ID_PARENT_GROUP_PREFIX

static final java.lang.String SCOPE_ID_PARENT_GROUP_PREFIX

See Also:

Constant Field Values

Method Detail

getAssetCategoryIds

long[] getAssetCategoryIds(javax.portlet.PortletPreferences portletPreferences)

getAssetEntries

BaseModelSearchResult<AssetEntry> getAssetEntries(AssetEntryQuery assetEntryQuery,
                                                  Layout layout,
                                                  javax.portlet.PortletPreferences portletPreferences,
                                                  java.lang.String portletName,
                                                  java.util.Locale locale,
                                                  java.util.TimeZone timeZone,
                                                  long companyId,
                                                  long scopeGroupId,
                                                  long userId,
                                                  java.util.Map<java.lang.String,java.io.Serializable> attributes,
                                                  int start,
                                                  int end)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getAssetEntries

java.util.List<AssetEntry> getAssetEntries(javax.portlet.PortletRequest portletRequest,
                                           javax.portlet.PortletPreferences portletPreferences,
                                           PermissionChecker permissionChecker,
                                           long[] groupIds,
                                           boolean deleteMissingAssetEntries,
                                           boolean checkPermission)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getAssetEntries

java.util.List<AssetEntry> getAssetEntries(javax.portlet.PortletRequest portletRequest,
                                           javax.portlet.PortletPreferences portletPreferences,
                                           PermissionChecker permissionChecker,
                                           long[] groupIds,
                                           boolean deleteMissingAssetEntries,
                                           boolean checkPermission,
                                           boolean includeNonvisibleAssets)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getAssetEntries

java.util.List<AssetEntry> getAssetEntries(javax.portlet.PortletRequest portletRequest,
                                           javax.portlet.PortletPreferences portletPreferences,
                                           PermissionChecker permissionChecker,
                                           long[] groupIds,
                                           boolean deleteMissingAssetEntries,
                                           boolean checkPermission,
                                           boolean includeNonvisibleAssets,
                                           int type)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getAssetEntries

java.util.List<AssetEntry> getAssetEntries(javax.portlet.PortletRequest portletRequest,
                                           javax.portlet.PortletPreferences portletPreferences,
                                           PermissionChecker permissionChecker,
                                           long[] groupIds,
                                           long[] allCategoryIds,
                                           java.lang.String[] allTagNames,
                                           boolean deleteMissingAssetEntries,
                                           boolean checkPermission)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getAssetEntryQuery

AssetEntryQuery getAssetEntryQuery(javax.portlet.PortletPreferences portletPreferences,
                                   long groupId,
                                   Layout layout,
                                   long[] overrideAllAssetCategoryIds,
                                   java.lang.String[] overrideAllAssetTagNames)
                            throws PortalException

Throws:

PortalException

getAssetEntryQuery

AssetEntryQuery getAssetEntryQuery(javax.portlet.PortletPreferences portletPreferences,
                                   long groupId,
                                   Layout layout,
                                   long[] overrideAllAssetCategoryIds,
                                   java.lang.String[] overrideAllAssetTagNames,
                                   java.lang.String[] overrideAllKeywords)
                            throws PortalException

Throws:

PortalException

getAssetEntryResults

java.util.List<AssetEntryResult> getAssetEntryResults(SearchContainer<AssetEntry> searchContainer,
                                                      AssetEntryQuery assetEntryQuery,
                                                      Layout layout,
                                                      javax.portlet.PortletPreferences portletPreferences,
                                                      java.lang.String portletName,
                                                      java.util.Locale locale,
                                                      java.util.TimeZone timeZone,
                                                      long companyId,
                                                      long scopeGroupId,
                                                      long userId,
                                                      long[] classNameIds,
                                                      java.util.Map<java.lang.String,java.io.Serializable> attributes)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getAssetTagNames

java.lang.String[] getAssetTagNames(javax.portlet.PortletPreferences portletPreferences)

getAssetViewURL

java.lang.String getAssetViewURL(LiferayPortletRequest liferayPortletRequest,
                                 LiferayPortletResponse liferayPortletResponse,
                                 AssetEntry assetEntry)

getAssetViewURL

java.lang.String getAssetViewURL(LiferayPortletRequest liferayPortletRequest,
                                 LiferayPortletResponse liferayPortletResponse,
                                 AssetEntry assetEntry,
                                 boolean viewInContext)

getAssetViewURL

java.lang.String getAssetViewURL(LiferayPortletRequest liferayPortletRequest,
                                 LiferayPortletResponse liferayPortletResponse,
                                 AssetRenderer<?> assetRenderer,
                                 AssetEntry assetEntry,
                                 boolean viewInContext)

getBaseAssetViewURL

javax.portlet.PortletURL getBaseAssetViewURL(LiferayPortletRequest liferayPortletRequest,
                                             LiferayPortletResponse liferayPortletResponse,
                                             AssetRenderer<?> assetRenderer,
                                             AssetEntry assetEntry)

getClassNameIds

long[] getClassNameIds(javax.portlet.PortletPreferences portletPreferences,
                       long[] availableClassNameIds)

getGroupIdFromScopeId

long getGroupIdFromScopeId(java.lang.String scopeId,
                           long siteGroupId,
                           boolean privateLayout)
                    throws PortalException

Throws:

PortalException

getGroupIds

long[] getGroupIds(javax.portlet.PortletPreferences portletPreferences,
                   long scopeGroupId,
                   Layout layout)

getKeywords

java.lang.String[] getKeywords(javax.portlet.PortletPreferences portletPreferences)

getScopeId

java.lang.String getScopeId(Group group,
                            long scopeGroupId)