com.liferay.asset.kernel.service

Interface AssetLinkLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

AssetLinkLocalServiceWrapper

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

Provides the local service interface for AssetLink. 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.

Author:

Brian Wing Shun Chan

See Also:

AssetLinkLocalServiceUtil, AssetLinkLocalServiceBaseImpl, AssetLinkLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
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	deleteGroupLinks(long groupId)
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.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
AssetLink	fetchAssetLink(long linkId)
ActionableDynamicQuery	getActionableDynamicQuery()
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.
List<AssetLink>	getDirectLinks(long entryId) Returns all the asset links whose first entry ID is the given entry ID.
List<AssetLink>	getDirectLinks(long entryId, boolean excludeInvisibleLinks)
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>	getDirectLinks(long entryId, int typeId, boolean excludeInvisibleLinks)
ExportActionableDynamicQuery	getExportActionbleDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
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.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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.
AssetLink	updateAssetLink(AssetLink assetLink) Updates the asset link in the database or adds it if it does not yet exist.
AssetLink	updateLink(long userId, long entryId1, long entryId2, int typeId, int weight)
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

@Indexable(type=REINDEX)
AssetLink addAssetLink(AssetLink assetLink)

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

addLink

AssetLink addLink(long userId,
                  long entryId1,
                  long entryId2,
                  int type,
                  int weight)
           throws PortalException

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

createAssetLink

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
AssetLink deleteAssetLink(AssetLink assetLink)

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

deleteAssetLink

@Indexable(type=DELETE)
AssetLink deleteAssetLink(long linkId)
                                           throws PortalException

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

deleteGroupLinks

void deleteGroupLinks(long groupId)

deleteLink

void deleteLink(AssetLink link)

Deletes the asset link.

Parameters:

link - the asset link

deleteLink

void deleteLink(long linkId)
         throws PortalException

Deletes the asset link.

Parameters:

linkId - the primary key of the asset link

Throws:

PortalException

deleteLinks

void deleteLinks(long entryId)

Deletes all links associated with the asset entry.

Parameters:

entryId - the primary key of the asset entry

deleteLinks

void deleteLinks(long entryId1,
                 long entryId2)

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AssetLinkModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator<T> orderByComparator)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AssetLinkModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchAssetLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetLink fetchAssetLink(long linkId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getAssetLink

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetLink getAssetLink(long linkId)
                                                                                   throws PortalException

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

getAssetLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getAssetLinks(int start,
                                                                                                 int end)

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AssetLinkModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

getAssetLinksCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetLinksCount()

Returns the number of asset links.

Returns:

the number of asset links

getDirectLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getDirectLinks(long entryId)

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

getDirectLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getDirectLinks(long entryId,
                                                                                                  boolean excludeInvisibleLinks)

getDirectLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

getDirectLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getDirectLinks(long entryId,
                                                                                                  int typeId,
                                                                                                  boolean excludeInvisibleLinks)

getExportActionbleDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionbleDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetLink> getLinks(long entryId)

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

getLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getReverseLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

updateAssetLink

@Indexable(type=REINDEX)
AssetLink updateAssetLink(AssetLink assetLink)

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

updateLink

AssetLink updateLink(long userId,
                     long entryId1,
                     long entryId2,
                     int typeId,
                     int weight)
              throws PortalException

Throws:

PortalException

updateLinks

void updateLinks(long userId,
                 long entryId,
                 long[] linkEntryIds,
                 int typeId)
          throws PortalException

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