Liferay 6.0.5

com.liferay.portlet.asset.service
Interface AssetEntryLocalService

All Known Implementing Classes:
AssetEntryLocalServiceBaseImpl, AssetEntryLocalServiceImpl, AssetEntryLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AssetEntryLocalService

The interface for the asset entry local service.

Never modify or reference this interface directly. Always use AssetEntryLocalServiceUtil to access the asset entry local service. Add custom service methods to AssetEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
AssetEntryLocalServiceUtil, AssetEntryLocalServiceBaseImpl, AssetEntryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 AssetEntry addAssetEntry(AssetEntry assetEntry)
          Adds the asset entry to the database.
 AssetEntry createAssetEntry(long entryId)
          Creates a new asset entry with the primary key.
 void deleteAssetEntry(AssetEntry assetEntry)
          Deletes the asset entry from the database.
 void deleteAssetEntry(long entryId)
          Deletes the asset entry with the primary key from the database.
 void deleteEntry(AssetEntry entry)
           
 void deleteEntry(long entryId)
           
 void deleteEntry(String className, long classPK)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 List<AssetEntry> getAncestorEntries(long entryId)
           
 List<AssetEntry> getAssetEntries(int start, int end)
          Gets a range of all the asset entries.
 int getAssetEntriesCount()
          Gets the number of asset entries.
 AssetEntry getAssetEntry(long entryId)
          Gets the asset entry with the primary key.
 List<AssetEntry> getChildEntries(long entryId)
           
 List<AssetEntry> getCompanyEntries(long companyId, int start, int end)
           
 int getCompanyEntriesCount(long companyId)
           
 AssetEntryDisplay[] getCompanyEntryDisplays(long companyId, int start, int end, String languageId)
           
 List<AssetEntry> getEntries(AssetEntryQuery entryQuery)
           
 int getEntriesCount(AssetEntryQuery entryQuery)
           
 AssetEntry getEntry(long entryId)
           
 AssetEntry getEntry(long groupId, String classUuid)
           
 AssetEntry getEntry(String className, long classPK)
           
 AssetEntry getNextEntry(long entryId)
           
 AssetEntry getParentEntry(long entryId)
           
 AssetEntry getPreviousEntry(long entryId)
           
 List<AssetEntry> getTopViewedEntries(String[] className, boolean asc, int start, int end)
           
 List<AssetEntry> getTopViewedEntries(String className, boolean asc, int start, int end)
           
 void incrementViewCounter(long userId, String className, long classPK)
           
 void incrementViewCounter(long userId, String className, long classPK, int increment)
           
 Hits search(long companyId, long[] groupIds, String portletId, String userName, String title, String description, String assetCategoryIds, String assetTagNames, boolean andSearch, int start, int end)
           
 Hits search(long companyId, String portletId, String keywords, int start, int end)
           
 AssetEntryDisplay[] searchEntryDisplays(long companyId, String portletId, String keywords, String languageId, int start, int end)
           
 int searchEntryDisplaysCount(long companyId, String portletId, String keywords, String languageId)
           
 AssetEntry updateAssetEntry(AssetEntry assetEntry)
          Updates the asset entry in the database.
 AssetEntry updateAssetEntry(AssetEntry assetEntry, boolean merge)
          Updates the asset entry in the database.
 AssetEntry updateEntry(long userId, long groupId, String className, long classPK, long[] categoryIds, String[] tagNames)
           
 AssetEntry updateEntry(long userId, long groupId, String className, long classPK, String classUuid, long[] categoryIds, String[] tagNames, boolean visible, Date startDate, Date endDate, Date publishDate, Date expirationDate, String mimeType, String title, String description, String summary, String url, int height, int width, Integer priority, boolean sync)
           
 AssetEntry updateVisible(String className, long classPK, boolean visible)
           
 void validate(String className, long[] categoryIds, String[] tagNames)
           
 

Method Detail

addAssetEntry

AssetEntry addAssetEntry(AssetEntry assetEntry)
                         throws SystemException
Adds the asset entry to the database. Also notifies the appropriate model listeners.

Parameters:
assetEntry - the asset entry to add
Returns:
the asset entry that was added
Throws:
SystemException - if a system exception occurred

createAssetEntry

AssetEntry createAssetEntry(long entryId)
Creates a new asset entry with the primary key. Does not add the asset entry to the database.

Parameters:
entryId - the primary key for the new asset entry
Returns:
the new asset entry

deleteAssetEntry

void deleteAssetEntry(long entryId)
                      throws PortalException,
                             SystemException
Deletes the asset entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
entryId - the primary key of the asset entry to delete
Throws:
PortalException - if a asset entry with the primary key could not be found
SystemException - if a system exception occurred

deleteAssetEntry

void deleteAssetEntry(AssetEntry assetEntry)
                      throws SystemException
Deletes the asset entry from the database. Also notifies the appropriate model listeners.

Parameters:
assetEntry - the asset entry to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getAssetEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntry getAssetEntry(long entryId)
                         throws PortalException,
                                SystemException
Gets the asset entry with the primary key.

