com.liferay.portlet.dynamicdatamapping.service.http
Class DDMTemplateServiceSoap

java.lang.Object
  com.liferay.portlet.dynamicdatamapping.service.http.DDMTemplateServiceSoap

@ProviderType
public class DDMTemplateServiceSoap
extends Object

Provides the SOAP utility for the DDMTemplateServiceUtil 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 DDMTemplateSoap. If the method in the service utility returns a DDMTemplate, that is translated to a DDMTemplateSoap. 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/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:

DDMTemplateServiceHttp, DDMTemplateSoap, DDMTemplateServiceUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

DDMTemplateServiceSoap()

Method Summary

static DDMTemplateSoap	addTemplate(long groupId, long classNameId, long classPK, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String type, String mode, String language, String script, ServiceContext serviceContext) Adds a template.
static DDMTemplateSoap	copyTemplate(long templateId, ServiceContext serviceContext)
static DDMTemplateSoap	copyTemplate(long templateId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, ServiceContext serviceContext) Copies the template, creating a new template with all the values extracted from the original one.
static DDMTemplateSoap[]	copyTemplates(long classNameId, long classPK, long newClassPK, String type, ServiceContext serviceContext) Copies all the templates matching the class name ID, class PK, and type.
static void	deleteTemplate(long templateId) Deletes the template and its resources.
static DDMTemplateSoap	fetchTemplate(long groupId, long classNameId, String templateKey) Returns the template matching the group and template key.
static DDMTemplateSoap	getTemplate(long templateId) Returns the template with the ID.
static DDMTemplateSoap	getTemplate(long groupId, long classNameId, String templateKey) Returns the template matching the group and template key.
static DDMTemplateSoap	getTemplate(long groupId, long classNameId, String templateKey, boolean includeGlobalTemplates) Returns the template matching the group and template key, optionally in the global scope.
static DDMTemplateSoap[]	getTemplates(long groupId, long classNameId) Returns all the templates matching the group and class name ID.
static DDMTemplateSoap[]	getTemplates(long groupId, long classNameId, long classPK) Returns all the templates matching the group, class name ID, and class PK.
static DDMTemplateSoap[]	getTemplates(long groupId, long classNameId, long classPK, String type) Returns all the templates matching the class name ID, class PK, type, and mode.
static DDMTemplateSoap[]	getTemplates(long groupId, long classNameId, long classPK, String type, String mode)
static DDMTemplateSoap[]	getTemplatesByClassPK(long groupId, long classPK) Returns all the templates matching the group and class PK.
static DDMTemplateSoap[]	getTemplatesByStructureClassNameId(long groupId, long structureClassNameId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the templates matching the group and structure class name ID and all the generic templates matching the group.
static int	getTemplatesByStructureClassNameIdCount(long groupId, long structureClassNameId) Returns the number of templates matching the group and structure class name ID plus the number of generic templates matching the group.
static DDMTemplateSoap[]	search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, String keywords, String type, String mode, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the templates matching the group IDs, class name IDs, class PK, type, and mode, and matching the keywords in the template names and descriptions.
static DDMTemplateSoap[]	search(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, String name, String description, String type, String mode, String language, boolean andOperator, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the templates matching the group IDs, class name IDs, class PK, name keyword, description keyword, type, mode, and language.
static DDMTemplateSoap[]	search(long companyId, long groupId, long classNameId, long classPK, String keywords, String type, String mode, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the templates matching the group, class name ID, class PK, type, and mode, and matching the keywords in the template names and descriptions.
static DDMTemplateSoap[]	search(long companyId, long groupId, long classNameId, long classPK, String name, String description, String type, String mode, String language, boolean andOperator, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, and language.
static int	searchCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, String keywords, String type, String mode) Returns the number of templates matching the group IDs, class name IDs, class PK, type, and mode, and matching the keywords in the template names and descriptions.
static int	searchCount(long companyId, long[] groupIds, long[] classNameIds, long[] classPKs, String name, String description, String type, String mode, String language, boolean andOperator) Returns the number of templates matching the group IDs, class name IDs, class PK, name keyword, description keyword, type, mode, and language.
static int	searchCount(long companyId, long groupId, long classNameId, long classPK, String keywords, String type, String mode) Returns the number of templates matching the group, class name ID, class PK, type, and mode, and matching the keywords in the template names and descriptions.
static int	searchCount(long companyId, long groupId, long classNameId, long classPK, String name, String description, String type, String mode, String language, boolean andOperator) Returns the number of templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, and language.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DDMTemplateServiceSoap

public DDMTemplateServiceSoap()

Method Detail

addTemplate

public static DDMTemplateSoap addTemplate(long groupId,
                                          long classNameId,
                                          long classPK,
                                          String[] nameMapLanguageIds,
                                          String[] nameMapValues,
                                          String[] descriptionMapLanguageIds,
                                          String[] descriptionMapValues,
                                          String type,
                                          String mode,
                                          String language,
                                          String script,
                                          ServiceContext serviceContext)
                                   throws RemoteException

Adds a template.

Parameters:

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

classPK - the primary key of the template's related entity

nameMap - the template's locales and localized names

descriptionMap - the template's locales and localized descriptions

type - the template's type. For more information, see DDMTemplateConstants.

mode - the template's mode. For more information, see DDMTemplateConstants.

language - the template's script language. For more information, see DDMTemplateConstants.

script - the template's script

serviceContext - the service context to be applied. Must have the ddmResource attribute to check permissions. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.

Returns:

the template

Throws:

PortalException - if the user did not have permission to add the template or if a portal exception occurred

SystemException - if a system exception occurred

RemoteException

copyTemplate

public static DDMTemplateSoap copyTemplate(long templateId,
                                           String[] nameMapLanguageIds,
                                           String[] nameMapValues,
                                           String[] descriptionMapLanguageIds,
                                           String[] descriptionMapValues,
                                           ServiceContext serviceContext)
                                    throws RemoteException

Copies the template, creating a new template with all the values extracted from the original one. This method supports defining a new name and description.

Parameters:

templateId - the primary key of the template to be copied

nameMap - the new template's locales and localized names

descriptionMap - the new template's locales and localized descriptions

serviceContext - the service context to be applied. Must have the ddmResource attribute to check permissions. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.

Returns:

the new template

Throws:

PortalException - if the user did not have permission to add the template or if a portal exception occurred

SystemException - if a system exception occurred

RemoteException

copyTemplate

public static DDMTemplateSoap copyTemplate(long templateId,
                                           ServiceContext serviceContext)
                                    throws RemoteException

Throws:

RemoteException

copyTemplates

public static DDMTemplateSoap[] copyTemplates(long classNameId,
                                              long classPK,
                                              long newClassPK,
                                              String type,
                                              ServiceContext serviceContext)
                                       throws RemoteException

Copies all the templates matching the class name ID, class PK, and type. This method creates new templates, extracting all the values from the old ones and updating their class PKs.

Parameters:

classNameId - the primary key of the class name for template's related model

classPK - the primary key of the original template's related entity

newClassPK - the primary key of the new template's related entity

type - the template's type. For more information, see DDMTemplateConstants.

serviceContext - the service context to be applied. Must have the ddmResource attribute to check permissions. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the template.

Returns:

the new template

Throws:

PortalException - if the user did not have permission to add the template or if a portal exception occurred

SystemException - if a system exception occurred

RemoteException

deleteTemplate

public static void deleteTemplate(long templateId)
                           throws RemoteException

Deletes the template and its resources.

Parameters:

templateId - the primary key of the template to be deleted

Throws:

PortalException - if the user did not have permission to delete the template or if a portal exception occurred

SystemException - if a system exception occurred

RemoteException

fetchTemplate

public static DDMTemplateSoap fetchTemplate(long groupId,
                                            long classNameId,
                                            String templateKey)
                                     throws RemoteException

Returns the template matching the group and template key.

Parameters:

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

templateKey - the unique string identifying the template

Returns:

the matching template, or null if a matching template could not be found

Throws:

PortalException - if the user did not have permission to view the template

SystemException - if a system exception occurred

RemoteException

getTemplate

public static DDMTemplateSoap getTemplate(long templateId)
                                   throws RemoteException

Returns the template with the ID.

Parameters:

templateId - the primary key of the template

Returns:

the template with the ID

Throws:

PortalException - if the user did not have permission to view the template or if a matching template could not be found

SystemException - if a system exception occurred

RemoteException

getTemplate

public static DDMTemplateSoap getTemplate(long groupId,
                                          long classNameId,
                                          String templateKey)
                                   throws RemoteException

Returns the template matching the group and template key.

Parameters:

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

templateKey - the unique string identifying the template

Returns:

the matching template

Throws:

PortalException - if a matching template could not be found

SystemException - if a system exception occurred

RemoteException

getTemplate

public static DDMTemplateSoap getTemplate(long groupId,
                                          long classNameId,
                                          String templateKey,
                                          boolean includeGlobalTemplates)
                                   throws RemoteException

Returns the template matching the group and template key, optionally in the global scope.

This method first searches in the group. If the template is still not found and includeGlobalTemplates is set to true, this method searches the global group.

Parameters:

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

templateKey - the unique string identifying the template

includeGlobalTemplates - whether to include the global scope in the search

Returns:

the matching template

Throws:

PortalException - if a matching template could not be found

SystemException - if a system exception occurred

RemoteException

getTemplates

public static DDMTemplateSoap[] getTemplates(long groupId,
                                             long classNameId)
                                      throws RemoteException

Returns all the templates matching the group and class name ID.

Parameters:

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

Returns:

the matching templates

Throws:

SystemException - if a system exception occurred

RemoteException

getTemplates

public static DDMTemplateSoap[] getTemplates(long groupId,
                                             long classNameId,
                                             long classPK)
                                      throws RemoteException

Returns all the templates matching the group, class name ID, and class PK.

Parameters:

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

classPK - the primary key of the template's related entity

Returns:

the matching templates

Throws:

SystemException - if a system exception occurred

RemoteException

getTemplates

public static DDMTemplateSoap[] getTemplates(long groupId,
                                             long classNameId,
                                             long classPK,
                                             String type)
                                      throws RemoteException

Returns all the templates matching the class name ID, class PK, type, and mode.

Parameters:

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

classPK - the primary key of the template's related entity

type - the template's type. For more information, see DDMTemplateConstants.

Returns:

the matching templates

Throws:

SystemException - if a system exception occurred

RemoteException

getTemplates

public static DDMTemplateSoap[] getTemplates(long groupId,
                                             long classNameId,
                                             long classPK,
                                             String type,
                                             String mode)
                                      throws RemoteException

Throws:

RemoteException

getTemplatesByClassPK

public static DDMTemplateSoap[] getTemplatesByClassPK(long groupId,
                                                      long classPK)
                                               throws RemoteException

Returns all the templates matching the group and class PK.

Parameters:

groupId - the primary key of the group

classPK - the primary key of the template's related entity

Returns:

the matching templates

Throws:

SystemException - if a system exception occurred

RemoteException

getTemplatesByStructureClassNameId

public static DDMTemplateSoap[] getTemplatesByStructureClassNameId(long groupId,
                                                                   long structureClassNameId,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator orderByComparator)
                                                            throws RemoteException

Returns an ordered range of all the templates matching the group and structure class name ID and all the generic templates matching the group.

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:

groupId - the primary key of the group

structureClassNameId - the primary key of the class name for the template's related structure (optionally 0). Specify 0 to return generic templates only.

start - the lower bound of the range of templates to return

end - the upper bound of the range of templates to return (not inclusive)

orderByComparator - the comparator to order the templates (optionally null)

Returns:

the range of matching templates ordered by the comparator

Throws:

SystemException - if a system exception occurred

RemoteException

getTemplatesByStructureClassNameIdCount

public static int getTemplatesByStructureClassNameIdCount(long groupId,
                                                          long structureClassNameId)
                                                   throws RemoteException

Returns the number of templates matching the group and structure class name ID plus the number of generic templates matching the group.

Parameters:

groupId - the primary key of the group

structureClassNameId - the primary key of the class name for the template's related structure (optionally 0). Specify 0 to count generic templates only.

Returns:

the number of matching templates plus the number of matching generic templates

Throws:

SystemException - if a system exception occurred

RemoteException

search

public static DDMTemplateSoap[] search(long companyId,
                                       long groupId,
                                       long classNameId,
                                       long classPK,
                                       String keywords,
                                       String type,
                                       String mode,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws RemoteException

Returns an ordered range of all the templates matching the group, class name ID, class PK, type, and mode, and matching the keywords in the template names and descriptions.

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:

companyId - the primary key of the template's company

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

classPK - the primary key of the template's related entity

keywords - the keywords (space separated), which may occur in the template's name or description (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null) For more information, see DDMTemplateConstants.

start - the lower bound of the range of templates to return

end - the upper bound of the range of templates to return (not inclusive)

orderByComparator - the comparator to order the templates (optionally null)

Returns:

the matching templates ordered by the comparator

Throws:

SystemException - if a system exception occurred

RemoteException

search

public static DDMTemplateSoap[] search(long companyId,
                                       long groupId,
                                       long classNameId,
                                       long classPK,
                                       String name,
                                       String description,
                                       String type,
                                       String mode,
                                       String language,
                                       boolean andOperator,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws RemoteException

Returns an ordered range of all the templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, and language.

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:

companyId - the primary key of the template's company

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

classPK - the primary key of the template's related entity

name - the name keywords (optionally null)

description - the description keywords (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

language - the template's script language (optionally null). For more information, see DDMTemplateConstants.

andOperator - whether every field must match its keywords, or just one field.

start - the lower bound of the range of templates to return

end - the upper bound of the range of templates to return (not inclusive)

orderByComparator - the comparator to order the templates (optionally null)

Returns:

the matching templates ordered by the comparator

Throws:

SystemException - if a system exception occurred

RemoteException

search

public static DDMTemplateSoap[] search(long companyId,
                                       long[] groupIds,
                                       long[] classNameIds,
                                       long[] classPKs,
                                       String keywords,
                                       String type,
                                       String mode,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws RemoteException

Returns an ordered range of all the templates matching the group IDs, class name IDs, class PK, type, and mode, and matching the keywords in the template names and descriptions.

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:

companyId - the primary key of the template's company

groupIds - the primary keys of the groups

classNameIds - the primary keys of the entity's instances the templates are related to

classPKs - the primary keys of the template's related entities

keywords - the keywords (space separated), which may occur in the template's name or description (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

start - the lower bound of the range of templates to return

end - the upper bound of the range of templates to return (not inclusive)

orderByComparator - the comparator to order the templates (optionally null)

Returns:

the matching templates ordered by the comparator

Throws:

SystemException - if a system exception occurred

RemoteException

search

public static DDMTemplateSoap[] search(long companyId,
                                       long[] groupIds,
                                       long[] classNameIds,
                                       long[] classPKs,
                                       String name,
                                       String description,
                                       String type,
                                       String mode,
                                       String language,
                                       boolean andOperator,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws RemoteException

Returns an ordered range of all the templates matching the group IDs, class name IDs, class PK, name keyword, description keyword, type, mode, and language.

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:

companyId - the primary key of the template's company

groupIds - the primary keys of the groups

classNameIds - the primary keys of the entity's instances the templates are related to

classPKs - the primary keys of the template's related entities

name - the name keywords (optionally null)

description - the description keywords (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

language - the template's script language (optionally null). For more information, see DDMTemplateConstants.

andOperator - whether every field must match its keywords, or just one field.

start - the lower bound of the range of templates to return

end - the upper bound of the range of templates to return (not inclusive)

orderByComparator - the comparator to order the templates (optionally null)

Returns:

the matching templates ordered by the comparator

Throws:

SystemException - if a system exception occurred

RemoteException

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              long classNameId,
                              long classPK,
                              String keywords,
                              String type,
                              String mode)
                       throws RemoteException

Returns the number of templates matching the group, class name ID, class PK, type, and mode, and matching the keywords in the template names and descriptions.

Parameters:

companyId - the primary key of the template's company

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

classPK - the primary key of the template's related entity

keywords - the keywords (space separated), which may occur in the template's name or description (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

Returns:

the number of matching templates

Throws:

SystemException - if a system exception occurred

RemoteException

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              long classNameId,
                              long classPK,
                              String name,
                              String description,
                              String type,
                              String mode,
                              String language,
                              boolean andOperator)
                       throws RemoteException

Returns the number of templates matching the group, class name ID, class PK, name keyword, description keyword, type, mode, and language.

Parameters:

companyId - the primary key of the template's company

groupId - the primary key of the group

classNameId - the primary key of the class name for template's related model

classPK - the primary key of the template's related entity

name - the name keywords (optionally null)

description - the description keywords (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

language - the template's script language (optionally null). For more information, see DDMTemplateConstants.

andOperator - whether every field must match its keywords, or just one field.

Returns:

the number of matching templates

Throws:

SystemException - if a system exception occurred

RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              long[] classPKs,
                              String keywords,
                              String type,
                              String mode)
                       throws RemoteException

Returns the number of templates matching the group IDs, class name IDs, class PK, type, and mode, and matching the keywords in the template names and descriptions.

Parameters:

companyId - the primary key of the template's company

groupIds - the primary keys of the groups

classNameIds - the primary keys of the entity's instances the templates are related to

classPKs - the primary keys of the template's related entities

keywords - the keywords (space separated), which may occur in the template's name or description (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

Returns:

the number of matching templates

Throws:

SystemException - if a system exception occurred

RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              long[] classPKs,
                              String name,
                              String description,
                              String type,
                              String mode,
                              String language,
                              boolean andOperator)
                       throws RemoteException

Returns the number of templates matching the group IDs, class name IDs, class PK, name keyword, description keyword, type, mode, and language.

Parameters:

companyId - the primary key of the template's company

groupIds - the primary keys of the groups

classNameIds - the primary keys of the entity's instances the templates are related to

classPKs - the primary keys of the template's related entities

name - the name keywords (optionally null)

description - the description keywords (optionally null)

type - the template's type (optionally null). For more information, see DDMTemplateConstants.

mode - the template's mode (optionally null). For more information, see DDMTemplateConstants.

language - the template's script language (optionally null). For more information, see DDMTemplateConstants.

andOperator - whether every field must match its keywords, or just one field.

Returns:

the number of matching templates

Throws:

SystemException - if a system exception occurred

RemoteException