Liferay 6.0.5

com.liferay.portlet.asset.service
Interface AssetVocabularyLocalService

All Known Implementing Classes:
AssetVocabularyLocalServiceBaseImpl, AssetVocabularyLocalServiceImpl, AssetVocabularyLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AssetVocabularyLocalService

The interface for the asset vocabulary local service.

Never modify or reference this interface directly. Always use AssetVocabularyLocalServiceUtil to access the asset vocabulary local service. Add custom service methods to AssetVocabularyLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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:
AssetVocabularyLocalServiceUtil, AssetVocabularyLocalServiceBaseImpl, AssetVocabularyLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 AssetVocabulary addAssetVocabulary(AssetVocabulary assetVocabulary)
          Adds the asset vocabulary to the database.
 AssetVocabulary addVocabulary(long userId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
           
 void addVocabularyResources(AssetVocabulary vocabulary, boolean addCommunityPermissions, boolean addGuestPermissions)
           
 void addVocabularyResources(AssetVocabulary vocabulary, String[] communityPermissions, String[] guestPermissions)
           
 AssetVocabulary createAssetVocabulary(long vocabularyId)
          Creates a new asset vocabulary with the primary key.
 void deleteAssetVocabulary(AssetVocabulary assetVocabulary)
          Deletes the asset vocabulary from the database.
 void deleteAssetVocabulary(long vocabularyId)
          Deletes the asset vocabulary with the primary key from the database.
 void deleteVocabulary(AssetVocabulary vocabulary)
           
 void deleteVocabulary(long vocabularyId)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 List<AssetVocabulary> getAssetVocabularies(int start, int end)
          Gets a range of all the asset vocabularies.
 int getAssetVocabulariesCount()
          Gets the number of asset vocabularies.
 AssetVocabulary getAssetVocabulary(long vocabularyId)
          Gets the asset vocabulary with the primary key.
 AssetVocabulary getAssetVocabularyByUuidAndGroupId(String uuid, long groupId)
          Gets the asset vocabulary with the UUID and group id.
 List<AssetVocabulary> getCompanyVocabularies(long companyId)
           
 List<AssetVocabulary> getGroupsVocabularies(long[] groupIds)
           
 List<AssetVocabulary> getGroupVocabularies(long groupId)
           
 AssetVocabulary getGroupVocabulary(long groupId, String name)
           
 AssetVocabulary getVocabulary(long vocabularyId)
           
 AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary)
          Updates the asset vocabulary in the database.
 AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary, boolean merge)
          Updates the asset vocabulary in the database.
 AssetVocabulary updateVocabulary(long vocabularyId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
           
 

Method Detail

addAssetVocabulary

AssetVocabulary addAssetVocabulary(AssetVocabulary assetVocabulary)
                                   throws SystemException
Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.

Parameters:
assetVocabulary - the asset vocabulary to add
Returns:
the asset vocabulary that was added
Throws:
SystemException - if a system exception occurred

createAssetVocabulary

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

void 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 to delete
Throws:
PortalException - if a asset vocabulary with the primary key could not be found
SystemException - if a system exception occurred

deleteAssetVocabulary

void deleteAssetVocabulary(AssetVocabulary assetVocabulary)
                           throws SystemException
Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.

Parameters:
assetVocabulary - the asset vocabulary to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

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

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

getAssetVocabulary

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabulary getAssetVocabulary(long vocabularyId)
                                   throws PortalException,
                                          SystemException
Gets the asset vocabulary with the primary key.

Parameters:
vocabularyId - the primary key of the asset vocabulary to get
Returns:
the asset vocabulary
Throws:
PortalException - if a asset vocabulary with the primary key could not be found
SystemException - if a system exception occurred

getAssetVocabularyByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabulary getAssetVocabularyByUuidAndGroupId(String uuid,
                                                                                            long groupId)
                                                   throws PortalException,
                                                          SystemException
Gets the asset vocabulary with the UUID and group id.

Parameters:
uuid - the UUID of asset vocabulary to get
groupId - the group id of the asset vocabulary to get
Returns:
the asset vocabulary
Throws:
PortalException - if a asset vocabulary with the UUID and group id could not be found
SystemException - if a system exception occurred

getAssetVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getAssetVocabularies(int start,
                                                                                    int end)
                                           throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of asset vocabularies to return
end - the upper bound of the range of asset vocabularies to return (not inclusive)
Returns:
the range of asset vocabularies
Throws:
SystemException - if a system exception occurred

getAssetVocabulariesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetVocabulariesCount()
                              throws SystemException
Gets the number of asset vocabularies.

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

updateAssetVocabulary

AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary)
                                      throws SystemException
Updates the asset vocabulary in the database. Also notifies the appropriate model listeners.

Parameters:
assetVocabulary - the asset vocabulary to update
Returns:
the asset vocabulary that was updated
Throws:
SystemException - if a system exception occurred

updateAssetVocabulary

AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary,
                                      boolean merge)
                                      throws SystemException
Updates the asset vocabulary in the database. Also notifies the appropriate model listeners.

Parameters:
assetVocabulary - the asset vocabulary to update
merge - whether to merge the asset vocabulary with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the asset vocabulary that was updated
Throws:
SystemException - if a system exception occurred

addVocabulary

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

addVocabularyResources

void addVocabularyResources(AssetVocabulary vocabulary,
                            boolean addCommunityPermissions,
                            boolean addGuestPermissions)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

addVocabularyResources

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

deleteVocabulary

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

deleteVocabulary

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

getCompanyVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getCompanyVocabularies(long companyId)
                                             throws SystemException
Throws:
SystemException

getGroupsVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getGroupsVocabularies(long[] groupIds)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

getGroupVocabularies

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

getGroupVocabulary

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabulary getGroupVocabulary(long groupId,
                                                                            String name)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

getVocabulary

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

updateVocabulary

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

Liferay 6.0.5