com.liferay.portlet.assetpublisher.util
Interface AssetPublisher

public interface AssetPublisher

Author:

Eudaldo Alonso

Field Summary

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

void	addAndStoreSelection(javax.portlet.PortletRequest portletRequest, java.lang.String className, long classPK, int assetEntryOrder)
void	addRecentFolderId(javax.portlet.PortletRequest portletRequest, java.lang.String className, long classPK)
void	addSelection(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences portletPreferences, java.lang.String portletId)
void	addSelection(ThemeDisplay themeDisplay, javax.portlet.PortletPreferences portletPreferences, java.lang.String portletId, long assetEntryId, int assetEntryOrder, java.lang.String assetEntryType)
void	addUserAttributes(User user, java.lang.String[] customUserAttributeNames, AssetEntryQuery assetEntryQuery)
void	checkAssetEntries()
java.util.List<AssetEntry>	getAssetEntries(javax.portlet.PortletPreferences portletPreferences, Layout layout, long scopeGroupId, int max, boolean checkPermission)
java.util.List<AssetEntry>	getAssetEntries(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, long[] assetCategoryIds, java.lang.String[] assetEntryXmls, java.lang.String[] assetTagNames, boolean deleteMissingAssetEntries, boolean checkPermission)
java.util.List<AssetEntry>	getAssetEntries(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, java.lang.String[] assetEntryXmls, boolean deleteMissingAssetEntries, boolean checkPermission)
AssetEntryQuery	getAssetEntryQuery(javax.portlet.PortletPreferences portletPreferences, long[] scopeGroupIds)
java.lang.String[]	getAssetTagNames(javax.portlet.PortletPreferences portletPreferences, long scopeGroupId)
java.lang.String	getClassName(AssetRendererFactory assetRendererFactory)
long[]	getClassNameIds(javax.portlet.PortletPreferences portletPreferences, long[] availableClassNameIds)
java.lang.Long[]	getClassTypeIds(javax.portlet.PortletPreferences portletPreferences, java.lang.String className, java.lang.Long[] availableClassTypeIds)
java.util.Map<java.util.Locale,java.lang.String>	getEmailAssetEntryAddedBodyMap(javax.portlet.PortletPreferences portletPreferences)
boolean	getEmailAssetEntryAddedEnabled(javax.portlet.PortletPreferences portletPreferences)
java.util.Map<java.util.Locale,java.lang.String>	getEmailAssetEntryAddedSubjectMap(javax.portlet.PortletPreferences portletPreferences)
java.lang.String	getEmailFromAddress(javax.portlet.PortletPreferences portletPreferences, long companyId)
java.lang.String	getEmailFromName(javax.portlet.PortletPreferences portletPreferences, long companyId)
long	getGroupIdFromScopeId(java.lang.String scopeId, long siteGroupId, boolean privateLayout)
long[]	getGroupIds(javax.portlet.PortletPreferences portletPreferences, long scopeGroupId, Layout layout)
long	getRecentFolderId(javax.portlet.PortletRequest portletRequest, java.lang.String className)
java.lang.String	getScopeId(Group group, long scopeGroupId)
boolean	isScopeIdSelectable(PermissionChecker permissionChecker, java.lang.String scopeId, long companyGroupId, Layout layout)
boolean	isSubscribed(long companyId, long userId, long plid, java.lang.String portletId)
void	notifySubscribers(javax.portlet.PortletPreferences portletPreferences, long plid, java.lang.String portletId, java.util.List<AssetEntry> assetEntries)
void	processAssetEntryQuery(User user, javax.portlet.PortletPreferences portletPreferences, AssetEntryQuery assetEntryQuery)
void	registerAssetQueryProcessor(java.lang.String name, AssetEntryQueryProcessor assetQueryProcessor)
void	removeAndStoreSelection(java.util.List<java.lang.String> assetEntryUuids, javax.portlet.PortletPreferences portletPreferences)
void	removeRecentFolderId(javax.portlet.PortletRequest portletRequest, java.lang.String className, long classPK)
void	subscribe(PermissionChecker permissionChecker, long groupId, long plid, java.lang.String portletId)
void	unregisterAssetQueryProcessor(java.lang.String assetQueryProcessorClassName)
void	unsubscribe(PermissionChecker permissionChecker, long plid, java.lang.String portletId)

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

addAndStoreSelection

void addAndStoreSelection(javax.portlet.PortletRequest portletRequest,
                          java.lang.String className,
                          long classPK,
                          int assetEntryOrder)
                          throws java.lang.Exception

Throws:

java.lang.Exception

addRecentFolderId

void addRecentFolderId(javax.portlet.PortletRequest portletRequest,
                       java.lang.String className,
                       long classPK)

addSelection

void addSelection(javax.portlet.PortletRequest portletRequest,
                  javax.portlet.PortletPreferences portletPreferences,
                  java.lang.String portletId)
                  throws java.lang.Exception

Throws:

java.lang.Exception

addSelection

