Interface AssetLinkLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.change.tracking.CTService<AssetLink>
,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
AssetLinkLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddAssetLink
(AssetLink assetLink) Adds the asset link to the database.addLink
(long userId, long entryId1, long entryId2, int type, int weight) Adds a new asset link.createAssetLink
(long linkId) Creates a new asset link with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) deleteAssetLink
(long linkId) Deletes the asset link with the primary key from the database.deleteAssetLink
(AssetLink assetLink) Deletes the asset link from the database.void
deleteGroupLinks
(long groupId) void
deleteLink
(long linkId) Deletes the asset link.void
deleteLink
(AssetLink link) 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.com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery
<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.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
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.fetchAssetLink
(long linkId) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getAssetLink
(long linkId) Returns the asset link with the primary key.getAssetLinks
(int start, int end) Returns a range of all the asset links.int
Returns the number of asset links.com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<AssetLink>
getDirectLinks
(long entryId) Returns all the asset links whose first entry ID is the given entry ID.getDirectLinks
(long entryId, boolean excludeInvisibleLinks) getDirectLinks
(long entryId, int typeId) Returns all the asset links of the given link type whose first entry ID is the given entry ID.getDirectLinks
(long entryId, int typeId, boolean excludeInvisibleLinks) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getLinks
(long entryId) Returns all the asset links whose first or second entry ID is the given entry ID.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.getLinks
(long classNameId, long classPK) Returns all the asset links of an AssetEntry.Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) getReverseLinks
(long entryId, int typeId) Returns all the asset links of the given link type whose second entry ID is the given entry ID.updateAssetLink
(AssetLink assetLink) Updates the asset link in the database or adds it if it does not yet exist.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.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<AssetLink>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addAssetLink
Adds the asset link to the database. Also notifies the appropriate model listeners.Important: Inspect AssetLinkLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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 com.liferay.portal.kernel.exception.PortalException Adds a new asset link.- Parameters:
userId
- the primary key of the link's creatorentryId1
- the primary key of the first asset entryentryId2
- the primary key of the second asset entrytype
- the link type. Acceptable values includeAssetLinkConstants#TYPE_RELATED
which is a bidirectional relationship andAssetLinkConstants#TYPE_CHILD
which is a unidirectional relationship. For more information seeAssetLinkConstants
weight
- the weight of the relationship, allowing precedence ordering of links- Returns:
- the asset link
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createAssetLink
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
-
createPersistedModel
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteAssetLink
Deletes the asset link from the database. Also notifies the appropriate model listeners.Important: Inspect AssetLinkLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
assetLink
- the asset link- Returns:
- the asset link that was removed
-
deleteAssetLink
@Indexable(type=DELETE) AssetLink deleteAssetLink(long linkId) throws com.liferay.portal.kernel.exception.PortalException Deletes the asset link with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect AssetLinkLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
linkId
- the primary key of the asset link- Returns:
- the asset link that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a asset link with the primary key could not be found
-
deleteGroupLinks
void deleteGroupLinks(long groupId) -
deleteLink
Deletes the asset link.- Parameters:
link
- the asset link
-
deleteLink
void deleteLink(long linkId) throws com.liferay.portal.kernel.exception.PortalException Deletes the asset link.- Parameters:
linkId
- the primary key of the asset link- Throws:
com.liferay.portal.kernel.exception.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 entryentryId2
- the primary key of the second asset entry
-
deletePersistedModel
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.asset.link.model.impl.AssetLinkModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.asset.link.model.impl.AssetLinkModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchAssetLink
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getAssetLink
@Transactional(propagation=SUPPORTS, readOnly=true) AssetLink getAssetLink(long linkId) throws com.liferay.portal.kernel.exception.PortalException Returns the asset link with the primary key.- Parameters:
linkId
- the primary key of the asset link- Returns:
- the asset link
- Throws:
com.liferay.portal.kernel.exception.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.asset.link.model.impl.AssetLinkModelImpl
.- Parameters:
start
- the lower bound of the range of asset linksend
- 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
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
-
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 entrytypeId
- the link type. Acceptable values includeAssetLinkConstants#TYPE_RELATED
which is a bidirectional relationship andAssetLinkConstants#TYPE_CHILD
which is a unidirectional relationship. For more information seeAssetLinkConstants
- Returns:
- the asset links of the given link type whose first entry ID is the given entry ID
-
getDirectLinks
-
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getLinks
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
-
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 entrytypeId
- the link type. Acceptable values includeAssetLinkConstants#TYPE_RELATED
which is a bidirectional relationship andAssetLinkConstants#TYPE_CHILD
which is a unidirectional relationship. For more information seeAssetLinkConstants
- Returns:
- the asset links of the given link type whose first or second entry ID is the given entry ID
-
getLinks
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetLink> getLinks(long classNameId, long classPK) Returns all the asset links of an AssetEntry.- Parameters:
classNameId
- AssetEntry's classNameIdclassPK
- AssetEntry's classPK- Returns:
- the asset links of the given entry params
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.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 entrytypeId
- the link type. Acceptable values includeAssetLinkConstants#TYPE_RELATED
which is a bidirectional relationship andAssetLinkConstants#TYPE_CHILD
which is a unidirectional relationship. For more information seeAssetLinkConstants
- Returns:
- the asset links of the given link type whose second entry ID is the given entry ID
-
updateAssetLink
Updates the asset link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect AssetLinkLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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 com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateLinks
void updateLinks(long userId, long entryId, long[] linkEntryIds, int typeId) throws com.liferay.portal.kernel.exception.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 linksentryId
- the primary key of the asset entry to be managedlinkEntryIds
- the primary keys of the asset entries to be linked with the asset entry to be managedtypeId
- the type of the asset links to be created. Acceptable values includeAssetLinkConstants#TYPE_RELATED
which is a bidirectional relationship andAssetLinkConstants#TYPE_CHILD
which is a unidirectional relationship. For more information seeAssetLinkConstants
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCTPersistence
@Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<AssetLink> getCTPersistence()- Specified by:
getCTPersistence
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<AssetLink>
-
getModelClass
- Specified by:
getModelClass
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<AssetLink>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<AssetLink>, R, throws EE> updateUnsafeFunction)
-