Liferay 7.0-ce-m3

com.liferay.portlet.assetpublisher.util
Interface AssetPublisher

All Known Implementing Classes:
AssetPublisherImpl

@ProviderType
public interface AssetPublisher


Field Summary
static String SCOPE_ID_CHILD_GROUP_PREFIX
           
static String SCOPE_ID_GROUP_PREFIX
           
static String SCOPE_ID_LAYOUT_PREFIX
           
static String SCOPE_ID_LAYOUT_UUID_PREFIX
           
static String SCOPE_ID_PARENT_GROUP_PREFIX
           
 
Method Summary
 void addAndStoreSelection(PortletRequest portletRequest, String className, long classPK, int assetEntryOrder)
           
 void addRecentFolderId(PortletRequest portletRequest, String className, long classPK)
           
 void addSelection(PortletRequest portletRequest, PortletPreferences portletPreferences, String portletId)
           
 void addSelection(ThemeDisplay themeDisplay, PortletPreferences portletPreferences, String portletId, long assetEntryId, int assetEntryOrder, String assetEntryType)
           
 void addUserAttributes(User user, String[] customUserAttributeNames, AssetEntryQuery assetEntryQuery)
           
 void checkAssetEntries()
           
 long[] getAssetCategoryIds(PortletPreferences portletPreferences)
           
 List<AssetEntry> getAssetEntries(long[] groupIds, long[] classNameIds, String keywords, String userName, String title, String description, boolean advancedSearch, boolean andOperator, int start, int end, String orderByCol1, String orderByCol2, String orderByType1, String orderByType2)
           
 List<AssetEntry> getAssetEntries(PortletPreferences portletPreferences, Layout layout, long scopeGroupId, int max, boolean checkPermission)
           
 List<AssetEntry> getAssetEntries(PortletRequest portletRequest, PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, boolean deleteMissingAssetEntries, boolean checkPermission)
           
 List<AssetEntry> getAssetEntries(PortletRequest portletRequest, PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, long[] allCategoryIds, String[] allTagNames, boolean deleteMissingAssetEntries, boolean checkPermission)
           
 List<AssetEntry> getAssetEntries(PortletRequest portletRequest, PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, long[] assetCategoryIds, String[] assetEntryXmls, String[] assetTagNames, boolean deleteMissingAssetEntries, boolean checkPermission)
          Deprecated. As of 7.0.0, replaced by getAssetEntries( PortletRequest, PortletPreferences, PermissionChecker, long[], long[], String[], boolean , boolean)
 List<AssetEntry> getAssetEntries(PortletRequest portletRequest, PortletPreferences portletPreferences, PermissionChecker permissionChecker, long[] groupIds, String[] assetEntryXmls, boolean deleteMissingAssetEntries, boolean checkPermission)
          Deprecated. As of 7.0.0, replaced by getAssetEntries( PortletRequest, PortletPreferences, PermissionChecker, long[], boolean, boolean)
 int getAssetEntriesCount(long[] groupIds, long[] classNameIds, String keywords, String userName, String title, String description, boolean advancedSearch, boolean andOperator, int start, int end)
           
 AssetEntryQuery getAssetEntryQuery(PortletPreferences portletPreferences, long[] siteGroupIds)
          Deprecated. As of 7.0.0, replaced by getAssetEntryQuery(PortletPreferences, long[], long[], String[])
 AssetEntryQuery getAssetEntryQuery(PortletPreferences portletPreferences, long[] scopeGroupIds, long[] overrideAllAssetCategoryIds, String[] overrideAllAssetTagNames)
           
 String[] getAssetTagNames(PortletPreferences portletPreferences)
           
 String[] getAssetTagNames(PortletPreferences portletPreferences, long scopeGroupId)
          Deprecated. As of 7.0.0, replaced by getAssetTagNames(PortletPreferences)
 String getClassName(AssetRendererFactory assetRendererFactory)
           
 long[] getClassNameIds(PortletPreferences portletPreferences, long[] availableClassNameIds)
           
 Long[] getClassTypeIds(PortletPreferences portletPreferences, String className, List<ClassType> availableClassTypes)
           
 Long[] getClassTypeIds(PortletPreferences portletPreferences, String className, Long[] availableClassTypeIds)
           
 Map<Locale,String> getEmailAssetEntryAddedBodyMap(PortletPreferences portletPreferences)
           
 boolean getEmailAssetEntryAddedEnabled(PortletPreferences portletPreferences)
           
 Map<Locale,String> getEmailAssetEntryAddedSubjectMap(PortletPreferences portletPreferences)
           
 Map<String,String> getEmailDefinitionTerms(PortletRequest portletRequest, String emailFromAddress, String emailFromName)
           
 String getEmailFromAddress(PortletPreferences portletPreferences, long companyId)
           
 String getEmailFromName(PortletPreferences portletPreferences, long companyId)
           
 long getGroupIdFromScopeId(String scopeId, long siteGroupId, boolean privateLayout)
           
 long[] getGroupIds(PortletPreferences portletPreferences, long scopeGroupId, Layout layout)
           
 long getRecentFolderId(PortletRequest portletRequest, String className)
           
 String getScopeId(Group group, long scopeGroupId)
           
 long getSubscriptionClassPK(long plid, String portletId)
           
 boolean isScopeIdSelectable(PermissionChecker permissionChecker, String scopeId, long companyGroupId, Layout layout)
           
 boolean isSubscribed(long companyId, long userId, long plid, String portletId)
           
 void notifySubscribers(PortletPreferences portletPreferences, long plid, String portletId, List<AssetEntry> assetEntries)
           
 void processAssetEntryQuery(User user, PortletPreferences portletPreferences, AssetEntryQuery assetEntryQuery)
           
 void registerAssetQueryProcessor(String name, AssetEntryQueryProcessor assetQueryProcessor)
           
 void removeAndStoreSelection(List<String> assetEntryUuids, PortletPreferences portletPreferences)
           
 void removeRecentFolderId(PortletRequest portletRequest, String className, long classPK)
           
 void subscribe(PermissionChecker permissionChecker, long groupId, long plid, String portletId)
           
 void unregisterAssetQueryProcessor(String assetQueryProcessorClassName)
           
 void unsubscribe(PermissionChecker permissionChecker, long plid, String portletId)
           
 