void addSelection(ThemeDisplay themeDisplay,
                  javax.portlet.PortletPreferences portletPreferences,
                  java.lang.String portletId,
                  long assetEntryId,
                  int assetEntryOrder,
                  java.lang.String assetEntryType)
                  throws java.lang.Exception

Throws:

java.lang.Exception

addUserAttributes

void addUserAttributes(User user,
                       java.lang.String[] customUserAttributeNames,
                       AssetEntryQuery assetEntryQuery)
                       throws java.lang.Exception

Throws:

java.lang.Exception

checkAssetEntries

void checkAssetEntries()
                       throws java.lang.Exception

Throws:

java.lang.Exception

getAssetEntries

java.util.List<AssetEntry> getAssetEntries(javax.portlet.PortletPreferences portletPreferences,
                                           Layout layout,
                                           long scopeGroupId,
                                           int max,
                                           boolean checkPermission)
                                           throws PortalException,
                                                  SystemException

Throws:

PortalException

SystemException

getAssetEntries

java.util.List<AssetEntry> getAssetEntries(javax.portlet.PortletRequest portletRequest,
                                           javax.portlet.PortletPreferences portletPreferences,
                                           PermissionChecker permissionChecker,
                                           long[] groupIds,
                                           long[] assetCategoryIds,
                                           java.lang.String[] assetEntryXmls,
                                           java.lang.String[] assetTagNames,
                                           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,
                                           java.lang.String[] assetEntryXmls,
                                           boolean deleteMissingAssetEntries,
                                           boolean checkPermission)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getAssetEntryQuery

AssetEntryQuery getAssetEntryQuery(javax.portlet.PortletPreferences portletPreferences,
                                   long[] scopeGroupIds)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getAssetTagNames

java.lang.String[] getAssetTagNames(javax.portlet.PortletPreferences portletPreferences,
                                    long scopeGroupId)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getClassName

java.lang.String getClassName(AssetRendererFactory assetRendererFactory)

getClassNameIds

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

getClassTypeIds

java.lang.Long[] getClassTypeIds(javax.portlet.PortletPreferences portletPreferences,
                                 java.lang.String className,
                                 java.lang.Long[] availableClassTypeIds)

getEmailAssetEntryAddedBodyMap

java.util.Map<java.util.Locale,java.lang.String> getEmailAssetEntryAddedBodyMap(javax.portlet.PortletPreferences portletPreferences)

getEmailAssetEntryAddedEnabled

boolean getEmailAssetEntryAddedEnabled(javax.portlet.PortletPreferences portletPreferences)

getEmailAssetEntryAddedSubjectMap

java.util.Map<java.util.Locale,java.lang.String> getEmailAssetEntryAddedSubjectMap(javax.portlet.PortletPreferences portletPreferences)

getEmailFromAddress

java.lang.String getEmailFromAddress(javax.portlet.PortletPreferences portletPreferences,
                                     long companyId)
                                     throws SystemException

Throws:

SystemException

getEmailFromName

java.lang.String getEmailFromName(javax.portlet.PortletPreferences portletPreferences,
                                  long companyId)
                                  throws SystemException

Throws:

SystemException

getGroupIdFromScopeId

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

Throws:

PortalException

SystemException

getGroupIds

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

getRecentFolderId

long getRecentFolderId(javax.portlet.PortletRequest portletRequest,
                       java.lang.String className)

getScopeId

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

Throws:

PortalException

SystemException

isScopeIdSelectable

boolean isScopeIdSelectable(PermissionChecker permissionChecker,
                            java.lang.String scopeId,
                            long companyGroupId,
                            Layout layout)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

isSubscribed

boolean isSubscribed(long companyId,
                     long userId,
                     long plid,
                     java.lang.String portletId)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

notifySubscribers

void notifySubscribers(javax.portlet.PortletPreferences portletPreferences,
                       long plid,
                       java.lang.String portletId,
                       java.util.List<AssetEntry> assetEntries)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

processAssetEntryQuery

void processAssetEntryQuery(User user,
                            javax.portlet.PortletPreferences portletPreferences,
                            AssetEntryQuery assetEntryQuery)
                            throws java.lang.Exception

Throws:

java.lang.Exception

registerAssetQueryProcessor

void registerAssetQueryProcessor(java.lang.String name,
                                 AssetEntryQueryProcessor assetQueryProcessor)

removeAndStoreSelection

void removeAndStoreSelection(java.util.List<java.lang.String> assetEntryUuids,
                             javax.portlet.PortletPreferences portletPreferences)
                             throws java.lang.Exception

Throws:

java.lang.Exception

removeRecentFolderId

void removeRecentFolderId(javax.portlet.PortletRequest portletRequest,
                          java.lang.String className,
                          long classPK)

subscribe

void subscribe(PermissionChecker permissionChecker,
               long groupId,
               long plid,
               java.lang.String portletId)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

unregisterAssetQueryProcessor

void unregisterAssetQueryProcessor(java.lang.String assetQueryProcessorClassName)

unsubscribe

void unsubscribe(PermissionChecker permissionChecker,
                 long plid,
                 java.lang.String portletId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException