Liferay 6.1.2-ce-ga3

com.liferay.portlet.asset.service.http
Class AssetTagPropertyServiceSoap

java.lang.Object
  extended by com.liferay.portlet.asset.service.http.AssetTagPropertyServiceSoap

public class AssetTagPropertyServiceSoap
extends Object

This class provides a SOAP utility for the AssetTagPropertyServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it is difficult for SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a List, that is translated to an array of AssetTagPropertySoap. If the method in the service utility returns a AssetTagProperty, that is translated to a AssetTagPropertySoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/secure/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

See Also:
AssetTagPropertyServiceHttp, AssetTagPropertySoap, AssetTagPropertyServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
AssetTagPropertyServiceSoap()
           
 
Method Summary
static AssetTagPropertySoap addTagProperty(long tagId, String key, String value)
          Adds an asset tag property.
static void deleteTagProperty(long tagPropertyId)
          Deletes the asset tag property with the specified ID.
static AssetTagPropertySoap[] getTagProperties(long tagId)
          Returns all the asset tag property instances with the specified tag ID.
static AssetTagPropertySoap[] getTagPropertyValues(long companyId, String key)
          Returns asset tag properties with the specified group and key.
static AssetTagPropertySoap 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

AssetTagPropertyServiceSoap

public AssetTagPropertyServiceSoap()
Method Detail

addTagProperty

public static AssetTagPropertySoap addTagProperty(long tagId,
                                                  String key,
                                                  String value)
                                           throws RemoteException
Adds an asset tag property.

Parameters:
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 the user did not have permission to update the asset tag, or if the key or value were invalid
SystemException - if a system exception occurred
RemoteException

deleteTagProperty

public static void deleteTagProperty(long tagPropertyId)
                              throws RemoteException
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 or if the user did not have permission to update the asset tag property
SystemException - if a system exception occurred
RemoteException

getTagProperties

public static AssetTagPropertySoap[] getTagProperties(long tagId)
                                               throws RemoteException
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
RemoteException

getTagPropertyValues

public static AssetTagPropertySoap[] getTagPropertyValues(long companyId,
                                                          String key)
                                                   throws RemoteException
Returns asset tag properties with the specified group and key.

Parameters:
companyId - the primary key of the company
key - the key that refers to some value
Returns:
the matching asset tag properties
Throws:
SystemException - if a system exception occurred
RemoteException

updateTagProperty

public static AssetTagPropertySoap updateTagProperty(long tagPropertyId,
                                                     String key,
                                                     String value)
                                              throws RemoteException
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, if the user did not have permission to update the asset tag, or if the key or value were invalid
SystemException - if a system exception occurred
RemoteException

Liferay 6.1.2-ce-ga3