Class AssetVocabularyLocalServiceUtil
com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl
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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic AssetVocabulary
addAssetVocabulary
(AssetVocabulary assetVocabulary) Adds the asset vocabulary to the database.static AssetVocabulary
addDefaultVocabulary
(long groupId) static AssetVocabulary
addVocabulary
(long userId, long groupId, String title, ServiceContext serviceContext) static AssetVocabulary
addVocabulary
(long userId, long groupId, String name, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, ServiceContext serviceContext) static AssetVocabulary
addVocabulary
(long userId, long groupId, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) static AssetVocabulary
addVocabulary
(long userId, long groupId, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, ServiceContext serviceContext) static AssetVocabulary
addVocabulary
(String externalReferenceCode, long userId, long groupId, String name, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) static void
addVocabularyResources
(AssetVocabulary vocabulary, boolean addGroupPermissions, boolean addGuestPermissions) static void
addVocabularyResources
(AssetVocabulary vocabulary, ModelPermissions modelPermissions) static AssetVocabulary
createAssetVocabulary
(long vocabularyId) Creates a new asset vocabulary with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static AssetVocabulary
deleteAssetVocabulary
(long vocabularyId) Deletes the asset vocabulary with the primary key from the database.static AssetVocabulary
deleteAssetVocabulary
(AssetVocabulary assetVocabulary) Deletes the asset vocabulary from the database.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static void
deleteVocabularies
(long groupId) static void
deleteVocabulary
(long vocabularyId) static AssetVocabulary
deleteVocabulary
(AssetVocabulary vocabulary) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static AssetVocabulary
fetchAssetVocabulary
(long vocabularyId) static AssetVocabulary
fetchAssetVocabularyByExternalReferenceCode
(String externalReferenceCode, long groupId) static AssetVocabulary
fetchAssetVocabularyByUuidAndGroupId
(String uuid, long groupId) Returns the asset vocabulary matching the UUID and group.static AssetVocabulary
fetchGroupVocabulary
(long groupId, String name) static ActionableDynamicQuery
static List<AssetVocabulary>
getAssetVocabularies
(int start, int end) Returns a range of all the asset vocabularies.static List<AssetVocabulary>
getAssetVocabulariesByUuidAndCompanyId
(String uuid, long companyId) Returns all the asset vocabularies matching the UUID and company.static List<AssetVocabulary>
getAssetVocabulariesByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<AssetVocabulary> orderByComparator) Returns a range of asset vocabularies matching the UUID and company.static int
Returns the number of asset vocabularies.static AssetVocabulary
getAssetVocabulary
(long vocabularyId) Returns the asset vocabulary with the primary key.static AssetVocabulary
getAssetVocabularyByExternalReferenceCode
(String externalReferenceCode, long groupId) static AssetVocabulary
getAssetVocabularyByUuidAndGroupId
(String uuid, long groupId) Returns the asset vocabulary matching the UUID and group.static List<AssetVocabulary>
getCompanyVocabularies
(long companyId) static ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static List<AssetVocabulary>
getGroupsVocabularies
(long[] groupIds) static List<AssetVocabulary>
getGroupsVocabularies
(long[] groupIds, String className) static List<AssetVocabulary>
getGroupsVocabularies
(long[] groupIds, String className, long classTypePK) static List<AssetVocabulary>
getGroupVocabularies
(long groupId) static List<AssetVocabulary>
getGroupVocabularies
(long[] groupIds) static List<AssetVocabulary>
getGroupVocabularies
(long[] groupIds, int[] visibilityTypes) static List<AssetVocabulary>
getGroupVocabularies
(long groupId, boolean addDefaultVocabulary) static List<AssetVocabulary>
getGroupVocabularies
(long groupId, int visibilityType) static int
getGroupVocabulariesCount
(long[] groupIds) static AssetVocabulary
getGroupVocabulary
(long groupId, String name) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static AssetVocabularyLocalService
static List<AssetVocabulary>
getVocabularies
(long[] vocabularyIds) static List<AssetVocabulary>
getVocabularies
(Hits hits) static AssetVocabulary
getVocabulary
(long vocabularyId) static BaseModelSearchResult<AssetVocabulary>
searchVocabularies
(long companyId, long[] groupIds, String title, int[] visibilityTypes, int start, int end, Sort sort) static void
setService
(AssetVocabularyLocalService service) static AssetVocabulary
updateAssetVocabulary
(AssetVocabulary assetVocabulary) Updates the asset vocabulary in the database or adds it if it does not yet exist.static AssetVocabulary
updateVocabulary
(long vocabularyId, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, ServiceContext serviceContext) static AssetVocabulary
updateVocabulary
(long vocabularyId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings) static AssetVocabulary
updateVocabulary
(long vocabularyId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, int visibilityType)
-
Constructor Details
-
AssetVocabularyLocalServiceUtil
public AssetVocabularyLocalServiceUtil()
-
-
Method Details
-
addAssetVocabulary
Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.Important: Inspect AssetVocabularyLocalServiceImpl 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:
assetVocabulary
- the asset vocabulary- Returns:
- the asset vocabulary that was added
-
addDefaultVocabulary
- Throws:
PortalException
-
addVocabulary
public static AssetVocabulary addVocabulary(long userId, long groupId, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) - Throws:
PortalException
-
addVocabulary
public static AssetVocabulary addVocabulary(long userId, long groupId, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, ServiceContext serviceContext) - Throws:
PortalException
-
addVocabulary
public static AssetVocabulary addVocabulary(long userId, long groupId, String title, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addVocabulary
public static AssetVocabulary addVocabulary(long userId, long groupId, String name, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, ServiceContext serviceContext) - Throws:
PortalException
-
addVocabulary
public static AssetVocabulary addVocabulary(String externalReferenceCode, long userId, long groupId, String name, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) - Throws:
PortalException
-
addVocabularyResources
public static void addVocabularyResources(AssetVocabulary vocabulary, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException - Throws:
PortalException
-
addVocabularyResources
public static void addVocabularyResources(AssetVocabulary vocabulary, ModelPermissions modelPermissions) throws PortalException - Throws:
PortalException
-
createAssetVocabulary
Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database.- Parameters:
vocabularyId
- the primary key for the new asset vocabulary- Returns:
- the new asset vocabulary
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteAssetVocabulary
Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.Important: Inspect AssetVocabularyLocalServiceImpl 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:
assetVocabulary
- the asset vocabulary- Returns:
- the asset vocabulary that was removed
-
deleteAssetVocabulary
Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect AssetVocabularyLocalServiceImpl 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:
vocabularyId
- the primary key of the asset vocabulary- Returns:
- the asset vocabulary that was removed
- Throws:
PortalException
- if a asset vocabulary with the primary key could not be found
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteVocabularies
- Throws:
PortalException
-
deleteVocabulary
- Throws:
PortalException
-
deleteVocabulary
- Throws:
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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.portlet.asset.model.impl.AssetVocabularyModelImpl
.- 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(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
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.portlet.asset.model.impl.AssetVocabularyModelImpl
.- 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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchAssetVocabulary
-
fetchAssetVocabularyByExternalReferenceCode
public static AssetVocabulary fetchAssetVocabularyByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchAssetVocabularyByUuidAndGroupId
Returns the asset vocabulary matching the UUID and group.- Parameters:
uuid
- the asset vocabulary's UUIDgroupId
- the primary key of the group- Returns:
- the matching asset vocabulary, or
null
if a matching asset vocabulary could not be found
-
fetchGroupVocabulary
-
getActionableDynamicQuery
-
getAssetVocabularies
Returns a range of all the asset vocabularies.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.portlet.asset.model.impl.AssetVocabularyModelImpl
.- Parameters:
start
- the lower bound of the range of asset vocabulariesend
- the upper bound of the range of asset vocabularies (not inclusive)- Returns:
- the range of asset vocabularies
-
getAssetVocabulariesByUuidAndCompanyId
public static List<AssetVocabulary> getAssetVocabulariesByUuidAndCompanyId(String uuid, long companyId) Returns all the asset vocabularies matching the UUID and company.- Parameters:
uuid
- the UUID of the asset vocabulariescompanyId
- the primary key of the company- Returns:
- the matching asset vocabularies, or an empty list if no matches were found
-
getAssetVocabulariesByUuidAndCompanyId
public static List<AssetVocabulary> getAssetVocabulariesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<AssetVocabulary> orderByComparator) Returns a range of asset vocabularies matching the UUID and company.- Parameters:
uuid
- the UUID of the asset vocabulariescompanyId
- the primary key of the companystart
- the lower bound of the range of asset vocabulariesend
- the upper bound of the range of asset vocabularies (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching asset vocabularies, or an empty list if no matches were found
-
getAssetVocabulariesCount
public static int getAssetVocabulariesCount()Returns the number of asset vocabularies.- Returns:
- the number of asset vocabularies
-
getAssetVocabulary
Returns the asset vocabulary with the primary key.- Parameters:
vocabularyId
- the primary key of the asset vocabulary- Returns:
- the asset vocabulary
- Throws:
PortalException
- if a asset vocabulary with the primary key could not be found
-
getAssetVocabularyByExternalReferenceCode
public static AssetVocabulary getAssetVocabularyByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getAssetVocabularyByUuidAndGroupId
public static AssetVocabulary getAssetVocabularyByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the asset vocabulary matching the UUID and group.- Parameters:
uuid
- the asset vocabulary's UUIDgroupId
- the primary key of the group- Returns:
- the matching asset vocabulary
- Throws:
PortalException
- if a matching asset vocabulary could not be found
-
getCompanyVocabularies
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getGroupsVocabularies
-
getGroupsVocabularies
-
getGroupsVocabularies
public static List<AssetVocabulary> getGroupsVocabularies(long[] groupIds, String className, long classTypePK) -
getGroupVocabularies
- Throws:
PortalException
-
getGroupVocabularies
public static List<AssetVocabulary> getGroupVocabularies(long groupId, boolean addDefaultVocabulary) throws PortalException - Throws:
PortalException
-
getGroupVocabularies
-
getGroupVocabularies
-
getGroupVocabularies
-
getGroupVocabulariesCount
public static int getGroupVocabulariesCount(long[] groupIds) -
getGroupVocabulary
- Throws:
PortalException
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getVocabularies
- Throws:
PortalException
-
getVocabularies
- Throws:
PortalException
-
getVocabulary
- Throws:
PortalException
-
searchVocabularies
public static BaseModelSearchResult<AssetVocabulary> searchVocabularies(long companyId, long[] groupIds, String title, int[] visibilityTypes, int start, int end, Sort sort) throws PortalException - Throws:
PortalException
-
updateAssetVocabulary
Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect AssetVocabularyLocalServiceImpl 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:
assetVocabulary
- the asset vocabulary- Returns:
- the asset vocabulary that was updated
-
updateVocabulary
public static AssetVocabulary updateVocabulary(long vocabularyId, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings) - Throws:
PortalException
-
updateVocabulary
public static AssetVocabulary updateVocabulary(long vocabularyId, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, int visibilityType) - Throws:
PortalException
-
updateVocabulary
public static AssetVocabulary updateVocabulary(long vocabularyId, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, ServiceContext serviceContext) - Throws:
PortalException
-
getService
-
setService
-