com.liferay.asset.kernel.service

Class AssetVocabularyLocalServiceUtil

Object

com.liferay.asset.kernel.service.AssetVocabularyLocalServiceUtil

@ProviderType
public class AssetVocabularyLocalServiceUtil
extends Object

Provides the local service utility for AssetVocabulary. This utility wraps AssetVocabularyLocalServiceImpl and is the primary 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:

AssetVocabularyLocalService, AssetVocabularyLocalServiceBaseImpl, AssetVocabularyLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
AssetVocabularyLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static 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, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
static AssetVocabulary	addVocabulary(long userId, long groupId, String title, 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 AssetVocabulary	deleteAssetVocabulary(AssetVocabulary assetVocabulary) Deletes the asset vocabulary from the database.
static AssetVocabulary	deleteAssetVocabulary(long vocabularyId) Deletes the asset vocabulary with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static void	deleteVocabularies(long groupId)
static AssetVocabulary	deleteVocabulary(AssetVocabulary vocabulary)
static void	deleteVocabulary(long vocabularyId)
static DynamicQuery	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	fetchAssetVocabularyByReferenceCode(long companyId, String externalReferenceCode) Returns the asset vocabulary with the matching external reference code and company.
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	getActionableDynamicQuery()
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	getAssetVocabulariesCount() Returns the number of asset vocabularies.
static AssetVocabulary	getAssetVocabulary(long vocabularyId) Returns the asset vocabulary with the primary key.
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 groupId, boolean addDefaultVocabulary)
static List<AssetVocabulary>	getGroupVocabularies(long groupId, String name, int start, int end, OrderByComparator<AssetVocabulary> obc)
static int	getGroupVocabulariesCount(long[] groupIds)
static AssetVocabulary	getGroupVocabulary(long groupId, String name)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static AssetVocabularyLocalService	getService()
static List<AssetVocabulary>	getVocabularies(Hits hits)
static List<AssetVocabulary>	getVocabularies(long[] vocabularyIds)
static AssetVocabulary	getVocabulary(long vocabularyId)
static BaseModelSearchResult<AssetVocabulary>	searchVocabularies(long companyId, long groupId, String title, int start, int end)
static BaseModelSearchResult<AssetVocabulary>	searchVocabularies(long companyId, long groupId, String title, int start, int end, Sort sort)
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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetVocabularyLocalServiceUtil

public AssetVocabularyLocalServiceUtil()

Method Detail

addAssetVocabulary

public static AssetVocabulary addAssetVocabulary(AssetVocabulary assetVocabulary)

Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.

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,
                                            ServiceContext serviceContext)
                                     throws PortalException

Throws:

PortalException

addVocabulary

public static AssetVocabulary addVocabulary(long userId,
                                            long groupId,
                                            String title,
                                            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

deleteAssetVocabulary

public static AssetVocabulary deleteAssetVocabulary(AssetVocabulary assetVocabulary)

Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.

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.

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

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

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

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)

fetchAssetVocabularyByReferenceCode

public static AssetVocabulary fetchAssetVocabularyByReferenceCode(long companyId,
                                                                  String externalReferenceCode)

Returns the asset vocabulary with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the asset vocabulary's external reference code

Returns:

the matching asset vocabulary, or null if a matching asset vocabulary could not be found

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

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,
                                                         String name,
                                                         int start,
                                                         int end,
                                                         OrderByComparator<AssetVocabulary> obc)

getGroupVocabularies

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

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 groupId,
                                                                        String title,
                                                                        int start,
                                                                        int end)
                                                                 throws PortalException

Throws:

PortalException

searchVocabularies

public static BaseModelSearchResult<AssetVocabulary> searchVocabularies(long companyId,
                                                                        long groupId,
                                                                        String title,
                                                                        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.

Parameters:

assetVocabulary - the asset vocabulary

Returns:

the asset vocabulary that was updated

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()