Interface AssetVocabularyLocalService
- All Superinterfaces:
BaseLocalService
,CTService<AssetVocabulary>
,PersistedModelLocalService
- All Known Implementing Classes:
AssetVocabularyLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddAssetVocabulary
(AssetVocabulary assetVocabulary) Adds the asset vocabulary to the database.addDefaultVocabulary
(long groupId) addVocabulary
(long userId, long groupId, String title, ServiceContext serviceContext) addVocabulary
(long userId, long groupId, String name, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, ServiceContext serviceContext) addVocabulary
(long userId, long groupId, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) addVocabulary
(long userId, long groupId, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, ServiceContext serviceContext) addVocabulary
(String externalReferenceCode, long userId, long groupId, String name, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) void
addVocabularyResources
(AssetVocabulary vocabulary, boolean addGroupPermissions, boolean addGuestPermissions) void
addVocabularyResources
(AssetVocabulary vocabulary, ModelPermissions modelPermissions) createAssetVocabulary
(long vocabularyId) Creates a new asset vocabulary with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteAssetVocabulary
(long vocabularyId) Deletes the asset vocabulary with the primary key from the database.deleteAssetVocabulary
(AssetVocabulary assetVocabulary) Deletes the asset vocabulary from the database.deletePersistedModel
(PersistedModel persistedModel) void
deleteVocabularies
(long groupId) void
deleteVocabulary
(long vocabularyId) deleteVocabulary
(AssetVocabulary vocabulary) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchAssetVocabulary
(long vocabularyId) fetchAssetVocabularyByExternalReferenceCode
(String externalReferenceCode, long groupId) fetchAssetVocabularyByUuidAndGroupId
(String uuid, long groupId) Returns the asset vocabulary matching the UUID and group.fetchGroupVocabulary
(long groupId, String name) getAssetVocabularies
(int start, int end) Returns a range of all the asset vocabularies.getAssetVocabulariesByUuidAndCompanyId
(String uuid, long companyId) Returns all the asset vocabularies matching the UUID and company.getAssetVocabulariesByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<AssetVocabulary> orderByComparator) Returns a range of asset vocabularies matching the UUID and company.int
Returns the number of asset vocabularies.getAssetVocabulary
(long vocabularyId) Returns the asset vocabulary with the primary key.getAssetVocabularyByExternalReferenceCode
(String externalReferenceCode, long groupId) getAssetVocabularyByUuidAndGroupId
(String uuid, long groupId) Returns the asset vocabulary matching the UUID and group.getCompanyVocabularies
(long companyId) getExportActionableDynamicQuery
(PortletDataContext portletDataContext) getGroupsVocabularies
(long[] groupIds) getGroupsVocabularies
(long[] groupIds, String className) getGroupsVocabularies
(long[] groupIds, String className, long classTypePK) getGroupVocabularies
(long groupId) getGroupVocabularies
(long[] groupIds) getGroupVocabularies
(long[] groupIds, int[] visibilityTypes) getGroupVocabularies
(long groupId, boolean addDefaultVocabulary) getGroupVocabularies
(long groupId, int visibilityType) int
getGroupVocabulariesCount
(long[] groupIds) getGroupVocabulary
(long groupId, String name) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getVocabularies
(long[] vocabularyIds) getVocabularies
(Hits hits) getVocabulary
(long vocabularyId) searchVocabularies
(long companyId, long[] groupIds, String title, int[] visibilityTypes, int start, int end, Sort sort) updateAssetVocabulary
(AssetVocabulary assetVocabulary) Updates the asset vocabulary in the database or adds it if it does not yet exist.updateVocabulary
(long vocabularyId, String title, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, ServiceContext serviceContext) updateVocabulary
(long vocabularyId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings) updateVocabulary
(long vocabularyId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String settings, int visibilityType) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<AssetVocabulary>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addAssetVocabulary
Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.Important: Inspect AssetVocabularyLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
assetVocabulary
- the asset vocabulary- Returns:
- the asset vocabulary that was added
-
addDefaultVocabulary
- Throws:
PortalException
-
addVocabulary
AssetVocabulary addVocabulary(long userId, long groupId, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) - Throws:
PortalException
-
addVocabulary
AssetVocabulary addVocabulary(long userId, long groupId, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, ServiceContext serviceContext) - Throws:
PortalException
-
addVocabulary
AssetVocabulary addVocabulary(long userId, long groupId, String title, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addVocabulary
AssetVocabulary addVocabulary(long userId, long groupId, String name, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, ServiceContext serviceContext) - Throws:
PortalException
-
addVocabulary
@Indexable(type=REINDEX) AssetVocabulary addVocabulary(String externalReferenceCode, long userId, long groupId, String name, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, int visibilityType, ServiceContext serviceContext) - 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
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
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteAssetVocabulary
Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.Important: Inspect AssetVocabularyLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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.Important: Inspect AssetVocabularyLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteVocabularies
- Throws:
PortalException
-
deleteVocabulary
@Indexable(type=DELETE) @SystemEvent(action=1, type=1) AssetVocabulary deleteVocabulary(AssetVocabulary vocabulary) throws PortalException - Throws:
PortalException
-
deleteVocabulary
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.asset.model.impl.AssetVocabularyModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.asset.model.impl.AssetVocabularyModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- 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) -
fetchAssetVocabularyByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) AssetVocabulary fetchAssetVocabularyByExternalReferenceCode(String externalReferenceCode, long groupId) -
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 UUIDgroupId
- the primary key of the group- Returns:
- the matching asset vocabulary, or
null
if a matching asset vocabulary could not be found
-
fetchGroupVocabulary
@Transactional(propagation=SUPPORTS, readOnly=true) AssetVocabulary fetchGroupVocabulary(long groupId, String name) -
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.asset.model.impl.AssetVocabularyModelImpl
.- Parameters:
start
- the lower bound of the range of asset vocabulariesend
- 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 vocabulariescompanyId
- 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 vocabulariescompanyId
- the primary key of the companystart
- the lower bound of the range of asset vocabulariesend
- the upper bound of the range of asset vocabularies (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching asset vocabularies, or an empty list if no matches were found
-
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
-
getAssetVocabularyByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) AssetVocabulary getAssetVocabularyByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
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 UUIDgroupId
- 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) -
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 addDefaultVocabulary) throws PortalException - Throws:
PortalException
-
getGroupVocabularies
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetVocabulary> getGroupVocabularies(long groupId, int visibilityType) -
getGroupVocabularies
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetVocabulary> getGroupVocabularies(long[] groupIds) -
getGroupVocabularies
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetVocabulary> getGroupVocabularies(long[] groupIds, int[] visibilityTypes) -
getGroupVocabulariesCount
-
getGroupVocabulary
@Transactional(propagation=SUPPORTS, readOnly=true) AssetVocabulary getGroupVocabulary(long groupId, String name) throws PortalException - Throws:
PortalException
-
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 interfacePersistedModelLocalService
- 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[] groupIds, String title, int[] visibilityTypes, int start, int end, Sort sort) throws PortalException - Throws:
PortalException
-
updateAssetVocabulary
Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect AssetVocabularyLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
assetVocabulary
- the asset vocabulary- Returns:
- the asset vocabulary that was updated
-
updateVocabulary
AssetVocabulary updateVocabulary(long vocabularyId, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings) - Throws:
PortalException
-
updateVocabulary
@Indexable(type=REINDEX) AssetVocabulary updateVocabulary(long vocabularyId, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, int visibilityType) - Throws:
PortalException
-
updateVocabulary
@Indexable(type=REINDEX) AssetVocabulary updateVocabulary(long vocabularyId, String title, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, String settings, ServiceContext serviceContext) - Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<AssetVocabulary>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<AssetVocabulary>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<AssetVocabulary>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<AssetVocabulary>
- Throws:
E extends Throwable
-