Liferay 6.0.5

com.liferay.portlet.asset.service.persistence
Interface AssetTagPersistence

All Superinterfaces:
BasePersistence<AssetTag>
All Known Implementing Classes:
AssetTagPersistenceImpl

public interface AssetTagPersistence
extends BasePersistence<AssetTag>

The persistence interface for the asset tag service.

Never modify or reference this interface directly. Always use AssetTagUtil to access the asset tag persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.

Caching information and settings can be found in portal.properties

See Also:
AssetTagPersistenceImpl, AssetTagUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 void addAssetEntries(long pk, List<AssetEntry> assetEntries)
          Adds an association between the asset tag and the asset entries.
 void addAssetEntries(long pk, long[] assetEntryPKs)
          Adds an association between the asset tag and the asset entries.
 void addAssetEntry(long pk, AssetEntry assetEntry)
          Adds an association between the asset tag and the asset entry.
 void addAssetEntry(long pk, long assetEntryPK)
          Adds an association between the asset tag and the asset entry.
 void cacheResult(AssetTag assetTag)
          Caches the asset tag in the entity cache if it is enabled.
 void cacheResult(List<AssetTag> assetTags)
          Caches the asset tags in the entity cache if it is enabled.
 void clearAssetEntries(long pk)
          Clears all associations between the asset tag and its asset entries.
 boolean containsAssetEntries(long pk)
          Determines whether the asset tag has any asset entries associated with it.
 boolean containsAssetEntry(long pk, long assetEntryPK)
          Determines whether the asset entry is associated with the asset tag.
 int countAll()
          Counts all the asset tags.
 int countByGroupId(long groupId)
          Counts all the asset tags where groupId = ?.
 AssetTag create(long tagId)
          Creates a new asset tag with the primary key.
 AssetTag fetchByPrimaryKey(long tagId)
          Finds the asset tag with the primary key or returns null if it could not be found.
 int filterCountByGroupId(long groupId)
          Filters by the user's permissions and counts all the asset tags where groupId = ?.
 List<AssetTag> filterFindByGroupId(long groupId)
          Filters by the user's permissions and finds all the asset tags where groupId = ?.
 List<AssetTag> filterFindByGroupId(long groupId, int start, int end)
          Filters by the user's permissions and finds a range of all the asset tags where groupId = ?.
 List<AssetTag> filterFindByGroupId(long groupId, int start, int end, OrderByComparator orderByComparator)
          Filters by the user's permissions and finds an ordered range of all the asset tags where groupId = ?.
 List<AssetTag> findAll()
          Finds all the asset tags.
 List<AssetTag> findAll(int start, int end)
          Finds a range of all the asset tags.
 List<AssetTag> findAll(int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the asset tags.
 AssetTag findByGroupId_First(long groupId, OrderByComparator orderByComparator)
          Finds the first asset tag in the ordered set where groupId = ?.
 AssetTag findByGroupId_Last(long groupId, OrderByComparator orderByComparator)
          Finds the last asset tag in the ordered set where groupId = ?.
 AssetTag[] findByGroupId_PrevAndNext(long tagId, long groupId, OrderByComparator orderByComparator)
          Finds the asset tags before and after the current asset tag in the ordered set where groupId = ?.
 List<AssetTag> findByGroupId(long groupId)
          Finds all the asset tags where groupId = ?.
 List<AssetTag> findByGroupId(long groupId, int start, int end)
          Finds a range of all the asset tags where groupId = ?.
 List<AssetTag> findByGroupId(long groupId, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the asset tags where groupId = ?.
 AssetTag findByPrimaryKey(long tagId)
          Finds the asset tag with the primary key or throws a NoSuchTagException if it could not be found.
 List<AssetEntry> getAssetEntries(long pk)
          Gets all the asset entries associated with the asset tag.
 List<AssetEntry> getAssetEntries(long pk, int start, int end)
          Gets a range of all the asset entries associated with the asset tag.
 List<AssetEntry> getAssetEntries(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the asset entries associated with the asset tag.
 int getAssetEntriesSize(long pk)
          Gets the number of asset entries associated with the asset tag.
 AssetTag remove(long tagId)
          Removes the asset tag with the primary key from the database.
 void removeAll()
          Removes all the asset tags from the database.
 void removeAssetEntries(long pk, List<AssetEntry> assetEntries)
          Removes the association between the asset tag and the asset entries.
 void removeAssetEntries(long pk, long[] assetEntryPKs)
          Removes the association between the asset tag and the asset entries.
 void removeAssetEntry(long pk, AssetEntry assetEntry)
          Removes the association between the asset tag and the asset entry.
 void removeAssetEntry(long pk, long assetEntryPK)
          Removes the association between the asset tag and the asset entry.
 void removeByGroupId(long groupId)
          Removes all the asset tags where groupId = ? from the database.
 void setAssetEntries(long pk, List<AssetEntry> assetEntries)
          Sets the asset entries associated with the asset tag, removing and adding associations as necessary.
 void setAssetEntries(long pk, long[] assetEntryPKs)
          Sets the asset entries associated with the asset tag, removing and adding associations as necessary.
 AssetTag updateImpl(AssetTag assetTag, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, registerListener, remove, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(AssetTag assetTag)
Caches the asset tag in the entity cache if it is enabled.

Parameters:
assetTag - the asset tag to cache

cacheResult

void cacheResult(List<AssetTag> assetTags)
Caches the asset tags in the entity cache if it is enabled.

Parameters:
assetTags - the asset tags to cache

create

AssetTag create(long tagId)
Creates a new asset tag with the primary key. Does not add the asset tag to the database.

Parameters:
tagId - the primary key for the new asset tag
Returns:
the new asset tag

remove

AssetTag remove(long tagId)
                throws SystemException,
                       NoSuchTagException
Removes the asset tag with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
tagId - the primary key of the asset tag to remove
Returns:
the asset tag that was removed
Throws:
NoSuchTagException - if a asset tag with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

AssetTag updateImpl(AssetTag assetTag,
                    boolean merge)
                    throws SystemException
Throws:
SystemException

findByPrimaryKey

AssetTag findByPrimaryKey(long tagId)
                          throws SystemException,
                                 NoSuchTagException
Finds the asset tag with the primary key or throws a NoSuchTagException if it could not be found.

Parameters:
tagId - the primary key of the asset tag to find
Returns:
the asset tag
Throws:
NoSuchTagException - if a asset tag with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

AssetTag fetchByPrimaryKey(long tagId)
                           throws SystemException
Finds the asset tag with the primary key or returns null if it could not be found.

Parameters:
tagId - the primary key of the asset tag to find
Returns:
the asset tag, or null if a asset tag with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByGroupId

List<AssetTag> findByGroupId(long groupId)
                             throws SystemException
Finds all the asset tags where groupId = ?.

Parameters:
groupId - the group id to search with
Returns:
the matching asset tags
Throws:
SystemException - if a system exception occurred

findByGroupId

List<AssetTag> findByGroupId(long groupId,
                             int start,
                             int end)
                             throws SystemException
Finds a range of all the asset tags where groupId = ?.

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:
groupId - the group id to search with
start - the lower bound of the range of asset tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
Returns:
the range of matching asset tags
Throws:
SystemException - if a system exception occurred

findByGroupId

List<AssetTag> findByGroupId(long groupId,
                             int start,
                             int end,
                             OrderByComparator orderByComparator)
                             throws SystemException
Finds an ordered range of all the asset tags where groupId = ?.

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:
groupId - the group id to search with
start - the lower bound of the range of asset tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching asset tags
Throws:
SystemException - if a system exception occurred

findByGroupId_First

AssetTag findByGroupId_First(long groupId,
                             OrderByComparator orderByComparator)
                             throws SystemException,
                                    NoSuchTagException
Finds the first asset tag in the ordered set where groupId = ?.

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:
groupId - the group id to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching asset tag
Throws:
NoSuchTagException - if a matching asset tag could not be found
SystemException - if a system exception occurred

findByGroupId_Last

AssetTag findByGroupId_Last(long groupId,
                            OrderByComparator orderByComparator)
                            throws SystemException,
                                   NoSuchTagException
Finds the last asset tag in the ordered set where groupId = ?.

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:
groupId - the group id to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching asset tag
Throws:
NoSuchTagException - if a matching asset tag could not be found
SystemException - if a system exception occurred

findByGroupId_PrevAndNext

AssetTag[] findByGroupId_PrevAndNext(long tagId,
                                     long groupId,
                                     OrderByComparator orderByComparator)
                                     throws SystemException,
                                            NoSuchTagException
Finds the asset tags before and after the current asset tag in the ordered set where groupId = ?.

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:
tagId - the primary key of the current asset tag
groupId - the group id to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next asset tag
Throws:
NoSuchTagException - if a asset tag with the primary key could not be found
SystemException - if a system exception occurred

filterFindByGroupId

List<AssetTag> filterFindByGroupId(long groupId)
                                   throws SystemException
Filters by the user's permissions and finds all the asset tags where groupId = ?.

Parameters:
groupId - the group id to search with
Returns:
the matching asset tags that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByGroupId

List<AssetTag> filterFindByGroupId(long groupId,
                                   int start,
                                   int end)
                                   throws SystemException
Filters by the user's permissions and finds a range of all the asset tags where groupId = ?.

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:
groupId - the group id to search with
start - the lower bound of the range of asset tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
Returns:
the range of matching asset tags that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByGroupId

List<AssetTag> filterFindByGroupId(long groupId,
                                   int start,
                                   int end,
                                   OrderByComparator orderByComparator)
                                   throws SystemException
Filters by the user's permissions and finds an ordered range of all the asset tags where groupId = ?.

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:
groupId - the group id to search with
start - the lower bound of the range of asset tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching asset tags that the user has permission to view
Throws:
SystemException - if a system exception occurred

findAll

List<AssetTag> findAll()
                       throws SystemException
Finds all the asset tags.

Returns:
the asset tags
Throws:
SystemException - if a system exception occurred

findAll

List<AssetTag> findAll(int start,
                       int end)
                       throws SystemException
Finds a range of all the asset tags.

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 tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
Returns:
the range of asset tags
Throws:
SystemException - if a system exception occurred

findAll

List<AssetTag> findAll(int start,
                       int end,
                       OrderByComparator orderByComparator)
                       throws SystemException
Finds an ordered range of all the asset tags.

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 tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of asset tags
Throws:
SystemException - if a system exception occurred

removeByGroupId

void removeByGroupId(long groupId)
                     throws SystemException
Removes all the asset tags where groupId = ? from the database.

Parameters:
groupId - the group id to search with
Throws:
SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException
Removes all the asset tags from the database.

Throws:
SystemException - if a system exception occurred

countByGroupId

int countByGroupId(long groupId)
                   throws SystemException
Counts all the asset tags where groupId = ?.

Parameters:
groupId - the group id to search with
Returns:
the number of matching asset tags
Throws:
SystemException - if a system exception occurred

filterCountByGroupId

int filterCountByGroupId(long groupId)
                         throws SystemException
Filters by the user's permissions and counts all the asset tags where groupId = ?.

Parameters:
groupId - the group id to search with
Returns:
the number of matching asset tags that the user has permission to view
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Counts all the asset tags.

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

getAssetEntries

List<AssetEntry> getAssetEntries(long pk)
                                 throws SystemException
Gets all the asset entries associated with the asset tag.

Parameters:
pk - the primary key of the asset tag to get the associated asset entries for
Returns:
the asset entries associated with the asset tag
Throws:
SystemException - if a system exception occurred

getAssetEntries

List<AssetEntry> getAssetEntries(long pk,
                                 int start,
                                 int end)
                                 throws SystemException
Gets a range of all the asset entries associated with the asset tag.

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:
pk - the primary key of the asset tag to get the associated asset entries for
start - the lower bound of the range of asset tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
Returns:
the range of asset entries associated with the asset tag
Throws:
SystemException - if a system exception occurred

getAssetEntries

List<AssetEntry> getAssetEntries(long pk,
                                 int start,
                                 int end,
                                 OrderByComparator orderByComparator)
                                 throws SystemException
Gets an ordered range of all the asset entries associated with the asset tag.

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:
pk - the primary key of the asset tag to get the associated asset entries for
start - the lower bound of the range of asset tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of asset entries associated with the asset tag
Throws:
SystemException - if a system exception occurred

getAssetEntriesSize

int getAssetEntriesSize(long pk)
                        throws SystemException
Gets the number of asset entries associated with the asset tag.

Parameters:
pk - the primary key of the asset tag to get the number of associated asset entries for
Returns:
the number of asset entries associated with the asset tag
Throws:
SystemException - if a system exception occurred

containsAssetEntry

boolean containsAssetEntry(long pk,
                           long assetEntryPK)
                           throws SystemException
Determines whether the asset entry is associated with the asset tag.

Parameters:
pk - the primary key of the asset tag
assetEntryPK - the primary key of the asset entry
Returns:
whether the asset entry is associated with the asset tag
Throws:
SystemException - if a system exception occurred

containsAssetEntries

boolean containsAssetEntries(long pk)
                             throws SystemException
Determines whether the asset tag has any asset entries associated with it.

Parameters:
pk - the primary key of the asset tag to check for associations with asset entries
Returns:
whether the asset tag has any asset entries associated with it
Throws:
SystemException - if a system exception occurred

addAssetEntry

void addAssetEntry(long pk,
                   long assetEntryPK)
                   throws SystemException
Adds an association between the asset tag and the asset entry. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag
assetEntryPK - the primary key of the asset entry
Throws:
SystemException - if a system exception occurred

addAssetEntry

void addAssetEntry(long pk,
                   AssetEntry assetEntry)
                   throws SystemException
Adds an association between the asset tag and the asset entry. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag
assetEntry - the asset entry
Throws:
SystemException - if a system exception occurred

addAssetEntries

void addAssetEntries(long pk,
                     long[] assetEntryPKs)
                     throws SystemException
Adds an association between the asset tag and the asset entries. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag
assetEntryPKs - the primary keys of the asset entries
Throws:
SystemException - if a system exception occurred

addAssetEntries

void addAssetEntries(long pk,
                     List<AssetEntry> assetEntries)
                     throws SystemException
Adds an association between the asset tag and the asset entries. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag
assetEntries - the asset entries
Throws:
SystemException - if a system exception occurred

clearAssetEntries

void clearAssetEntries(long pk)
                       throws SystemException
Clears all associations between the asset tag and its asset entries. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag to clear the associated asset entries from
Throws:
SystemException - if a system exception occurred

removeAssetEntry

void removeAssetEntry(long pk,
                      long assetEntryPK)
                      throws SystemException
Removes the association between the asset tag and the asset entry. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag
assetEntryPK - the primary key of the asset entry
Throws:
SystemException - if a system exception occurred

removeAssetEntry

void removeAssetEntry(long pk,
                      AssetEntry assetEntry)
                      throws SystemException
Removes the association between the asset tag and the asset entry. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag
assetEntry - the asset entry
Throws:
SystemException - if a system exception occurred

removeAssetEntries

void removeAssetEntries(long pk,
                        long[] assetEntryPKs)
                        throws SystemException
Removes the association between the asset tag and the asset entries. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag
assetEntryPKs - the primary keys of the asset entries
Throws:
SystemException - if a system exception occurred

removeAssetEntries

void removeAssetEntries(long pk,
                        List<AssetEntry> assetEntries)
                        throws SystemException
Removes the association between the asset tag and the asset entries. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag
assetEntries - the asset entries
Throws:
SystemException - if a system exception occurred

setAssetEntries

void setAssetEntries(long pk,
                     long[] assetEntryPKs)
                     throws SystemException
Sets the asset entries associated with the asset tag, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag to set the associations for
assetEntryPKs - the primary keys of the asset entries to be associated with the asset tag
Throws:
SystemException - if a system exception occurred

setAssetEntries

void setAssetEntries(long pk,
                     List<AssetEntry> assetEntries)
                     throws SystemException
Sets the asset entries associated with the asset tag, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the asset tag to set the associations for
assetEntries - the asset entries to be associated with the asset tag
Throws:
SystemException - if a system exception occurred

Liferay 6.0.5