Liferay 6.1.2-ce-ga3

com.liferay.portlet.asset.service
Class AssetTagPropertyLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.asset.service.AssetTagPropertyLocalServiceUtil

public class AssetTagPropertyLocalServiceUtil
extends Object

The utility for the asset tag property local service. This utility wraps com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:
AssetTagPropertyLocalService, com.liferay.portlet.asset.service.base.AssetTagPropertyLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl

Constructor Summary
AssetTagPropertyLocalServiceUtil()
           
 
Method Summary
static AssetTagProperty addAssetTagProperty(AssetTagProperty assetTagProperty)
          Adds the asset tag property to the database.
static AssetTagProperty addTagProperty(long userId, long tagId, String key, String value)
          Adds an asset tag property.
static AssetTagProperty createAssetTagProperty(long tagPropertyId)
          Creates a new asset tag property with the primary key.
static AssetTagProperty deleteAssetTagProperty(AssetTagProperty assetTagProperty)
          Deletes the asset tag property from the database.
static AssetTagProperty deleteAssetTagProperty(long tagPropertyId)
          Deletes the asset tag property with the primary key from the database.
static void deleteTagProperties(long tagId)
          Deletes the asset tag property with the specified tag ID.
static void deleteTagProperty(AssetTagProperty tagProperty)
          Deletes the asset tag property instance.
static void deleteTagProperty(long tagPropertyId)
          Deletes the asset tag property with the specified ID.
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static AssetTagProperty fetchAssetTagProperty(long tagPropertyId)
           
static List<AssetTagProperty> getAssetTagProperties(int start, int end)
          Returns a range of all the asset tag properties.
static int getAssetTagPropertiesCount()
          Returns the number of asset tag properties.
static AssetTagProperty getAssetTagProperty(long tagPropertyId)
          Returns the asset tag property with the primary key.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static AssetTagPropertyLocalService getService()
           
static List<AssetTagProperty> getTagProperties()
          Returns all the asset tag property instances.
static List<AssetTagProperty> getTagProperties(long tagId)
          Returns all the asset tag property instances with the specified tag ID.
static AssetTagProperty getTagProperty(long tagPropertyId)
          Returns the asset tag property with the specified ID.
static AssetTagProperty getTagProperty(long tagId, String key)
          Returns the asset tag property with the specified tag ID and key.
static String[] getTagPropertyKeys(long groupId)
          Returns asset tag property keys with the specified group
static List<AssetTagProperty> getTagPropertyValues(long groupId, String key)
          Returns asset tag properties with the specified group and key.
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(AssetTagPropertyLocalService service)
          Deprecated.  
static AssetTagProperty updateAssetTagProperty(AssetTagProperty assetTagProperty)
          Updates the asset tag property in the database or adds it if it does not yet exist.
static AssetTagProperty updateAssetTagProperty(AssetTagProperty assetTagProperty, boolean merge)
          Updates the asset tag property in the database or adds it if it does not yet exist.
static AssetTagProperty updateTagProperty(long tagPropertyId, String key, String value)
          Updates the asset tag property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AssetTagPropertyLocalServiceUtil

public AssetTagPropertyLocalServiceUtil()
Method Detail

addAssetTagProperty

public static AssetTagProperty addAssetTagProperty(AssetTagProperty assetTagProperty)
                                            throws SystemException
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
Throws:
SystemException - if a system exception occurred

createAssetTagProperty

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

public static AssetTagProperty deleteAssetTagProperty(long tagPropertyId)
                                               throws PortalException,
                                                      SystemException
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
SystemException - if a system exception occurred

deleteAssetTagProperty

public static AssetTagProperty deleteAssetTagProperty(AssetTagProperty assetTagProperty)
                                               throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

fetchAssetTagProperty

public static AssetTagProperty fetchAssetTagProperty(long tagPropertyId)
                                              throws SystemException
Throws:
SystemException

getAssetTagProperty

public static AssetTagProperty getAssetTagProperty(long tagPropertyId)
                                            throws PortalException,
                                                   SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getAssetTagProperties

public static List<AssetTagProperty> getAssetTagProperties(int start,
                                                           int end)
                                                    throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

getAssetTagPropertiesCount

public static int getAssetTagPropertiesCount()
                                      throws SystemException
Returns the number of asset tag properties.

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

updateAssetTagProperty

public static AssetTagProperty updateAssetTagProperty(AssetTagProperty assetTagProperty)
                                               throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateAssetTagProperty

public static AssetTagProperty updateAssetTagProperty(AssetTagProperty assetTagProperty,
                                                      boolean merge)
                                               throws SystemException
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
merge - whether to merge the asset tag property 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 tag property that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addTagProperty

public static AssetTagProperty addTagProperty(long userId,
                                              long tagId,
                                              String key,
                                              String value)
                                       throws PortalException,
                                              SystemException
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
SystemException - if a system exception occurred

deleteTagProperties

public static void deleteTagProperties(long tagId)
                                throws SystemException
Deletes the asset tag property with the specified tag ID.

Parameters:
tagId - the primary key of the tag
Throws:
SystemException - if a system exception occurred

deleteTagProperty

public static void deleteTagProperty(AssetTagProperty tagProperty)
                              throws SystemException
Deletes the asset tag property instance.

Parameters:
tagProperty - the asset tag property instance
Throws:
SystemException - if a system exception occurred

deleteTagProperty

public static void deleteTagProperty(long tagPropertyId)
                              throws PortalException,
                                     SystemException
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
SystemException - if a system exception occurred

getTagProperties

public static List<AssetTagProperty> getTagProperties()
                                               throws SystemException
Returns all the asset tag property instances.

Returns:
the asset tag property instances
Throws:
SystemException - if a system exception occurred

getTagProperties

public static List<AssetTagProperty> getTagProperties(long tagId)
                                               throws SystemException
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
Throws:
SystemException - if a system exception occurred

getTagProperty

public static AssetTagProperty getTagProperty(long tagPropertyId)
                                       throws PortalException,
                                              SystemException
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
SystemException - if a system exception occurred

getTagProperty

public static AssetTagProperty getTagProperty(long tagId,
                                              String key)
                                       throws PortalException,
                                              SystemException
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
SystemException - if a system exception occurred

getTagPropertyKeys

public static String[] getTagPropertyKeys(long groupId)
                                   throws SystemException
Returns asset tag property keys with the specified group

Parameters:
groupId - the primary key of the group
Returns:
the matching asset tag property keys
Throws:
SystemException - if a system exception occurred

getTagPropertyValues

public static List<AssetTagProperty> getTagPropertyValues(long groupId,
                                                          String key)
                                                   throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateTagProperty

public static AssetTagProperty updateTagProperty(long tagPropertyId,
                                                 String key,
                                                 String value)
                                          throws PortalException,
                                                 SystemException
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
SystemException - if a system exception occurred

getService

public static AssetTagPropertyLocalService getService()

setService

public void setService(AssetTagPropertyLocalService service)
Deprecated. 


Liferay 6.1.2-ce-ga3