Liferay 6.1.2-ce-ga3

com.liferay.portlet.asset.service
Interface AssetLinkLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
AssetLinkLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AssetLinkLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the asset link local service.

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:
AssetLinkLocalServiceUtil, com.liferay.portlet.asset.service.base.AssetLinkLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetLinkLocalServiceImpl

Method Summary
 AssetLink addAssetLink(AssetLink assetLink)
          Adds the asset link to the database.
 AssetLink addLink(long userId, long entryId1, long entryId2, int type, int weight)
          Adds a new asset link.
 AssetLink createAssetLink(long linkId)
          Creates a new asset link with the primary key.
 AssetLink deleteAssetLink(AssetLink assetLink)
          Deletes the asset link from the database.
 AssetLink deleteAssetLink(long linkId)
          Deletes the asset link with the primary key from the database.
 void deleteLink(AssetLink link)
          Deletes the asset link.
 void deleteLink(long linkId)
          Deletes the asset link.
 void deleteLinks(long entryId)
          Deletes all links associated with the asset entry.
 void deleteLinks(long entryId1, long entryId2)
          Delete all links that associate the two asset entries.
 DynamicQuery dynamicQuery()
           
 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)
          Returns the number of rows that match the dynamic query.
 AssetLink fetchAssetLink(long linkId)
           
 AssetLink getAssetLink(long linkId)
          Returns the asset link with the primary key.
 List<AssetLink> getAssetLinks(int start, int end)
          Returns a range of all the asset links.
 int getAssetLinksCount()
          Returns the number of asset links.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<AssetLink> getDirectLinks(long entryId)
          Returns all the asset links whose first entry ID is the given entry ID.
 List<AssetLink> getDirectLinks(long entryId, int typeId)
          Returns all the asset links of the given link type whose first entry ID is the given entry ID.
 List<AssetLink> getLinks(long entryId)
          Returns all the asset links whose first or second entry ID is the given entry ID.
 List<AssetLink> getLinks(long entryId, int typeId)
          Returns all the asset links of the given link type whose first or second entry ID is the given entry ID.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<AssetLink> getReverseLinks(long entryId, int typeId)
          Returns all the asset links of the given link type whose second entry ID is the given entry ID.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 AssetLink updateAssetLink(AssetLink assetLink)
          Updates the asset link in the database or adds it if it does not yet exist.
 AssetLink updateAssetLink(AssetLink assetLink, boolean merge)
          Updates the asset link in the database or adds it if it does not yet exist.
 void updateLinks(long userId, long entryId, long[] linkEntryIds, int typeId)
          Updates all links of the asset entry, replacing them with links associating the asset entry with the asset entries of the given link entry IDs.
 

Method Detail

addAssetLink

AssetLink addAssetLink(AssetLink assetLink)
                       throws SystemException
Adds the asset link to the database. Also notifies the appropriate model listeners.

Parameters:
assetLink - the asset link
Returns:
the asset link that was added
Throws:
SystemException - if a system exception occurred

createAssetLink

AssetLink createAssetLink(long linkId)
Creates a new asset link with the primary key. Does not add the asset link to the database.

Parameters:
linkId - the primary key for the new asset link
Returns:
the new asset link

deleteAssetLink

AssetLink deleteAssetLink(long linkId)
                          throws PortalException,
                                 SystemException
Deletes the asset link with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
linkId - the primary key of the asset link
Returns:
the asset link that was removed
Throws:
PortalException - if a asset link with the primary key could not be found
SystemException - if a system exception occurred

deleteAssetLink

AssetLink deleteAssetLink(AssetLink assetLink)
                          throws SystemException
Deletes the asset link from the database. Also notifies the appropriate model listeners.