Field Detail

SCOPE_ID_CHILD_GROUP_PREFIX

static final String SCOPE_ID_CHILD_GROUP_PREFIX
See Also:
Constant Field Values

SCOPE_ID_GROUP_PREFIX

static final String SCOPE_ID_GROUP_PREFIX
See Also:
Constant Field Values

SCOPE_ID_LAYOUT_PREFIX

static final String SCOPE_ID_LAYOUT_PREFIX
See Also:
Constant Field Values

SCOPE_ID_LAYOUT_UUID_PREFIX

static final String SCOPE_ID_LAYOUT_UUID_PREFIX
See Also:
Constant Field Values

SCOPE_ID_PARENT_GROUP_PREFIX

static final String SCOPE_ID_PARENT_GROUP_PREFIX
See Also:
Constant Field Values
Method Detail

addAndStoreSelection

void addAndStoreSelection(PortletRequest portletRequest,
                          String className,
                          long classPK,
                          int assetEntryOrder)
                          throws Exception
Throws:
Exception

addRecentFolderId

void addRecentFolderId(PortletRequest portletRequest,
                       String className,
                       long classPK)

addSelection

void addSelection(PortletRequest portletRequest,
                  PortletPreferences portletPreferences,
                  String portletId)
                  throws Exception
Throws:
Exception

addSelection

void addSelection(ThemeDisplay themeDisplay,
                  PortletPreferences portletPreferences,
                  String portletId,
                  long assetEntryId,
                  int assetEntryOrder,
                  String assetEntryType)
                  throws Exception
Throws:
Exception

addUserAttributes

void addUserAttributes(User user,
                       String[] customUserAttributeNames,
                       AssetEntryQuery assetEntryQuery)
                       throws Exception
Throws:
Exception

checkAssetEntries

void checkAssetEntries()
                       throws Exception
Throws:
Exception

getAssetCategoryIds

long[] getAssetCategoryIds(PortletPreferences portletPreferences)
                           throws Exception
Throws:
Exception

getAssetEntries

List<AssetEntry> getAssetEntries(long[] groupIds,
                                 long[] classNameIds,
                                 String keywords,
                                 String userName,
                                 String title,
                                 String description,
                                 boolean advancedSearch,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 String orderByCol1,
                                 String orderByCol2,
                                 String orderByType1,
                                 String orderByType2)

getAssetEntries

List<AssetEntry> getAssetEntries(PortletPreferences portletPreferences,
                                 Layout layout,
                                 long scopeGroupId,
                                 int max,
                                 boolean checkPermission)
                                 throws PortalException
Throws:
PortalException

getAssetEntries

List<AssetEntry> getAssetEntries(PortletRequest portletRequest,
                                 PortletPreferences portletPreferences,
                                 PermissionChecker permissionChecker,
                                 long[] groupIds,
                                 boolean deleteMissingAssetEntries,
                                 boolean checkPermission)
                                 throws Exception
Throws:
Exception

getAssetEntries

List<AssetEntry> getAssetEntries(PortletRequest portletRequest,
                                 PortletPreferences portletPreferences,
                                 PermissionChecker permissionChecker,
                                 long[] groupIds,
                                 long[] allCategoryIds,
                                 String[] allTagNames,
                                 boolean deleteMissingAssetEntries,
                                 boolean checkPermission)
                                 throws Exception
Throws:
Exception

getAssetEntries

@Deprecated
List<AssetEntry> getAssetEntries(PortletRequest portletRequest,
                                            PortletPreferences portletPreferences,
                                            PermissionChecker permissionChecker,
                                            long[] groupIds,
                                            long[] assetCategoryIds,
                                            String[] assetEntryXmls,
                                            String[] assetTagNames,
                                            boolean deleteMissingAssetEntries,
                                            boolean checkPermission)
                                 throws Exception
Deprecated. As of 7.0.0, replaced by getAssetEntries( PortletRequest, PortletPreferences, PermissionChecker, long[], long[], String[], boolean , boolean)

Throws:
Exception

getAssetEntries

@Deprecated
List<AssetEntry> getAssetEntries(PortletRequest portletRequest,
                                            PortletPreferences portletPreferences,
                                            PermissionChecker permissionChecker,
                                            long[] groupIds,
                                            String[] assetEntryXmls,
                                            boolean deleteMissingAssetEntries,
                                            boolean checkPermission)
                                 throws Exception
Deprecated. As of 7.0.0, replaced by getAssetEntries( PortletRequest, PortletPreferences, PermissionChecker, long[], boolean, boolean)

Throws:
Exception

getAssetEntriesCount

int getAssetEntriesCount(long[] groupIds,
                         long[] classNameIds,
                         String keywords,
                         String userName,
                         String title,
                         String description,
                         boolean advancedSearch,
                         boolean andOperator,
                         int start,
                         int end)

getAssetEntryQuery

@Deprecated
AssetEntryQuery getAssetEntryQuery(PortletPreferences portletPreferences,
                                              long[] siteGroupIds)
                                   throws PortalException
Deprecated. As of 7.0.0, replaced by getAssetEntryQuery(PortletPreferences, long[], long[], String[])

Throws:
PortalException

getAssetEntryQuery

AssetEntryQuery getAssetEntryQuery(PortletPreferences portletPreferences,
                                   long[] scopeGroupIds,
                                   long[] overrideAllAssetCategoryIds,
                                   String[] overrideAllAssetTagNames)
                                   throws PortalException
Throws:
PortalException

getAssetTagNames

String[] getAssetTagNames(PortletPreferences portletPreferences)
                          throws Exception
