Liferay 6.1.2-ce-ga3

com.liferay.portlet.asset.service
Interface AssetVocabularyLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
AssetVocabularyLocalServiceWrapper

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

The interface for the asset vocabulary local service.

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, com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl

Method Summary
 AssetVocabulary addAssetVocabulary(AssetVocabulary assetVocabulary)
          Adds the asset vocabulary to the database.
 AssetVocabulary addDefaultVocabulary(long groupId)
           
 AssetVocabulary addVocabulary(long userId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
          Deprecated.  
 AssetVocabulary addVocabulary(long userId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
           
 AssetVocabulary addVocabulary(long userId, String title, ServiceContext serviceContext)
           
 void addVocabularyResources(AssetVocabulary vocabulary, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addVocabularyResources(AssetVocabulary vocabulary, String[] groupPermissions, String[] guestPermissions)
           
 AssetVocabulary createAssetVocabulary(long vocabularyId)
          Creates a new asset vocabulary with the primary key.
 AssetVocabulary deleteAssetVocabulary(AssetVocabulary assetVocabulary)
          Deletes the asset vocabulary from the database.
 AssetVocabulary deleteAssetVocabulary(long vocabularyId)
          Deletes the asset vocabulary with the primary key from the database.
 void deleteVocabularies(long groupId)
           
 void deleteVocabulary(AssetVocabulary vocabulary)
           
 void deleteVocabulary(long vocabularyId)
           
 DynamicQuery dynamicQuery()
           
 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)
          Returns the number of rows that match the dynamic query.
 AssetVocabulary fetchAssetVocabulary(long vocabularyId)
           
 List<AssetVocabulary> getAssetVocabularies(int start, int end)
          Returns a range of all the asset vocabularies.
 int getAssetVocabulariesCount()
          Returns the number of asset vocabularies.
 AssetVocabulary getAssetVocabulary(long vocabularyId)
          Returns the asset vocabulary with the primary key.
 AssetVocabulary getAssetVocabularyByUuidAndGroupId(String uuid, long groupId)
          Returns the asset vocabulary with the UUID in the group.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<AssetVocabulary> getCompanyVocabularies(long companyId)
           
 List<AssetVocabulary> getGroupsVocabularies(long[] groupIds)
           
 List<AssetVocabulary> getGroupsVocabularies(long[] groupIds, String className)
           
 List<AssetVocabulary> getGroupVocabularies(long groupId)
           
 List<AssetVocabulary> getGroupVocabularies(long groupId, boolean addDefaultVocabulary)
           
 List<AssetVocabulary> getGroupVocabularies(long groupId, String name, int start, int end, OrderByComparator obc)
           
 AssetVocabulary getGroupVocabulary(long groupId, String name)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<AssetVocabulary> getVocabularies(long[] vocabularyIds)
           
 AssetVocabulary getVocabulary(long vocabularyId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary)
          Updates the asset vocabulary in the database or adds it if it does not yet exist.
 AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary, boolean merge)
          Updates the asset vocabulary in the database or adds it if it does not yet exist.
 AssetVocabulary updateVocabulary(long vocabularyId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
          Deprecated.  
 AssetVocabulary updateVocabulary(long vocabularyId, String title, 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
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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

fetchAssetVocabulary

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

getAssetVocabulary

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getAssetVocabularyByUuidAndGroupId

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

Parameters:
uuid - the UUID of asset vocabulary
groupId - the group id of the asset vocabulary
Returns:
the asset vocabulary
Throws:
PortalException - if a asset vocabulary with the UUID in the group 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
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetVocabulariesCount()
                              throws SystemException
Returns 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 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

updateAssetVocabulary

AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary,
                                      boolean merge)
                                      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
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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addDefaultVocabulary

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

addVocabulary

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

Throws:
PortalException
SystemException

addVocabulary

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

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

addVocabularyResources

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

addVocabularyResources

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

deleteVocabularies

void deleteVocabularies(long groupId)
                        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

getGroupsVocabularies

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

getGroupVocabularies

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

getGroupVocabularies

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

getGroupVocabularies

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

getGroupVocabulary

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

getVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getVocabularies(long[] vocabularyIds)
                                      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
Deprecated. 

Throws:
PortalException
SystemException

updateVocabulary

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

Liferay 6.1.2-ce-ga3