Parameters:
assetLink - the asset link
Returns:
the asset link that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query
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
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (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
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

fetchAssetLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetLink fetchAssetLink(long linkId)
                         throws SystemException
Throws:
SystemException

getAssetLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetLink getAssetLink(long linkId)
                       throws PortalException,
                              SystemException
Returns the asset link with the primary key.

Parameters:
linkId - the primary key of the asset link
Returns:
the asset link
Throws:
PortalException - if a asset link with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getAssetLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getAssetLinks(int start,
                                                                       int end)
                              throws SystemException
Returns a range of all the asset links.

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

getAssetLinksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetLinksCount()
                       throws SystemException
Returns the number of asset links.

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

updateAssetLink

AssetLink updateAssetLink(AssetLink assetLink)
                          throws SystemException
Updates the asset link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
assetLink - the asset link
Returns:
the asset link that was updated
Throws:
SystemException - if a system exception occurred

updateAssetLink

AssetLink updateAssetLink(AssetLink assetLink,
                          boolean merge)
                          throws SystemException
Updates the asset link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
assetLink - the asset link
merge - whether to merge the asset link 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 link that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addLink

AssetLink addLink(long userId,
                  long entryId1,
                  long entryId2,
                  int type,
                  int weight)
                  throws PortalException,
                         SystemException
Adds a new asset link.

Parameters:
userId - the primary key of the link's creator
entryId1 - the primary key of the first asset entry
entryId2 - the primary key of the second asset entry
type - the link type. Acceptable values include AssetLinkConstants.TYPE_RELATED which is a bidirectional relationship and AssetLinkConstants.TYPE_CHILD which is a unidirectional relationship. For more information see AssetLinkConstants
weight - the weight of the relationship, allowing precedence ordering of links
Returns:
the asset link
Throws:
PortalException - if the user could not be found
SystemException - if a system exception occurred

deleteLink

void deleteLink(AssetLink link)
                throws SystemException
Deletes the asset link.

Parameters:
link - the asset link
Throws:
SystemException - if a system exception occurred

deleteLink

void deleteLink(long linkId)
                throws PortalException,
                       SystemException
Deletes the asset link.

Parameters:
linkId - the primary key of the asset link
Throws:
PortalException - if the asset link could not be found
SystemException - if a system exception occurred

deleteLinks

void deleteLinks(long entryId)
                 throws SystemException
Deletes all links associated with the asset entry.

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

deleteLinks

void deleteLinks(long entryId1,
                 long entryId2)
                 throws SystemException
Delete all links that associate the two asset entries.

Parameters:
entryId1 - the primary key of the first asset entry
entryId2 - the primary key of the second asset entry
Throws:
SystemException - if a system exception occurred

getDirectLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getDirectLinks(long entryId)
                               throws SystemException
Returns all the asset links whose first entry ID is the given entry ID.

Parameters:
entryId - the primary key of the asset entry
Returns:
the asset links whose first entry ID is the given entry ID
Throws:
SystemException - if a system exception occurred

getDirectLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getDirectLinks(long entryId,
                                                                        int typeId)
                               throws SystemException
Returns all the asset links of the given link type whose first entry ID is the given entry ID.

Parameters:
entryId - the primary key of the asset entry
typeId - the link type. Acceptable values include AssetLinkConstants.TYPE_RELATED which is a bidirectional relationship and AssetLinkConstants.TYPE_CHILD which is a unidirectional relationship. For more information see AssetLinkConstants
Returns:
the asset links of the given link type whose first entry ID is the given entry ID
Throws:
SystemException - if a system exception occurred

getLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getLinks(long entryId)
                         throws SystemException
Returns all the asset links whose first or second entry ID is the given entry ID.

Parameters:
entryId - the primary key of the asset entry
Returns:
the asset links whose first or second entry ID is the given entry ID
Throws:
SystemException - if a system exception occurred

getLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getLinks(long entryId,
                                                                  int typeId)
                         throws SystemException
Returns all the asset links of the given link type whose first or second entry ID is the given entry ID.

Parameters:
entryId - the primary key of the asset entry
typeId - the link type. Acceptable values include AssetLinkConstants.TYPE_RELATED which is a bidirectional relationship and AssetLinkConstants.TYPE_CHILD which is a unidirectional relationship. For more information see AssetLinkConstants
Returns:
the asset links of the given link type whose first or second entry ID is the given entry ID
Throws:
SystemException - if a system exception occurred

getReverseLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getReverseLinks(long entryId,
                                                                         int typeId)
                                throws SystemException
Returns all the asset links of the given link type whose second entry ID is the given entry ID.

Parameters:
entryId - the primary key of the asset entry
typeId - the link type. Acceptable values include AssetLinkConstants.TYPE_RELATED which is a bidirectional relationship and AssetLinkConstants.TYPE_CHILD which is a unidirectional relationship. For more information see AssetLinkConstants
Returns:
the asset links of the given link type whose second entry ID is the given entry ID
Throws:
SystemException - if a system exception occurred

updateLinks

void updateLinks(long userId,
                 long entryId,
                 long[] linkEntryIds,
                 int typeId)
                 throws PortalException,
                        SystemException
Updates all links of the asset entry, replacing them with links associating the asset entry with the asset entries of the given link entry IDs.

If no link exists with a given link entry ID, a new link is created associating the current asset entry with the asset entry of that link entry ID. An existing link is deleted if either of its entry IDs is not contained in the given link entry IDs.

Parameters:
userId - the primary key of the user updating the links
entryId - the primary key of the asset entry to be managed
linkEntryIds - the primary keys of the asset entries to be linked with the asset entry to be managed
typeId - the type of the asset links to be created. Acceptable values include AssetLinkConstants.TYPE_RELATED which is a bidirectional relationship and AssetLinkConstants.TYPE_CHILD which is a unidirectional relationship. For more information see AssetLinkConstants
Throws:
PortalException - if the user could not be found
SystemException - if a system exception occurred

Liferay 6.1.2-ce-ga3