Liferay 7.0-ce-m3

com.liferay.portlet.asset.service
Interface AssetTagPropertyLocalService

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

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

Provides the local service interface for AssetTagProperty. 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:
AssetTagPropertyLocalServiceUtil, com.liferay.portlet.asset.service.base.AssetTagPropertyLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl

Method Summary
 AssetTagProperty addAssetTagProperty(AssetTagProperty assetTagProperty)
          Adds the asset tag property to the database.
 AssetTagProperty addTagProperty(long userId, long tagId, String key, String value)
          Adds an asset tag property.
 AssetTagProperty createAssetTagProperty(long tagPropertyId)
          Creates a new asset tag property with the primary key.
 AssetTagProperty deleteAssetTagProperty(AssetTagProperty assetTagProperty)
          Deletes the asset tag property from the database.
 AssetTagProperty deleteAssetTagProperty(long tagPropertyId)
          Deletes the asset tag property with the primary key from the database.
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 void deleteTagProperties(long tagId)
          Deletes the asset tag property with the specified tag ID.
 void deleteTagProperty(AssetTagProperty tagProperty)
          Deletes the asset tag property instance.
 void deleteTagProperty(long tagPropertyId)
          Deletes the asset tag property with the specified ID.
 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.
 AssetTagProperty fetchAssetTagProperty(long tagPropertyId)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 List<AssetTagProperty> getAssetTagProperties(int start, int end)
          Returns a range of all the asset tag properties.
 int getAssetTagPropertiesCount()
          Returns the number of asset tag properties.
 AssetTagProperty getAssetTagProperty(long tagPropertyId)
          Returns the asset tag property with the primary key.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<AssetTagProperty> getTagProperties()
          Returns all the asset tag property instances.
 List<AssetTagProperty> getTagProperties(long tagId)
          Returns all the asset tag property instances with the specified tag ID.
 AssetTagProperty getTagProperty(long tagPropertyId)
          Returns the asset tag property with the specified ID.
 AssetTagProperty getTagProperty(long tagId, String key)
          Returns the asset tag property with the specified tag ID and key.
 String[] getTagPropertyKeys(long groupId)
          Returns asset tag property keys with the specified group
 List<AssetTagProperty> getTagPropertyValues(long groupId, String key)
          Returns asset tag properties with the specified group and key.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 AssetTagProperty updateAssetTagProperty(AssetTagProperty assetTagProperty)
          Updates the asset tag property in the database or adds it if it does not yet exist.
 AssetTagProperty updateTagProperty(long tagPropertyId, String key, String value)
          Updates the asset tag property.
 

Method Detail

addAssetTagProperty

@Indexable(type=REINDEX)
AssetTagProperty addAssetTagProperty(AssetTagProperty assetTagProperty)
Adds the asset tag property to the database. Also notifies the appropriate model listeners.

Parameters:
assetTagProperty - the asset tag property
Returns:
the asset tag property that was added

addTagProperty

AssetTagProperty addTagProperty(long userId,
                                long tagId,
                                String key,
                                String value)
                                throws PortalException
Adds an asset tag property.

Parameters:
userId - the primary key of the user
tagId - the primary key of the tag
key - the key to be associated to the value
value - the value to which the key will refer
Returns:
the created asset tag property
Throws:
PortalException - if a user with the primary key could not be found, or if the key or value were invalid

createAssetTagProperty

AssetTagProperty createAssetTagProperty(long tagPropertyId)
Creates a new asset tag property with the primary key. Does not add the asset tag property to the database.

Parameters:
tagPropertyId - the primary key for the new asset tag property
Returns:
the new asset tag property

deleteAssetTagProperty

@Indexable(type=DELETE)
AssetTagProperty deleteAssetTagProperty(AssetTagProperty assetTagProperty)
Deletes the asset tag property from the database. Also notifies the appropriate model listeners.

Parameters:
assetTagProperty - the asset tag property
Returns:
the asset tag property that was removed

deleteAssetTagProperty

@Indexable(type=DELETE)
AssetTagProperty deleteAssetTagProperty(long tagPropertyId)
                                        throws PortalException
