com.liferay.asset.kernel.service

Interface AssetVocabularyService

All Superinterfaces:

BaseService

All Known Implementing Classes:

AssetVocabularyServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AssetVocabularyService
extends BaseService

Provides the remote service interface for AssetVocabulary. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

AssetVocabularyServiceUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
AssetVocabulary	addVocabulary(long groupId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext) NOTE FOR DEVELOPERS: Never modify or reference this interface directly.
AssetVocabulary	addVocabulary(long groupId, String title, ServiceContext serviceContext)
List<AssetVocabulary>	deleteVocabularies(long[] vocabularyIds, ServiceContext serviceContext)
void	deleteVocabulary(long vocabularyId)
AssetVocabulary	fetchVocabulary(long vocabularyId)
List<AssetVocabulary>	getCompanyVocabularies(long companyId) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
List<AssetVocabulary>	getGroupsVocabularies(long[] groupIds)
List<AssetVocabulary>	getGroupsVocabularies(long[] groupIds, String className)
List<AssetVocabulary>	getGroupsVocabularies(long[] groupIds, String className, long classTypePK)
List<AssetVocabulary>	getGroupVocabularies(long groupId)
List<AssetVocabulary>	getGroupVocabularies(long[] groupIds)
List<AssetVocabulary>	getGroupVocabularies(long groupId, boolean createDefaultVocabulary)
List<AssetVocabulary>	getGroupVocabularies(long groupId, boolean createDefaultVocabulary, int start, int end, OrderByComparator<AssetVocabulary> obc)
List<AssetVocabulary>	getGroupVocabularies(long groupId, int start, int end, OrderByComparator<AssetVocabulary> obc)
List<AssetVocabulary>	getGroupVocabularies(long groupId, String name, int start, int end, OrderByComparator<AssetVocabulary> obc)
int	getGroupVocabulariesCount(long groupId)
int	getGroupVocabulariesCount(long[] groupIds)
int	getGroupVocabulariesCount(long groupId, String name)
AssetVocabularyDisplay	getGroupVocabulariesDisplay(long groupId, String name, int start, int end, boolean addDefaultVocabulary, OrderByComparator<AssetVocabulary> obc)
AssetVocabularyDisplay	getGroupVocabulariesDisplay(long groupId, String name, int start, int end, OrderByComparator<AssetVocabulary> obc)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
List<AssetVocabulary>	getVocabularies(long[] vocabularyIds) Deprecated. As of Wilberforce (7.0.x), replaced by AssetUtil#filterVocabularyIds(PermissionChecker, long[])
AssetVocabulary	getVocabulary(long vocabularyId)
AssetVocabularyDisplay	searchVocabulariesDisplay(long groupId, String title, boolean addDefaultVocabulary, int start, int end)
AssetVocabularyDisplay	searchVocabulariesDisplay(long groupId, String title, boolean addDefaultVocabulary, int start, int end, Sort sort)
AssetVocabulary	updateVocabulary(long vocabularyId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)

Method Detail

addVocabulary

AssetVocabulary addVocabulary(long groupId,
                              String title,
                              Map<Locale,String> titleMap,
                              Map<Locale,String> descriptionMap,
                              String settings,
                              ServiceContext serviceContext)
                       throws PortalException

NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use AssetVocabularyServiceUtil to access the asset vocabulary remote service. Add custom service methods to com.liferay.portlet.asset.service.impl.AssetVocabularyServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Throws:

PortalException

addVocabulary

AssetVocabulary addVocabulary(long groupId,
                              String title,
                              ServiceContext serviceContext)
                       throws PortalException

Throws:

PortalException

deleteVocabularies

List<AssetVocabulary> deleteVocabularies(long[] vocabularyIds,
                                         ServiceContext serviceContext)
                                  throws PortalException

Throws:

PortalException

deleteVocabulary

void deleteVocabulary(long vocabularyId)
               throws PortalException

Throws:

PortalException

fetchVocabulary

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabulary fetchVocabulary(long vocabularyId)
                                                                                            throws PortalException

Throws:

PortalException

getCompanyVocabularies

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getCompanyVocabularies(long companyId)
                                                                                                                      throws PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

PortalException

getGroupsVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupsVocabularies(long[] groupIds)

getGroupsVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupsVocabularies(long[] groupIds,
                                                                                                               String className)

getGroupsVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupsVocabularies(long[] groupIds,
                                                                                                               String className,
                                                                                                               long classTypePK)

getGroupVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupVocabularies(long groupId)
                                                                                                       throws PortalException

Throws:

PortalException

getGroupVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupVocabularies(long groupId,
                                                                                                              boolean createDefaultVocabulary)
                                                                                                       throws PortalException

Throws:

PortalException

getGroupVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupVocabularies(long groupId,
                                                                                                              boolean createDefaultVocabulary,
                                                                                                              int start,
                                                                                                              int end,
                                                                                                              OrderByComparator<AssetVocabulary> obc)
                                                                                                       throws PortalException

Throws:

PortalException

getGroupVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupVocabularies(long groupId,
                                                                                                              int start,
                                                                                                              int end,
                                                                                                              OrderByComparator<AssetVocabulary> obc)

getGroupVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupVocabularies(long groupId,
                                                                                                              String name,
                                                                                                              int start,
                                                                                                              int end,
                                                                                                              OrderByComparator<AssetVocabulary> obc)

getGroupVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupVocabularies(long[] groupIds)

getGroupVocabulariesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupVocabulariesCount(long groupId)

getGroupVocabulariesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupVocabulariesCount(long groupId,
                                                                                                 String name)

getGroupVocabulariesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupVocabulariesCount(long[] groupIds)

getGroupVocabulariesDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabularyDisplay getGroupVocabulariesDisplay(long groupId,
                                                                                                                      String name,
                                                                                                                      int start,
                                                                                                                      int end,
                                                                                                                      boolean addDefaultVocabulary,
                                                                                                                      OrderByComparator<AssetVocabulary> obc)
                                                                                                               throws PortalException

Throws:

PortalException

getGroupVocabulariesDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabularyDisplay getGroupVocabulariesDisplay(long groupId,
                                                                                                                      String name,
                                                                                                                      int start,
                                                                                                                      int end,
                                                                                                                      OrderByComparator<AssetVocabulary> obc)
                                                                                                               throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getVocabularies

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getVocabularies(long[] vocabularyIds)
                                                                                                               throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by AssetUtil#filterVocabularyIds(PermissionChecker, long[])

Throws:

PortalException

getVocabulary

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabulary getVocabulary(long vocabularyId)
                                                                                          throws PortalException

Throws:

PortalException

searchVocabulariesDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabularyDisplay searchVocabulariesDisplay(long groupId,
                                                                                                                    String title,
                                                                                                                    boolean addDefaultVocabulary,
                                                                                                                    int start,
                                                                                                                    int end)
                                                                                                             throws PortalException

Throws:

PortalException

searchVocabulariesDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabularyDisplay searchVocabulariesDisplay(long groupId,
                                                                                                                    String title,
                                                                                                                    boolean addDefaultVocabulary,
                                                                                                                    int start,
                                                                                                                    int end,
                                                                                                                    Sort sort)
                                                                                                             throws PortalException

Throws:

PortalException

updateVocabulary

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

Throws:

PortalException