Liferay 7.0-ce-m3

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

java.lang.Object
  extended by com.liferay.portlet.dynamicdatamapping.service.http.DDMStructureServiceSoap

@ProviderType
public class DDMStructureServiceSoap
extends Object

Provides the SOAP utility for the DDMStructureServiceUtil 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 DDMStructureSoap. If the method in the service utility returns a DDMStructure, that is translated to a 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, DDMStructureSoap, DDMStructureServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
DDMStructureServiceSoap()
           
 
Method Summary
static DDMStructureSoap addStructure(long userId, long groupId, long classNameId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructureSoap addStructure(long userId, long groupId, long classNameId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String xsd, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by #addStructure(long, long, long, Map, Map, DDMForm, ServiceContext)
static DDMStructureSoap addStructure(long groupId, long parentStructureId, long classNameId, String structureKey, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, DDMForm ddmForm, String storageType, int type, ServiceContext serviceContext)
           
static DDMStructureSoap addStructure(long groupId, long parentStructureId, long classNameId, String structureKey, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String xsd, String storageType, int type, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by #addStructure(long, long, long, String, Map, Map, DDMForm, String, int, ServiceContext)
static DDMStructureSoap addStructure(long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, DDMForm ddmForm, String storageType, int type, ServiceContext serviceContext)
           
static DDMStructureSoap addStructure(long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String xsd, String storageType, int type, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by #addStructure(long, long, String, long, String, Map, Map, DDMForm, String, int, ServiceContext)
static DDMStructureSoap copyStructure(long structureId, ServiceContext serviceContext)
           
static DDMStructureSoap copyStructure(long structureId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, 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, String structureKey)
          Returns the structure matching the class name ID, structure key, and group.
static DDMStructureSoap[] getJournalFolderStructures(long[] groupIds, long journalFolderId, int restrictionType)
           
static DDMStructureSoap getStructure(long structureId)
          Returns the structure with the ID.
static DDMStructureSoap getStructure(long groupId, long classNameId, String structureKey)
          Returns the structure matching the class name ID, structure key, and group.
static DDMStructureSoap getStructure(long groupId, long classNameId, 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 groupId)
          Returns all the structures in the group that the user has permission to view.
static DDMStructureSoap[] getStructures(long[] groupIds)
          Returns all the structures in the groups that the user has permission to view.
static DDMStructureSoap[] getStructures(long[] groupIds, long classNameId)
          Returns all the structures matching the groups and class name ID that the user has permission to view.
static DDMStructureSoap[] getStructures(long[] groupIds, long classNameId, int start, int end)
           
static DDMStructureSoap[] search(long companyId, long[] groupIds, long[] classNameIds, String keywords, int start, int end, 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[] classNameIds, String name, String description, String storageType, int type, boolean andOperator, int start, int end, 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[] classNameIds, String keywords)
          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[] classNameIds, String name, String description, String storageType, int type, 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, String structureKey, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructureSoap updateStructure(long groupId, long parentStructureId, long classNameId, String structureKey, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String definition, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by #updateStructure(long, long, long, String, Map, Map, DDMForm, ServiceContext)
static DDMStructureSoap updateStructure(long structureId, long parentStructureId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructureSoap updateStructure(long structureId, long parentStructureId, String[] nameMapLanguageIds, String[] nameMapValues, String[] descriptionMapLanguageIds, String[] descriptionMapValues, String definition, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by #updateStructure(long, long, Map, Map, DDMForm, 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 userId,
                                            long groupId,
                                            long classNameId,
                                            String[] nameMapLanguageIds,
                                            String[] nameMapValues,
                                            String[] descriptionMapLanguageIds,
                                            String[] descriptionMapValues,
                                            DDMForm ddmForm,
                                            ServiceContext serviceContext)
                                     throws RemoteException
Throws:
RemoteException

addStructure

@Deprecated
public static DDMStructureSoap addStructure(long userId,
                                                       long groupId,
                                                       long classNameId,
                                                       String[] nameMapLanguageIds,
                                                       String[] nameMapValues,
                                                       String[] descriptionMapLanguageIds,
                                                       String[] descriptionMapValues,
                                                       String xsd,
                                                       ServiceContext serviceContext)
                                     throws RemoteException
Deprecated. As of 7.0.0, replaced by #addStructure(long, long, long, Map, Map, DDMForm, ServiceContext)

Adds a structure referencing a default parent structure, using the portal property dynamic.data.lists.storage.type storage type and default structure type.

Parameters:
userId - the primary key of the structure's creator/owner
groupId - the primary key of the group
classNameId - the primary key of the class name for the structure's related model
nameMap - the structure's locales and localized names
descriptionMap - the structure's locales and localized descriptions
xsd - the structure's XML schema definition
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 structure
Throws:
PortalException - if a user with the primary key could not be found, if the user did not have permission to add the structure, if the XSD was not well-formed, or if a portal exception occurred
RemoteException

addStructure

public static DDMStructureSoap addStructure(long groupId,
                                            long parentStructureId,
                                            long classNameId,
                                            String structureKey,
                                            String[] nameMapLanguageIds,
                                            String[] nameMapValues,
                                            String[] descriptionMapLanguageIds,
                                            String[] descriptionMapValues,
                                            DDMForm ddmForm,
                                            String storageType,
                                            int type,
                                            ServiceContext serviceContext)
                                     throws RemoteException
Throws:
RemoteException

addStructure

@Deprecated
public static DDMStructureSoap addStructure(long groupId,
                                                       long parentStructureId,
                                                       long classNameId,
                                                       String structureKey,
                                                       String[] nameMapLanguageIds,
                                                       String[] nameMapValues,
                                                       String[] descriptionMapLanguageIds,
                                                       String[] descriptionMapValues,
                                                       String xsd,
                                                       String storageType,
                                                       int type,
                                                       ServiceContext serviceContext)
                                     throws RemoteException
Deprecated. As of 7.0.0, replaced by #addStructure(long, long, long, String, Map, Map, DDMForm, String, int, ServiceContext)

Adds a structure referencing its parent structure.

Parameters:
groupId - the primary key of the group
parentStructureId - the primary key of the parent structure (optionally DDMStructureConstants.DEFAULT_PARENT_STRUCTURE_ID)
classNameId - the primary key of the class name for the structure's related model
structureKey - the unique string identifying the structure (optionally null)
nameMap - the structure's locales and localized names
descriptionMap - the structure's locales and localized descriptions
xsd - the structure's XML schema definition
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.
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 structure
Throws:
PortalException - if the user did not have permission to add the structure, if the XSD is not well formed, or if a portal exception occurred
RemoteException

addStructure

public static DDMStructureSoap addStructure(long userId,
                                            long groupId,
                                            String parentStructureKey,
                                            long classNameId,
                                            String structureKey,
                                            String[] nameMapLanguageIds,
                                            String[] nameMapValues,
                                            String[] descriptionMapLanguageIds,
                                            String[] descriptionMapValues,
                                            DDMForm ddmForm,
                                            String storageType,
                                            int type,
                                            ServiceContext serviceContext)
                                     throws RemoteException
Throws:
RemoteException

addStructure

@Deprecated
public static DDMStructureSoap addStructure(long userId,
                                                       long groupId,
                                                       String parentStructureKey,
                                                       long classNameId,
                                                       String structureKey,
                                                       String[] nameMapLanguageIds,
                                                       String[] nameMapValues,
                                                       String[] descriptionMapLanguageIds,
                                                       String[] descriptionMapValues,
                                                       String xsd,
                                                       String storageType,
                                                       int type,
                                                       ServiceContext serviceContext)
                                     throws RemoteException
Deprecated. As of 7.0.0, replaced by #addStructure(long, long, String, long, String, Map, Map, DDMForm, String, int, ServiceContext)

Adds a structure referencing the parent structure by its structure key. In case the parent structure is not found, it uses the default parent structure ID.

Parameters:
userId - the primary key of the structure's creator/owner
groupId - the primary key of the group
parentStructureKey - the unique string identifying the structure
classNameId - the primary key of the class name for the structure's related model
structureKey - unique string identifying the structure (optionally null)
nameMap - the structure's locales and localized names
descriptionMap - the structure's locales and localized descriptions
xsd - the XML schema definition of the structure
storageType - the storage type of the structure. It can be XML or expando. For more information, see StorageType.
type - the structure's type. For more information, see DDMStructureConstants.
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 structure.
Returns:
the structure
Throws:
PortalException - if a user with the primary key could not be found, if the user did not have permission to add the structure, if the XSD was not well-formed, or if a portal exception occurred
RemoteException

copyStructure

public static DDMStructureSoap copyStructure(long structureId,
                                             String[] nameMapLanguageIds,
                                             String[] nameMapValues,
                                             String[] descriptionMapLanguageIds,
                                             String[] descriptionMapValues,
                                             ServiceContext serviceContext)
                                      throws 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:
PortalException - if the user did not have permission to add the structure or if a portal exception occurred
RemoteException

copyStructure

public static DDMStructureSoap copyStructure(long structureId,
                                             ServiceContext serviceContext)
                                      throws RemoteException
Throws:
RemoteException

deleteStructure

public static void deleteStructure(long structureId)
                            throws 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:
PortalException - if the user did not have permission to delete the structure or if a portal exception occurred
RemoteException

fetchStructure

public static DDMStructureSoap fetchStructure(long groupId,
                                              long classNameId,
                                              String structureKey)
                                       throws 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:
PortalException - if the user did not have permission to view the structure or if a portal exception occurred
RemoteException

getJournalFolderStructures

public static DDMStructureSoap[] getJournalFolderStructures(long[] groupIds,
                                                            long journalFolderId,
                                                            int restrictionType)
                                                     throws RemoteException
Throws:
RemoteException

getStructure

public static DDMStructureSoap getStructure(long structureId)
                                     throws RemoteException
Returns the structure with the ID.

Parameters:
structureId - the primary key of the structure
Returns:
the structure with the ID
Throws:
PortalException - if the user did not have permission to view the structure or if a structure with the ID could not be found
RemoteException

getStructure

public static DDMStructureSoap getStructure(long groupId,
                                            long classNameId,
                                            String structureKey)
                                     throws 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:
PortalException - if the user did not have permission to view the structure or if a matching structure could not be found
RemoteException

getStructure

public static DDMStructureSoap getStructure(long groupId,
                                            long classNameId,
                                            String structureKey,
                                            boolean includeAncestorStructures)
                                     throws 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:
PortalException - if the user did not have permission to view the structure or if a matching structure could not be found
RemoteException

getStructures

public static DDMStructureSoap[] getStructures(long groupId)
                                        throws RemoteException
Returns all the structures in the group that the user has permission to view.

Parameters:
groupId - the primary key of the group
Returns:
the structures in the group that the user has permission to view
Throws:
RemoteException

getStructures

public static DDMStructureSoap[] getStructures(long[] groupIds)
                                        throws RemoteException
Returns all the structures in the groups that the user has permission to view.

Parameters:
groupIds - the primary key of the groups
Returns:
the structures in the groups that the user has permission to view
Throws:
RemoteException

getStructures

public static DDMStructureSoap[] getStructures(long[] groupIds,
                                               long classNameId)
                                        throws RemoteException
Returns all the structures matching the groups and class name ID that the user has permission to view.

Parameters:
groupIds - the primary keys of the groups
classNameId - the primary key of the class name for the structure's related model
Returns:
the structures matching the groups and class name ID that the user has permission to view
Throws:
RemoteException

getStructures

public static DDMStructureSoap[] getStructures(long[] groupIds,
                                               long classNameId,
                                               int start,
                                               int end)
                                        throws RemoteException
Throws:
RemoteException

search

public static DDMStructureSoap[] search(long companyId,
                                        long[] groupIds,
                                        long[] classNameIds,
                                        String keywords,
                                        int start,
                                        int end,
                                        OrderByComparator<DDMStructure> orderByComparator)
                                 throws 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
classNameIds - the primary keys of the class names of the models the structures are related to
keywords - the keywords (space separated), which may occur in the structure's name or description (optionally null)
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:
RemoteException

search

public static DDMStructureSoap[] search(long companyId,
                                        long[] groupIds,
                                        long[] classNameIds,
                                        String name,
                                        String description,
                                        String storageType,
                                        int type,
                                        boolean andOperator,
                                        int start,
                                        int end,
                                        OrderByComparator<DDMStructure> orderByComparator)
                                 throws 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
classNameIds - the primary keys of the class names of the models the structures are 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
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:
RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              String keywords)
                       throws 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
classNameIds - the primary keys of the class names of the models the structures are related to
keywords - the keywords (space separated), which may occur in the structure's name or description (optionally null)
Returns:
the number of matching structures
Throws:
RemoteException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              String name,
                              String description,
                              String storageType,
                              int type,
                              boolean andOperator)
                       throws 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
classNameIds - the primary keys of the class names of the models the structure's are 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:
RemoteException

updateStructure

public static DDMStructureSoap updateStructure(long groupId,
                                               long parentStructureId,
                                               long classNameId,
                                               String structureKey,
                                               String[] nameMapLanguageIds,
                                               String[] nameMapValues,
                                               String[] descriptionMapLanguageIds,
                                               String[] descriptionMapValues,
                                               DDMForm ddmForm,
                                               ServiceContext serviceContext)
                                        throws RemoteException
Throws:
RemoteException

updateStructure

@Deprecated
public static DDMStructureSoap updateStructure(long groupId,
                                                          long parentStructureId,
                                                          long classNameId,
                                                          String structureKey,
                                                          String[] nameMapLanguageIds,
                                                          String[] nameMapValues,
                                                          String[] descriptionMapLanguageIds,
                                                          String[] descriptionMapValues,
                                                          String definition,
                                                          ServiceContext serviceContext)
                                        throws RemoteException
Deprecated. As of 7.0.0, replaced by #updateStructure(long, long, long, String, Map, Map, DDMForm, ServiceContext)

Updates the structure matching the class name ID, structure key, and group, replacing its old parent structure, name map, description map, and XSD with new ones.

Parameters:
groupId - the primary key of the group
parentStructureId - the primary key of the new parent structure
classNameId - the primary key of the class name for the structure's related model
structureKey - the unique string identifying the structure
nameMap - the structure's new locales and localized names
descriptionMap - the structure's new locales and localized description
definition - the structure's new XML schema definition
serviceContext - the service context to be applied. Can set the modification date.
Returns:
the updated structure
Throws:
PortalException - if the user did not have permission to update the structure or if a portal exception occurred
RemoteException

updateStructure

public static DDMStructureSoap updateStructure(long structureId,
                                               long parentStructureId,
                                               String[] nameMapLanguageIds,
                                               String[] nameMapValues,
                                               String[] descriptionMapLanguageIds,
                                               String[] descriptionMapValues,
                                               DDMForm ddmForm,
                                               ServiceContext serviceContext)
                                        throws RemoteException
Throws:
RemoteException

updateStructure

@Deprecated
public static DDMStructureSoap updateStructure(long structureId,
                                                          long parentStructureId,
                                                          String[] nameMapLanguageIds,
                                                          String[] nameMapValues,
                                                          String[] descriptionMapLanguageIds,
                                                          String[] descriptionMapValues,
                                                          String definition,
                                                          ServiceContext serviceContext)
                                        throws RemoteException
Deprecated. As of 7.0.0, replaced by #updateStructure(long, long, Map, Map, DDMForm, ServiceContext)

Updates the structure matching the structure ID, replacing the old parent structure ID, name map, description map, and XSD with the new values.

Parameters:
structureId - the primary key of the structure
parentStructureId - the new parent structure primary key
nameMap - the structure's new locales and localized names
descriptionMap - the structure's new locales and localized description
definition - the new XML schema definition of the structure
serviceContext - the service context to be applied. Can set the modification date.
Returns:
the updated structure
Throws:
PortalException - if the user did not have permission to update the structure or if a portal exception occurred
RemoteException

Liferay 7.0-ce-m3