Deletes the asset tag property with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
tagPropertyId - the primary key of the asset tag property
Returns:
the asset tag property that was removed
Throws:
PortalException - if a asset tag property with the primary key could not be found

deletePersistedModel

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

deleteTagProperties

void deleteTagProperties(long tagId)
Deletes the asset tag property with the specified tag ID.

Parameters:
tagId - the primary key of the tag

deleteTagProperty

void deleteTagProperty(AssetTagProperty tagProperty)
Deletes the asset tag property instance.

Parameters:
tagProperty - the asset tag property instance

deleteTagProperty

void deleteTagProperty(long tagPropertyId)
                       throws PortalException
Deletes the asset tag property with the specified ID.

Parameters:
tagPropertyId - the primary key of the asset tag property instance
Throws:
PortalException - if an asset tag property with the primary key could not be found

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 com.liferay.portlet.asset.model.impl.AssetTagPropertyModelImpl. 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 com.liferay.portlet.asset.model.impl.AssetTagPropertyModelImpl. 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

fetchAssetTagProperty

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetTagProperty fetchAssetTagProperty(long tagPropertyId)

getActionableDynamicQuery

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

getAssetTagProperties

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTagProperty> getAssetTagProperties(int start,
                                                                                      int end)
Returns a range of all the asset tag properties.

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 com.liferay.portlet.asset.model.impl.AssetTagPropertyModelImpl. 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 tag properties
end - the upper bound of the range of asset tag properties (not inclusive)
Returns:
the range of asset tag properties

getAssetTagPropertiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetTagPropertiesCount()
Returns the number of asset tag properties.

Returns:
the number of asset tag properties

getAssetTagProperty

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetTagProperty getAssetTagProperty(long tagPropertyId)
                                     throws PortalException
Returns the asset tag property with the primary key.

Parameters:
tagPropertyId - the primary key of the asset tag property
Returns:
the asset tag property
Throws:
PortalException - if a asset tag property with the primary key could not be found

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getPersistedModel

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

getTagProperties

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTagProperty> getTagProperties()
Returns all the asset tag property instances.

Returns:
the asset tag property instances

getTagProperties

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTagProperty> getTagProperties(long tagId)
Returns all the asset tag property instances with the specified tag ID.

Parameters:
tagId - the primary key of the tag
Returns:
the matching asset tag properties

getTagProperty

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetTagProperty getTagProperty(long tagId,
                                                                         String key)
                                throws PortalException
Returns the asset tag property with the specified tag ID and key.

Parameters:
tagId - the primary key of the tag
key - the key that refers to some value
Returns:
the matching asset tag property
Throws:
PortalException - if an asset tag property with the tag ID and key could not be found

getTagProperty

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetTagProperty getTagProperty(long tagPropertyId)
                                throws PortalException
Returns the asset tag property with the specified ID.

Parameters:
tagPropertyId - the primary key of the asset tag property
Returns:
the matching asset tag property
Throws:
PortalException - if an asset tag property with the primary key could not be found

getTagPropertyKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String[] getTagPropertyKeys(long groupId)
Returns asset tag property keys with the specified group

Parameters:
groupId - the primary key of the group
Returns:
the matching asset tag property keys

getTagPropertyValues

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTagProperty> getTagPropertyValues(long groupId,
                                                                                     String key)
Returns asset tag properties with the specified group and key.

Parameters:
groupId - the primary key of the group
key - the key that refers to some value
Returns:
the matching asset tag properties

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateAssetTagProperty

@Indexable(type=REINDEX)
AssetTagProperty updateAssetTagProperty(AssetTagProperty assetTagProperty)
Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
assetTagProperty - the asset tag property
Returns:
the asset tag property that was updated

updateTagProperty

AssetTagProperty updateTagProperty(long tagPropertyId,
                                   String key,
                                   String value)
                                   throws PortalException
Updates the asset tag property.

Parameters:
tagPropertyId - the primary key of the asset tag property
key - the new key to be associated to the value
value - the new value to which the key will refer
Returns:
the updated asset tag property
Throws:
PortalException - if an asset tag property with the primary key could not be found, or if the key or value were invalid

Liferay 7.0-ce-m3