Throws:
Exception

getAssetTagNames

@Deprecated
String[] getAssetTagNames(PortletPreferences portletPreferences,
                                     long scopeGroupId)
                          throws Exception
Deprecated. As of 7.0.0, replaced by getAssetTagNames(PortletPreferences)

Throws:
Exception

getClassName

String getClassName(AssetRendererFactory assetRendererFactory)

getClassNameIds

long[] getClassNameIds(PortletPreferences portletPreferences,
                       long[] availableClassNameIds)

getClassTypeIds

Long[] getClassTypeIds(PortletPreferences portletPreferences,
                       String className,
                       List<ClassType> availableClassTypes)

getClassTypeIds

Long[] getClassTypeIds(PortletPreferences portletPreferences,
                       String className,
                       Long[] availableClassTypeIds)

getEmailAssetEntryAddedBodyMap

Map<Locale,String> getEmailAssetEntryAddedBodyMap(PortletPreferences portletPreferences)

getEmailAssetEntryAddedEnabled

boolean getEmailAssetEntryAddedEnabled(PortletPreferences portletPreferences)

getEmailAssetEntryAddedSubjectMap

Map<Locale,String> getEmailAssetEntryAddedSubjectMap(PortletPreferences portletPreferences)

getEmailDefinitionTerms

Map<String,String> getEmailDefinitionTerms(PortletRequest portletRequest,
                                           String emailFromAddress,
                                           String emailFromName)

getEmailFromAddress

String getEmailFromAddress(PortletPreferences portletPreferences,
                           long companyId)

getEmailFromName

String getEmailFromName(PortletPreferences portletPreferences,
                        long companyId)

getGroupIdFromScopeId

long getGroupIdFromScopeId(String scopeId,
                           long siteGroupId,
                           boolean privateLayout)
                           throws PortalException
Throws:
PortalException

getGroupIds

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

getRecentFolderId

long getRecentFolderId(PortletRequest portletRequest,
                       String className)

getScopeId

String getScopeId(Group group,
                  long scopeGroupId)
                  throws PortalException
Throws:
PortalException

getSubscriptionClassPK

long getSubscriptionClassPK(long plid,
                            String portletId)
                            throws PortalException
Throws:
PortalException

isScopeIdSelectable

boolean isScopeIdSelectable(PermissionChecker permissionChecker,
                            String scopeId,
                            long companyGroupId,
                            Layout layout)
                            throws PortalException
Throws:
PortalException

isSubscribed

boolean isSubscribed(long companyId,
                     long userId,
                     long plid,
                     String portletId)
                     throws PortalException
Throws:
PortalException

notifySubscribers

void notifySubscribers(PortletPreferences portletPreferences,
                       long plid,
                       String portletId,
                       List<AssetEntry> assetEntries)
                       throws PortalException
Throws:
PortalException

processAssetEntryQuery

void processAssetEntryQuery(User user,
                            PortletPreferences portletPreferences,
                            AssetEntryQuery assetEntryQuery)
                            throws Exception
Throws:
Exception

registerAssetQueryProcessor

void registerAssetQueryProcessor(String name,
                                 AssetEntryQueryProcessor assetQueryProcessor)

removeAndStoreSelection

void removeAndStoreSelection(List<String> assetEntryUuids,
                             PortletPreferences portletPreferences)
                             throws Exception
Throws:
Exception

removeRecentFolderId

void removeRecentFolderId(PortletRequest portletRequest,
                          String className,
                          long classPK)

subscribe

void subscribe(PermissionChecker permissionChecker,
               long groupId,
               long plid,
               String portletId)
               throws PortalException
Throws:
PortalException

unregisterAssetQueryProcessor

void unregisterAssetQueryProcessor(String assetQueryProcessorClassName)

unsubscribe

void unsubscribe(PermissionChecker permissionChecker,
                 long plid,
                 String portletId)
                 throws PortalException
Throws:
PortalException

Liferay 7.0-ce-m3