Class AssetVocabularyLocalServiceUtil

Object
com.liferay.asset.kernel.service.AssetVocabularyLocalServiceUtil

public class AssetVocabularyLocalServiceUtil extends Object
Provides the local service utility for AssetVocabulary. This utility wraps 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 Details

    • AssetVocabularyLocalServiceUtil

      public AssetVocabularyLocalServiceUtil()
  • Method Details

    • addAssetVocabulary

      public static AssetVocabulary addAssetVocabulary(AssetVocabulary assetVocabulary)
      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

      public static AssetVocabulary addDefaultVocabulary(long groupId) throws PortalException
      Throws:
      PortalException
    • addVocabulary

      public static AssetVocabulary addVocabulary(long userId, long groupId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addVocabulary

      public static AssetVocabulary addVocabulary(long userId, long groupId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext) throws PortalException
      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,String> descriptionMap, String settings, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addVocabulary

      public 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) throws PortalException
      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

      public static AssetVocabulary createAssetVocabulary(long vocabularyId)
      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

      public static AssetVocabulary deleteAssetVocabulary(AssetVocabulary assetVocabulary)
      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

      public static AssetVocabulary deleteAssetVocabulary(long vocabularyId) throws PortalException
      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

      public static void deleteVocabularies(long groupId) throws PortalException
      Throws:
      PortalException
    • deleteVocabulary

      public static AssetVocabulary deleteVocabulary(AssetVocabulary vocabulary) throws PortalException
      Throws:
      PortalException
    • deleteVocabulary

      public static void deleteVocabulary(long vocabularyId) throws PortalException
      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

      public static DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public 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.

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.asset.model.impl.AssetVocabularyModelImpl.

      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

      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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.asset.model.impl.AssetVocabularyModelImpl.

      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

      public static 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

      public static 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
    • fetchAssetVocabulary

      public static AssetVocabulary fetchAssetVocabulary(long vocabularyId)
    • fetchAssetVocabularyByExternalReferenceCode

      public static AssetVocabulary fetchAssetVocabularyByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchAssetVocabularyByUuidAndGroupId

      public static AssetVocabulary fetchAssetVocabularyByUuidAndGroupId(String uuid, long groupId)
      Returns the asset vocabulary matching the UUID and group.
      Parameters:
      uuid - the asset vocabulary's UUID
      groupId - the primary key of the group
      Returns:
      the matching asset vocabulary, or null if a matching asset vocabulary could not be found
    • fetchGroupVocabulary

      public static AssetVocabulary fetchGroupVocabulary(long groupId, String name)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getAssetVocabularies

      public static List<AssetVocabulary> getAssetVocabularies(int start, int end)
      Returns a range of all the asset vocabularies.

      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.asset.model.impl.AssetVocabularyModelImpl.

      Parameters:
      start - the lower bound of the range of asset vocabularies
      end - 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 vocabularies
      companyId - 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 vocabularies
      companyId - the primary key of the company
      start - the lower bound of the range of asset vocabularies
      end - the upper bound of the range of asset vocabularies (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      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

      public static AssetVocabulary getAssetVocabulary(long vocabularyId) throws PortalException
      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 UUID
      groupId - the primary key of the group
      Returns:
      the matching asset vocabulary
      Throws:
      PortalException - if a matching asset vocabulary could not be found
    • getCompanyVocabularies

      public static List<AssetVocabulary> getCompanyVocabularies(long companyId)
    • getExportActionableDynamicQuery

      public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
    • getGroupsVocabularies

      public static List<AssetVocabulary> getGroupsVocabularies(long[] groupIds)
    • getGroupsVocabularies

      public static List<AssetVocabulary> getGroupsVocabularies(long[] groupIds, String className)
    • getGroupsVocabularies

      public static List<AssetVocabulary> getGroupsVocabularies(long[] groupIds, String className, long classTypePK)
    • getGroupVocabularies

      public static List<AssetVocabulary> getGroupVocabularies(long groupId) throws PortalException
      Throws:
      PortalException
    • getGroupVocabularies

      public static List<AssetVocabulary> getGroupVocabularies(long groupId, boolean addDefaultVocabulary) throws PortalException
      Throws:
      PortalException
    • getGroupVocabularies

      public static List<AssetVocabulary> getGroupVocabularies(long groupId, int visibilityType)
    • getGroupVocabularies

      public static List<AssetVocabulary> getGroupVocabularies(long[] groupIds)
    • getGroupVocabularies

      public static List<AssetVocabulary> getGroupVocabularies(long[] groupIds, int[] visibilityTypes)
    • getGroupVocabulariesCount

      public static int getGroupVocabulariesCount(long[] groupIds)
    • getGroupVocabulary

      public static AssetVocabulary getGroupVocabulary(long groupId, String name) throws PortalException
      Throws:
      PortalException
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getVocabularies

      public static List<AssetVocabulary> getVocabularies(Hits hits) throws PortalException
      Throws:
      PortalException
    • getVocabularies

      public static List<AssetVocabulary> getVocabularies(long[] vocabularyIds) throws PortalException
      Throws:
      PortalException
    • getVocabulary

      public static AssetVocabulary getVocabulary(long vocabularyId) throws PortalException
      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

      public static AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary)
      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,String> descriptionMap, String settings) throws PortalException
      Throws:
      PortalException
    • updateVocabulary

      public static AssetVocabulary updateVocabulary(long vocabularyId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, int visibilityType) throws PortalException
      Throws:
      PortalException
    • updateVocabulary

      public static AssetVocabulary updateVocabulary(long vocabularyId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • getService

      public static AssetVocabularyLocalService getService()
    • setService

      public static void setService(AssetVocabularyLocalService service)