Liferay 6.2-ce-ga5

com.liferay.portlet.asset.service
Class AssetVocabularyLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.asset.service.AssetVocabularyLocalServiceUtil

@ProviderType
public class AssetVocabularyLocalServiceUtil
extends Object

Provides the local service utility for AssetVocabulary. This utility wraps com.liferay.portlet.asset.service.impl.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.

See Also:
AssetVocabularyLocalService, com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl

Constructor Summary
AssetVocabularyLocalServiceUtil()
           
 
Method Summary
static AssetVocabulary addAssetVocabulary(AssetVocabulary assetVocabulary)
          Adds the asset vocabulary to the database.
static AssetVocabulary addDefaultVocabulary(long groupId)
           
static AssetVocabulary addVocabulary(long userId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
          Deprecated. As of 6.1.0
static AssetVocabulary addVocabulary(long userId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
           
static AssetVocabulary addVocabulary(long userId, String title, ServiceContext serviceContext)
           
static void addVocabularyResources(AssetVocabulary vocabulary, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addVocabularyResources(AssetVocabulary vocabulary, String[] groupPermissions, String[] guestPermissions)
           
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 void deleteVocabularies(long groupId)
           
static void deleteVocabulary(AssetVocabulary vocabulary)
           
static void deleteVocabulary(long vocabularyId)
           
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static AssetVocabulary fetchAssetVocabulary(long vocabularyId)
           
static AssetVocabulary fetchAssetVocabularyByUuidAndCompanyId(String uuid, long companyId)
          Returns the asset vocabulary with the matching UUID and company.
static AssetVocabulary fetchAssetVocabularyByUuidAndGroupId(String uuid, long groupId)
          Returns the asset vocabulary matching the UUID and group.
static List<AssetVocabulary> getAssetVocabularies(int start, int end)
          Returns a range of all the asset vocabularies.
static int getAssetVocabulariesCount()
          Returns the number of asset vocabularies.
static AssetVocabulary getAssetVocabulary(long vocabularyId)
          Returns the asset vocabulary with the primary key.
static AssetVocabulary getAssetVocabularyByUuidAndCompanyId(String uuid, long companyId)
          Returns the asset vocabulary with the matching UUID and company.
static AssetVocabulary getAssetVocabularyByUuidAndGroupId(String uuid, long groupId)
          Returns the asset vocabulary matching the UUID and group.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<AssetVocabulary> getCompanyVocabularies(long companyId)
           
static List<AssetVocabulary> getGroupsVocabularies(long[] groupIds)
           
static List<AssetVocabulary> getGroupsVocabularies(long[] groupIds, String className)
           
static List<AssetVocabulary> getGroupVocabularies(long groupId)
           
static List<AssetVocabulary> getGroupVocabularies(long groupId, boolean addDefaultVocabulary)
           
static List<AssetVocabulary> getGroupVocabularies(long groupId, String name, int start, int end, OrderByComparator obc)
           
static AssetVocabulary getGroupVocabulary(long groupId, String name)
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static AssetVocabularyLocalService getService()
           
static List<AssetVocabulary> getVocabularies(long[] vocabularyIds)
           
static AssetVocabulary getVocabulary(long vocabularyId)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(AssetVocabularyLocalService service)
          Deprecated. As of 6.2.0
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, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
          Deprecated. As of 6.1.0
static AssetVocabulary updateVocabulary(long vocabularyId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.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)
                                          throws SystemException
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
Throws:
SystemException - if a system exception occurred

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(long vocabularyId)
                                             throws PortalException,
                                                    SystemException
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
SystemException - if a system exception occurred

deleteAssetVocabulary

public static AssetVocabulary deleteAssetVocabulary(AssetVocabulary assetVocabulary)
                                             throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchAssetVocabulary

public static AssetVocabulary fetchAssetVocabulary(long vocabularyId)
                                            throws SystemException
Throws:
SystemException

fetchAssetVocabularyByUuidAndCompanyId

public static AssetVocabulary fetchAssetVocabularyByUuidAndCompanyId(String uuid,
                                                                     long companyId)
                                                              throws SystemException
Returns the asset vocabulary with the matching UUID and company.

Parameters:
uuid - the asset vocabulary's UUID
companyId - the primary key of the company
Returns:
the matching asset vocabulary, or null if a matching asset vocabulary could not be found
Throws:
SystemException - if a system exception occurred

fetchAssetVocabularyByUuidAndGroupId

public static AssetVocabulary fetchAssetVocabularyByUuidAndGroupId(String uuid,
                                                                   long groupId)
                                                            throws SystemException
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
Throws:
SystemException - if a system exception occurred

getAssetVocabulary

public static AssetVocabulary getAssetVocabulary(long vocabularyId)
                                          throws PortalException,
                                                 SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getAssetVocabularyByUuidAndCompanyId

public static AssetVocabulary getAssetVocabularyByUuidAndCompanyId(String uuid,
                                                                   long companyId)
                                                            throws PortalException,
                                                                   SystemException
Returns the asset vocabulary with the matching UUID and company.

Parameters:
uuid - the asset vocabulary's UUID
companyId - the primary key of the company
Returns:
the matching asset vocabulary
Throws:
PortalException - if a matching asset vocabulary could not be found
SystemException - if a system exception occurred

getAssetVocabularyByUuidAndGroupId

public static AssetVocabulary getAssetVocabularyByUuidAndGroupId(String uuid,
                                                                 long groupId)
                                                          throws PortalException,
                                                                 SystemException
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
SystemException - if a system exception occurred

getAssetVocabularies

public static List<AssetVocabulary> getAssetVocabularies(int start,
                                                         int end)
                                                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

getAssetVocabulariesCount

public static int getAssetVocabulariesCount()
                                     throws SystemException
Returns the number of asset vocabularies.

Returns:
the number of asset vocabularies
Throws:
SystemException - if a system exception occurred

updateAssetVocabulary

public static AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary)
                                             throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addDefaultVocabulary

public static AssetVocabulary addDefaultVocabulary(long groupId)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

addVocabulary

public static AssetVocabulary addVocabulary(long userId,
                                            Map<Locale,String> titleMap,
                                            Map<Locale,String> descriptionMap,
                                            String settings,
                                            ServiceContext serviceContext)
                                     throws PortalException,
                                            SystemException
Deprecated. As of 6.1.0

Throws:
PortalException
SystemException

addVocabulary

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

addVocabulary

public static AssetVocabulary addVocabulary(long userId,
                                            String title,
                                            ServiceContext serviceContext)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

addVocabularyResources

public static void addVocabularyResources(AssetVocabulary vocabulary,
                                          boolean addGroupPermissions,
                                          boolean addGuestPermissions)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

addVocabularyResources

public static void addVocabularyResources(AssetVocabulary vocabulary,
                                          String[] groupPermissions,
                                          String[] guestPermissions)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

deleteVocabularies

public static void deleteVocabularies(long groupId)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

deleteVocabulary

public static void deleteVocabulary(AssetVocabulary vocabulary)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

deleteVocabulary

public static void deleteVocabulary(long vocabularyId)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getCompanyVocabularies

public static List<AssetVocabulary> getCompanyVocabularies(long companyId)
                                                    throws SystemException
Throws:
SystemException

getGroupsVocabularies

public static List<AssetVocabulary> getGroupsVocabularies(long[] groupIds)
                                                   throws PortalException,
                                                          SystemException
Throws:
PortalException
SystemException

getGroupsVocabularies

public static List<AssetVocabulary> getGroupsVocabularies(long[] groupIds,
                                                          String className)
                                                   throws PortalException,
                                                          SystemException
Throws:
PortalException
SystemException

getGroupVocabularies

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

getGroupVocabularies

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

getGroupVocabularies

public static List<AssetVocabulary> getGroupVocabularies(long groupId,
                                                         String name,
                                                         int start,
                                                         int end,
                                                         OrderByComparator obc)
                                                  throws SystemException
Throws:
SystemException

getGroupVocabulary

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

getVocabularies

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

getVocabulary

public static AssetVocabulary getVocabulary(long vocabularyId)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

updateVocabulary

public static AssetVocabulary updateVocabulary(long vocabularyId,
                                               Map<Locale,String> titleMap,
                                               Map<Locale,String> descriptionMap,
                                               String settings,
                                               ServiceContext serviceContext)
                                        throws PortalException,
                                               SystemException
Deprecated. As of 6.1.0

Throws:
PortalException
SystemException

updateVocabulary

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

getService

public static AssetVocabularyLocalService getService()

setService

public void setService(AssetVocabularyLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5