Parameters:
entryId - the primary key of the asset entry to get
Returns:
the asset entry
Throws:
PortalException - if a asset entry with the primary key could not be found
SystemException - if a system exception occurred

getAssetEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetEntry> getAssetEntries(int start,
                                                                          int end)
                                 throws SystemException
Gets a range of all the asset entries.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of asset entries to return
end - the upper bound of the range of asset entries to return (not inclusive)
Returns:
the range of asset entries
Throws:
SystemException - if a system exception occurred

getAssetEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetEntriesCount()
                         throws SystemException
Gets the number of asset entries.

Returns:
the number of asset entries
Throws:
SystemException - if a system exception occurred

updateAssetEntry

AssetEntry updateAssetEntry(AssetEntry assetEntry)
                            throws SystemException
Updates the asset entry in the database. Also notifies the appropriate model listeners.

Parameters:
assetEntry - the asset entry to update
Returns:
the asset entry that was updated
Throws:
SystemException - if a system exception occurred

updateAssetEntry

AssetEntry updateAssetEntry(AssetEntry assetEntry,
                            boolean merge)
                            throws SystemException
Updates the asset entry in the database. Also notifies the appropriate model listeners.

Parameters:
assetEntry - the asset entry to update
merge - whether to merge the asset entry with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the asset entry that was updated
Throws:
SystemException - if a system exception occurred

deleteEntry

void deleteEntry(AssetEntry entry)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteEntry

void deleteEntry(long entryId)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteEntry

void deleteEntry(String className,
                 long classPK)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

getAncestorEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetEntry> getAncestorEntries(long entryId)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getChildEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetEntry> getChildEntries(long entryId)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getCompanyEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetEntry> getCompanyEntries(long companyId,
                                                                            int start,
                                                                            int end)
                                   throws SystemException
Throws:
SystemException

getCompanyEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyEntriesCount(long companyId)
                           throws SystemException
Throws:
SystemException

getCompanyEntryDisplays

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntryDisplay[] getCompanyEntryDisplays(long companyId,
                                                                                     int start,
                                                                                     int end,
                                                                                     String languageId)
                                            throws SystemException
Throws:
SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetEntry> getEntries(AssetEntryQuery entryQuery)
                            throws SystemException
Throws:
SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(AssetEntryQuery entryQuery)
                    throws SystemException
Throws:
SystemException

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntry getEntry(long entryId)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntry getEntry(long groupId,
                                                             String classUuid)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntry getEntry(String className,
                                                             long classPK)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

getNextEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntry getNextEntry(long entryId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getParentEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntry getParentEntry(long entryId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getPreviousEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntry getPreviousEntry(long entryId)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getTopViewedEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetEntry> getTopViewedEntries(String className,
                                                                              boolean asc,
                                                                              int start,
                                                                              int end)
                                     throws SystemException
Throws:
SystemException

getTopViewedEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetEntry> getTopViewedEntries(String[] className,
                                                                              boolean asc,
                                                                              int start,
                                                                              int end)
                                     throws SystemException
Throws:
SystemException

incrementViewCounter

void incrementViewCounter(long userId,
                          String className,
                          long classPK)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

incrementViewCounter

void incrementViewCounter(long userId,
                          String className,
                          long classPK,
                          int increment)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long companyId,
                                                     String portletId,
                                                     String keywords,
                                                     int start,
                                                     int end)
            throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long companyId,
                                                     long[] groupIds,
                                                     String portletId,
                                                     String userName,
                                                     String title,
                                                     String description,
                                                     String assetCategoryIds,
                                                     String assetTagNames,
                                                     boolean andSearch,
                                                     int start,
                                                     int end)
            throws SystemException
Throws:
SystemException

searchEntryDisplays

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetEntryDisplay[] searchEntryDisplays(long companyId,
                                                                                 String portletId,
                                                                                 String keywords,
                                                                                 String languageId,
                                                                                 int start,
                                                                                 int end)
                                        throws SystemException
Throws:
SystemException

searchEntryDisplaysCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchEntryDisplaysCount(long companyId,
                                                                      String portletId,
                                                                      String keywords,
                                                                      String languageId)
                             throws SystemException
Throws:
SystemException

updateEntry

AssetEntry updateEntry(long userId,
                       long groupId,
                       String className,
                       long classPK,
                       long[] categoryIds,
                       String[] tagNames)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

updateEntry

AssetEntry updateEntry(long userId,
                       long groupId,
                       String className,
                       long classPK,
                       String classUuid,
                       long[] categoryIds,
                       String[] tagNames,
                       boolean visible,
                       Date startDate,
                       Date endDate,
                       Date publishDate,
                       Date expirationDate,
                       String mimeType,
                       String title,
                       String description,
                       String summary,
                       String url,
                       int height,
                       int width,
                       Integer priority,
                       boolean sync)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

updateVisible

AssetEntry updateVisible(String className,
                         long classPK,
                         boolean visible)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

validate

void validate(String className,
              long[] categoryIds,
              String[] tagNames)
              throws PortalException
Throws:
PortalException

Liferay 6.0.5