Liferay 7.0-ce-b4

com.liferay.portlet.asset.service
Interface AssetVocabularyLocalService

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

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

Provides the local service interface for AssetVocabulary. 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 it is generated.

Method Summary
 AssetVocabulary addAssetVocabulary(AssetVocabulary assetVocabulary)
          Adds the asset vocabulary to the database.
 AssetVocabulary addDefaultVocabulary(long groupId)
           
 AssetVocabulary addVocabulary(long userId, long groupId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
           
 AssetVocabulary addVocabulary(long userId, long groupId, String title, ServiceContext serviceContext)
           
 void addVocabularyResources(AssetVocabulary vocabulary, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addVocabularyResources(AssetVocabulary vocabulary, ModelPermissions modelPermissions)
           
 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.
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 void deleteVocabularies(long groupId)
           
 AssetVocabulary deleteVocabulary(AssetVocabulary vocabulary)
           
 void deleteVocabulary(long vocabularyId)
           
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 AssetVocabulary fetchAssetVocabulary(long vocabularyId)
           
 AssetVocabulary fetchAssetVocabularyByUuidAndGroupId(String uuid, long groupId)
          Returns the asset vocabulary matching the UUID and group.
 ActionableDynamicQuery getActionableDynamicQuery()
           
 List<AssetVocabulary> getAssetVocabularies(int start, int end)
          Returns a range of all the asset vocabularies.
 List<AssetVocabulary> getAssetVocabulariesByUuidAndCompanyId(String uuid, long companyId)
          Returns all the asset vocabularies matching the UUID and company.
 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.
 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 matching the UUID and group.
 List<AssetVocabulary> getCompanyVocabularies(long companyId)
           
 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
 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 addDefaultVocabulary)
           
 List<AssetVocabulary> getGroupVocabularies(long groupId, String name, int start, int end, OrderByComparator<AssetVocabulary> obc)
           
 int getGroupVocabulariesCount(long[] groupIds)
           
 AssetVocabulary getGroupVocabulary(long groupId, String name)
           
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<AssetVocabulary> getVocabularies(Hits hits)
           
 List<AssetVocabulary> getVocabularies(long[] vocabularyIds)
           
 AssetVocabulary getVocabulary(long vocabularyId)
           
 BaseModelSearchResult<AssetVocabulary> searchVocabularies(long companyId, long groupId, String title, int start, int end)
           
 BaseModelSearchResult<AssetVocabulary> searchVocabularies(long companyId, long groupId, String title, int start, int end, Sort sort)
           
 AssetVocabulary updateAssetVocabulary(AssetVocabulary assetVocabulary)
          Updates the asset vocabulary in the database or adds it if it does not yet exist.
 AssetVocabulary updateVocabulary(long vocabularyId, String title, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String settings, ServiceContext serviceContext)
           
 

Method Detail

addAssetVocabulary

@Indexable(type=REINDEX)
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

AssetVocabulary addDefaultVocabulary(long groupId)
                                     throws PortalException
Throws:
PortalException

addVocabulary

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

addVocabulary

@Indexable(type=REINDEX)
AssetVocabulary addVocabulary(long userId,
                                                   long groupId,
                                                   String title,
                                                   Map<Locale,String> titleMap,
                                                   Map<Locale,String> descriptionMap,
                                                   String settings,
                                                   ServiceContext serviceContext)
                              throws PortalException
Throws:
PortalException

addVocabularyResources

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

addVocabularyResources

void addVocabularyResources(AssetVocabulary vocabulary,
                            ModelPermissions modelPermissions)
                            throws PortalException
Throws:
PortalException

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteVocabularies

void deleteVocabularies(long groupId)
                        throws PortalException
Throws:
PortalException

deleteVocabulary

@Indexable(type=DELETE)
@SystemEvent(action=1,
             type=1)
AssetVocabulary deleteVocabulary(AssetVocabulary vocabulary)
                                 throws PortalException
Throws:
PortalException

deleteVocabulary

void deleteVocabulary(long vocabularyId)
                      throws PortalException
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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

<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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabulary fetchAssetVocabulary(long vocabularyId)

fetchAssetVocabularyByUuidAndGroupId

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getAssetVocabularies

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

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

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

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

Returns:
the number of asset vocabularies

getAssetVocabulary

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

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

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

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

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 addDefaultVocabulary)
                                           throws PortalException
Throws:
PortalException

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[] groupIds)

getGroupVocabulary

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetVocabulary getGroupVocabulary(long groupId,
                                                                            String name)
                                   throws PortalException
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)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

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

getVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetVocabulary> getVocabularies(Hits hits)
                                      throws PortalException
Throws:
PortalException

getVocabularies

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

getVocabulary

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

searchVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<AssetVocabulary> searchVocabularies(long companyId,
                                                                                                   long groupId,
                                                                                                   String title,
                                                                                                   int start,
                                                                                                   int end)
                                                          throws PortalException
Throws:
PortalException

searchVocabularies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<AssetVocabulary> searchVocabularies(long companyId,
                                                                                                   long groupId,
                                                                                                   String title,
                                                                                                   int start,
                                                                                                   int end,
                                                                                                   Sort sort)
                                                          throws PortalException
Throws:
PortalException

updateAssetVocabulary

@Indexable(type=REINDEX)
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

@Indexable(type=REINDEX)
AssetVocabulary updateVocabulary(long vocabularyId,
                                                      String title,
                                                      Map<Locale,String> titleMap,
                                                      Map<Locale,String> descriptionMap,
                                                      String settings,
                                                      ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4