com.liferay.dynamic.data.mapping.service.http

Class DDMStructureServiceSoap

java.lang.Object

com.liferay.dynamic.data.mapping.service.http.DDMStructureServiceSoap

public class DDMStructureServiceSoap
extends java.lang.Object

Provides the SOAP utility for the DDMStructureServiceUtil service utility. The static methods of this class call 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 java.util.List, that is translated to an array of com.liferay.dynamic.data.mapping.model.DDMStructureSoap. If the method in the service utility returns a com.liferay.dynamic.data.mapping.model.DDMStructure, that is translated to a com.liferay.dynamic.data.mapping.model.DDMStructureSoap. 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:

DDMStructureServiceHttp

Generated:

Constructor Summary

Constructors

Constructor and Description
DDMStructureServiceSoap()

Method Summary

Modifier and Type	Method and Description
static DDMStructureSoap	addStructure(long groupId, long parentStructureId, long classNameId, java.lang.String structureKey, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, DDMForm ddmForm, DDMFormLayout ddmFormLayout, java.lang.String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static DDMStructureSoap	addStructure(long groupId, long classNameId, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, DDMForm ddmForm, DDMFormLayout ddmFormLayout, java.lang.String storageType, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static DDMStructureSoap	addStructure(long groupId, java.lang.String parentStructureKey, long classNameId, java.lang.String structureKey, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, DDMForm ddmForm, DDMFormLayout ddmFormLayout, java.lang.String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static DDMStructureSoap	copyStructure(long structureId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static DDMStructureSoap	copyStructure(long structureId, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) Copies a structure, creating a new structure with all the values extracted from the original one.
static void	deleteStructure(long structureId) Deletes the structure and its resources.
static DDMStructureSoap	fetchStructure(long groupId, long classNameId, java.lang.String structureKey) Returns the structure matching the class name ID, structure key, and group.
static DDMStructureSoap	fetchStructure(long groupId, long classNameId, java.lang.String structureKey, boolean includeAncestorStructures)
static DDMStructureSoap	getStructure(long structureId) Returns the structure with the ID.
static DDMStructureSoap	getStructure(long groupId, long classNameId, java.lang.String structureKey) Returns the structure matching the class name ID, structure key, and group.
static DDMStructureSoap	getStructure(long groupId, long classNameId, java.lang.String structureKey, boolean includeAncestorStructures) Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.
static DDMStructureSoap[]	getStructures(long companyId, long[] groupIds, long classNameId, int status)
static DDMStructureSoap[]	getStructures(long companyId, long[] groupIds, long classNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
static DDMStructureSoap[]	getStructures(long companyId, long[] groupIds, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
static DDMStructureSoap[]	getStructures(long companyId, long[] groupIds, long classNameId, java.lang.String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
static int	getStructuresCount(long companyId, long[] groupIds, long classNameId)
static int	getStructuresCount(long companyId, long[] groupIds, long classNameId, java.lang.String keywords, int status)
static void	revertStructure(long structureId, java.lang.String version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static DDMStructureSoap[]	search(long companyId, long[] groupIds, long classNameId, java.lang.String keywords, int type, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns an ordered range of all the structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.
static DDMStructureSoap[]	search(long companyId, long[] groupIds, long classNameId, java.lang.String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns an ordered range of all the structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.
static DDMStructureSoap[]	search(long companyId, long[] groupIds, long classNameId, java.lang.String name, java.lang.String description, java.lang.String storageType, int type, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns an ordered range of all the structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type.
static int	searchCount(long companyId, long[] groupIds, long classNameId, java.lang.String keywords, int status) Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.
static int	searchCount(long companyId, long[] groupIds, long classNameId, java.lang.String keywords, int type, int status) Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.
static int	searchCount(long companyId, long[] groupIds, long classNameId, java.lang.String name, java.lang.String description, java.lang.String storageType, int type, int status, boolean andOperator) Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type
static DDMStructureSoap	updateStructure(long groupId, long parentStructureId, long classNameId, java.lang.String structureKey, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static DDMStructureSoap	updateStructure(long structureId, long parentStructureId, java.lang.String[] nameMapLanguageIds, java.lang.String[] nameMapValues, java.lang.String[] descriptionMapLanguageIds, java.lang.String[] descriptionMapValues, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

DDMStructureServiceSoap

public DDMStructureServiceSoap()

Method Detail

addStructure

public static DDMStructureSoap addStructure(long groupId,
                                            long parentStructureId,
                                            long classNameId,
                                            java.lang.String structureKey,
                                            java.lang.String[] nameMapLanguageIds,
                                            java.lang.String[] nameMapValues,
                                            java.lang.String[] descriptionMapLanguageIds,
                                            java.lang.String[] descriptionMapValues,
                                            DDMForm ddmForm,
                                            DDMFormLayout ddmFormLayout,
                                            java.lang.String storageType,
                                            int type,
                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addStructure

public static DDMStructureSoap addStructure(long groupId,
                                            long classNameId,
                                            java.lang.String[] nameMapLanguageIds,
                                            java.lang.String[] nameMapValues,
                                            java.lang.String[] descriptionMapLanguageIds,
                                            java.lang.String[] descriptionMapValues,
                                            DDMForm ddmForm,
                                            DDMFormLayout ddmFormLayout,
                                            java.lang.String storageType,
                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addStructure

public static DDMStructureSoap addStructure(long groupId,
                                            java.lang.String parentStructureKey,
                                            long classNameId,
                                            java.lang.String structureKey,
                                            java.lang.String[] nameMapLanguageIds,
                                            java.lang.String[] nameMapValues,
                                            java.lang.String[] descriptionMapLanguageIds,
                                            java.lang.String[] descriptionMapValues,
                                            DDMForm ddmForm,
                                            DDMFormLayout ddmFormLayout,
                                            java.lang.String storageType,
                                            int type,
                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

copyStructure

public static DDMStructureSoap copyStructure(long structureId,
                                             java.lang.String[] nameMapLanguageIds,
                                             java.lang.String[] nameMapValues,
                                             java.lang.String[] descriptionMapLanguageIds,
                                             java.lang.String[] descriptionMapValues,
                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                      throws java.rmi.RemoteException

Copies a structure, creating a new structure with all the values extracted from the original one. The new structure supports a new name and description.

Parameters:

structureId - the primary key of the structure to be copied

nameMap - the new structure's locales and localized names

descriptionMap - the new structure's locales and localized descriptions

serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, guest permissions, and group permissions for the structure.

Returns:

the new structure

Throws:

java.rmi.RemoteException

copyStructure

public static DDMStructureSoap copyStructure(long structureId,
                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteStructure

public static void deleteStructure(long structureId)
                            throws java.rmi.RemoteException

Deletes the structure and its resources.

Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.

Parameters:

structureId - the primary key of the structure to be deleted

Throws:

java.rmi.RemoteException

fetchStructure

public static DDMStructureSoap fetchStructure(long groupId,
                                              long classNameId,
                                              java.lang.String structureKey)
                                       throws java.rmi.RemoteException

Returns the structure matching the class name ID, structure key, and group.

Parameters:

groupId - the primary key of the group

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

structureKey - the unique string identifying the structure

Returns:

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

Throws:

java.rmi.RemoteException

fetchStructure

public static DDMStructureSoap fetchStructure(long groupId,
                                              long classNameId,
                                              java.lang.String structureKey,
                                              boolean includeAncestorStructures)
                                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getStructure

public static DDMStructureSoap getStructure(long structureId)
                                     throws java.rmi.RemoteException

Returns the structure with the ID.

Parameters:

structureId - the primary key of the structure

Returns:

the structure with the ID

Throws:

java.rmi.RemoteException

getStructure

public static DDMStructureSoap getStructure(long groupId,
                                            long classNameId,
                                            java.lang.String structureKey)
                                     throws java.rmi.RemoteException

Returns the structure matching the class name ID, structure key, and group.

Parameters:

groupId - the primary key of the structure's group

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

structureKey - the unique string identifying the structure

Returns:

the matching structure

Throws:

java.rmi.RemoteException

getStructure

public static DDMStructureSoap getStructure(long groupId,
                                            long classNameId,
                                            java.lang.String structureKey,
                                            boolean includeAncestorStructures)
                                     throws java.rmi.RemoteException

Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.

This method first searches in the group. If the structure is still not found and includeAncestorStructures is set to true, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.

Parameters:

groupId - the primary key of the structure's group

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

structureKey - the unique string identifying the structure

includeAncestorStructures - whether to include ancestor sites (that have sharing enabled) and include global scoped sites in the search

Returns:

the matching structure

Throws:

java.rmi.RemoteException

getStructures

public static DDMStructureSoap[] getStructures(long companyId,
                                               long[] groupIds,
                                               long classNameId,
                                               int status)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getStructures

public static DDMStructureSoap[] getStructures(long companyId,
                                               long[] groupIds,
                                               long classNameId,
                                               int status,
                                               int start,
                                               int end,
                                               com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getStructures

public static DDMStructureSoap[] getStructures(long companyId,
                                               long[] groupIds,
                                               long classNameId,
                                               int start,
                                               int end,
                                               com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getStructures

public static DDMStructureSoap[] getStructures(long companyId,
                                               long[] groupIds,
                                               long classNameId,
                                               java.lang.String keywords,
                                               int status,
                                               int start,
                                               int end,
                                               com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getStructuresCount

public static int getStructuresCount(long companyId,
                                     long[] groupIds,
                                     long classNameId)
                              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getStructuresCount

public static int getStructuresCount(long companyId,
                                     long[] groupIds,
                                     long classNameId,
                                     java.lang.String keywords,
                                     int status)
                              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

revertStructure

public static void revertStructure(long structureId,
                                   java.lang.String version,
                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

search

public static DDMStructureSoap[] search(long companyId,
                                        long[] groupIds,
                                        long classNameId,
                                        java.lang.String keywords,
                                        int type,
                                        int status,
                                        int start,
                                        int end,
                                        com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
                                 throws java.rmi.RemoteException

Returns an ordered range of all the structures matching the groups and class name IDs, and matching the keywords in the structure 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 structure's company

groupIds - the primary keys of the groups

classNameId - the primary key of the class name of the model the structure is related to

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

type - the structure's type. For more information, see DDMStructureConstants.

status - the workflow's status.

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

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

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

Returns:

the range of matching structures ordered by the comparator

Throws:

java.rmi.RemoteException

search

public static DDMStructureSoap[] search(long companyId,
                                        long[] groupIds,
                                        long classNameId,
                                        java.lang.String keywords,
                                        int status,
                                        int start,
                                        int end,
                                        com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
                                 throws java.rmi.RemoteException

Returns an ordered range of all the structures matching the groups and class name IDs, and matching the keywords in the structure 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 structure's company

groupIds - the primary keys of the groups

classNameId - the primary key of the class name of the model the structure is related to

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

status - the workflow's status.

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

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

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

Returns:

the range of matching structures ordered by the comparator

Throws:

java.rmi.RemoteException

search

public static DDMStructureSoap[] search(long companyId,
                                        long[] groupIds,
                                        long classNameId,
                                        java.lang.String name,
                                        java.lang.String description,
                                        java.lang.String storageType,
                                        int type,
                                        int status,
                                        boolean andOperator,
                                        int start,
                                        int end,
                                        com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator)
                                 throws java.rmi.RemoteException

Returns an ordered range of all the structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type.

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 structure's company

groupIds - the primary keys of the groups

classNameId - the primary key of the class name of the model the structure is related to

name - the name keywords

description - the description keywords

storageType - the structure's storage type. It can be "xml" or "expando". For more information, see StorageType.

type - the structure's type. For more information, see DDMStructureConstants.

status - the workflow's status.

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

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

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

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

Returns:

the range of matching structures ordered by the comparator

Throws:

java.rmi.RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long classNameId,
                              java.lang.String keywords,
                              int status)
                       throws java.rmi.RemoteException

Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.

Parameters:

companyId - the primary key of the structure's company

groupIds - the primary keys of the groups

classNameId - the primary key of the class name of the model the structure is related to

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

status - the workflow's status.

Returns:

the number of matching structures

Throws:

java.rmi.RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long classNameId,
                              java.lang.String keywords,
                              int type,
                              int status)
                       throws java.rmi.RemoteException

Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.

Parameters:

companyId - the primary key of the structure's company

groupIds - the primary keys of the groups

classNameId - the primary key of the class name of the model the structure is related to

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

type - the structure's type. For more information, see DDMStructureConstants.

status - the workflow's status.

Returns:

the number of matching structures

Throws:

java.rmi.RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long classNameId,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.String storageType,
                              int type,
                              int status,
                              boolean andOperator)
                       throws java.rmi.RemoteException

Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type

Parameters:

companyId - the primary key of the structure's company

groupIds - the primary keys of the groups

classNameId - the primary key of the class name of the model the structure is related to

name - the name keywords

description - the description keywords

storageType - the structure's storage type. It can be "xml" or "expando". For more information, see StorageType.

type - the structure's type. For more information, see DDMStructureConstants.

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

Returns:

the number of matching structures

Throws:

java.rmi.RemoteException

updateStructure

public static DDMStructureSoap updateStructure(long groupId,
                                               long parentStructureId,
                                               long classNameId,
                                               java.lang.String structureKey,
                                               java.lang.String[] nameMapLanguageIds,
                                               java.lang.String[] nameMapValues,
                                               java.lang.String[] descriptionMapLanguageIds,
                                               java.lang.String[] descriptionMapValues,
                                               DDMForm ddmForm,
                                               DDMFormLayout ddmFormLayout,
                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateStructure

public static DDMStructureSoap updateStructure(long structureId,
                                               long parentStructureId,
                                               java.lang.String[] nameMapLanguageIds,
                                               java.lang.String[] nameMapValues,
                                               java.lang.String[] descriptionMapLanguageIds,
                                               java.lang.String[] descriptionMapValues,
                                               DDMForm ddmForm,
                                               DDMFormLayout ddmFormLayout,
                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException