Class AssetLinkLocalServiceUtil
com.liferay.asset.link.service.impl.AssetLinkLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. 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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic AssetLink
addAssetLink
(AssetLink assetLink) Adds the asset link to the database.static AssetLink
addLink
(long userId, long entryId1, long entryId2, int type, int weight) Adds a new asset link.static AssetLink
createAssetLink
(long linkId) Creates a new asset link with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static AssetLink
deleteAssetLink
(long linkId) Deletes the asset link with the primary key from the database.static AssetLink
deleteAssetLink
(AssetLink assetLink) Deletes the asset link from the database.static void
deleteGroupLinks
(long groupId) static void
deleteLink
(long linkId) Deletes the asset link.static void
deleteLink
(AssetLink link) Deletes the asset link.static void
deleteLinks
(long entryId) Deletes all links associated with the asset entry.static void
deleteLinks
(long entryId1, long entryId2) Delete all links that associate the two asset entries.static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static 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.static AssetLink
fetchAssetLink
(long linkId) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static AssetLink
getAssetLink
(long linkId) Returns the asset link with the primary key.getAssetLinks
(int start, int end) Returns a range of all the asset links.static int
Returns the number of asset links.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) static 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.static String
Returns the OSGi service identifier.static 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.static AssetLinkLocalService
static AssetLink
updateAssetLink
(AssetLink assetLink) Updates the asset link in the database or adds it if it does not yet exist.static AssetLink
updateLink
(long userId, long entryId1, long entryId2, int typeId, int weight) static 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.
-
Constructor Details
-
AssetLinkLocalServiceUtil
public AssetLinkLocalServiceUtil()
-
-
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
public static 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
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - 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
public static 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
public static void deleteGroupLinks(long groupId) -
deleteLink
Deletes the asset link.- Parameters:
link
- the asset link
-
deleteLink
public static 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
public static void deleteLinks(long entryId) Deletes all links associated with the asset entry.- Parameters:
entryId
- the primary key of the asset entry
-
deleteLinks
public static 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
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.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
public static <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
public static <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
public static 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
public static 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
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getAssetLink
public static 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
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
public static 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
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
public static 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
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
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
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getReverseLinks
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
public static 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
public static 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
-
getService
-