@ProviderType
public class DDMStructureServiceSoap
extends java.lang.Object
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.
DDMStructureServiceHttp,
DDMStructureSoap,
DDMStructureServiceUtil| Constructor and Description |
|---|
DDMStructureServiceSoap() |
| Modifier and Type | Method and Description |
|---|---|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
addStructure(long userId,
long groupId,
long classNameId,
java.lang.String[] nameMapLanguageIds,
java.lang.String[] nameMapValues,
java.lang.String[] descriptionMapLanguageIds,
java.lang.String[] descriptionMapValues,
java.lang.String xsd,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a structure referencing a default parent structure, using the portal
property
dynamic.data.lists.storage.type storage type and
default structure type. |
static com.liferay.portlet.dynamicdatamapping.model.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,
java.lang.String xsd,
java.lang.String storageType,
int type,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a structure referencing its parent structure.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
addStructure(long userId,
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,
java.lang.String xsd,
java.lang.String storageType,
int type,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a structure referencing the parent structure by its structure key.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
copyStructure(long structureId,
com.liferay.portal.service.ServiceContext serviceContext) |
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
copyStructure(long structureId,
java.lang.String[] nameMapLanguageIds,
java.lang.String[] nameMapValues,
java.lang.String[] descriptionMapLanguageIds,
java.lang.String[] descriptionMapValues,
com.liferay.portal.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 com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
fetchStructure(long groupId,
long classNameId,
java.lang.String structureKey)
Returns the structure matching the class name ID, structure key, and
group.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
fetchStructure(long groupId,
long classNameId,
java.lang.String structureKey,
boolean includeAncestorStructures) |
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
getStructure(long structureId)
Returns the structure with the ID.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
getStructure(long groupId,
long classNameId,
java.lang.String structureKey)
Returns the structure matching the class name ID, structure key, and
group.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
getStructure(long groupId,
long classNameId,
java.lang.String structureKey,
boolean includeGlobalStructures)
Returns the structure matching the class name ID, structure key, and
group, optionally in the global scope.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] |
getStructures(long groupId)
Returns all the structures in the group that the user has permission to
view.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] |
getStructures(long[] groupIds)
Returns all the structures in the groups that the user has permission to
view.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] |
getStructures(long[] groupIds,
long classNameId) |
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] |
getStructures(long[] groupIds,
long classNameId,
int start,
int end) |
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] |
search(long companyId,
long[] groupIds,
long[] classNameIds,
java.lang.String keywords,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator 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 com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] |
search(long companyId,
long[] groupIds,
long[] classNameIds,
java.lang.String name,
java.lang.String description,
java.lang.String storageType,
int type,
boolean andOperator,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator 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,
java.lang.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,
java.lang.String name,
java.lang.String description,
java.lang.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 com.liferay.portlet.dynamicdatamapping.model.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,
java.lang.String xsd,
com.liferay.portal.service.ServiceContext 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.
|
static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap |
updateStructure(long structureId,
long parentStructureId,
java.lang.String[] nameMapLanguageIds,
java.lang.String[] nameMapValues,
java.lang.String[] descriptionMapLanguageIds,
java.lang.String[] descriptionMapValues,
java.lang.String xsd,
com.liferay.portal.service.ServiceContext serviceContext)
Updates the structure matching the structure ID, replacing the old parent
structure ID, name map, description map, and XSD with the new values.
|
public static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap addStructure(long userId,
long groupId,
long classNameId,
java.lang.String[] nameMapLanguageIds,
java.lang.String[] nameMapValues,
java.lang.String[] descriptionMapLanguageIds,
java.lang.String[] descriptionMapValues,
java.lang.String xsd,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
dynamic.data.lists.storage.type storage type and
default structure type.userId - the primary key of the structure's creator/ownergroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelnameMap - the structure's locales and localized namesdescriptionMap - the structure's locales and localized descriptionsxsd - the structure's XML schema definitionserviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions, and
group permissions for the structure.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 occurredSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.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,
java.lang.String xsd,
java.lang.String storageType,
int type,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
groupId - the primary key of the groupparentStructureId - 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 modelstructureKey - the unique string identifying the structure
(optionally null)nameMap - the structure's locales and localized namesdescriptionMap - the structure's locales and localized descriptionsxsd - the structure's XML schema definitionstorageType - 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.PortalException - if the user did not have permission to add the
structure, if the XSD is not well formed, or if a portal
exception occurredSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap addStructure(long userId,
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,
java.lang.String xsd,
java.lang.String storageType,
int type,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
userId - the primary key of the structure's creator/ownergroupId - the primary key of the groupparentStructureKey - the unique string identifying the structureclassNameId - the primary key of the class name for the structure's
related modelstructureKey - unique string identifying the structure (optionally
null)nameMap - the structure's locales and localized namesdescriptionMap - the structure's locales and localized descriptionsxsd - the XML schema definition of the structurestorageType - 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.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 occurredSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap copyStructure(long structureId,
java.lang.String[] nameMapLanguageIds,
java.lang.String[] nameMapValues,
java.lang.String[] descriptionMapLanguageIds,
java.lang.String[] descriptionMapValues,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
structureId - the primary key of the structure to be copiednameMap - the new structure's locales and localized namesdescriptionMap - the new structure's locales and localized
descriptionsserviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions, and
group permissions for the structure.PortalException - if the user did not have permission to add the
structure or if a portal exception occurredSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap copyStructure(long structureId,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static void deleteStructure(long structureId)
throws java.rmi.RemoteException
Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
structureId - the primary key of the structure to be deletedPortalException - if the user did not have permission to delete the
structure or if a portal exception occurredSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap fetchStructure(long groupId,
long classNameId,
java.lang.String structureKey)
throws java.rmi.RemoteException
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structurenull if a matching
structure could not be foundPortalException - if the user did not have permission to view the
structure or if a portal exception occurredSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap fetchStructure(long groupId,
long classNameId,
java.lang.String structureKey,
boolean includeAncestorStructures)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap getStructure(long structureId)
throws java.rmi.RemoteException
structureId - the primary key of the structurePortalException - if the user did not have permission to view the
structure or if a structure with the ID could not be foundSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap getStructure(long groupId,
long classNameId,
java.lang.String structureKey)
throws java.rmi.RemoteException
groupId - the primary key of the structure's groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structurePortalException - if the user did not have permission to view the
structure or if a matching structure could not be foundSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap getStructure(long groupId,
long classNameId,
java.lang.String structureKey,
boolean includeGlobalStructures)
throws java.rmi.RemoteException
This method first searches in the group. If the structure is still not
found and includeGlobalStructures is set to
true, this method searches the global group.
groupId - the primary key of the structure's groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structureincludeGlobalStructures - whether to include the global scope in
the searchPortalException - if the user did not have permission to view the
structure or if a matching structure could not be foundSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] getStructures(long groupId)
throws java.rmi.RemoteException
groupId - the primary key of the groupSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] getStructures(long[] groupIds)
throws java.rmi.RemoteException
groupIds - the primary key of the groupsSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] getStructures(long[] groupIds,
long classNameId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] getStructures(long[] groupIds,
long classNameId,
int start,
int end)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] search(long companyId,
long[] groupIds,
long[] classNameIds,
java.lang.String keywords,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws java.rmi.RemoteException
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.
companyId - the primary key of the structure's companygroupIds - the primary keys of the groupsclassNameIds - the primary keys of the class names of the models
the structures are related tokeywords - 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 returnend - the upper bound of the range of structures to return (not
inclusive)orderByComparator - the comparator to order the structures
(optionally null)SystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap[] search(long companyId,
long[] groupIds,
long[] classNameIds,
java.lang.String name,
java.lang.String description,
java.lang.String storageType,
int type,
boolean andOperator,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws java.rmi.RemoteException
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.
companyId - the primary key of the structure's companygroupIds - the primary keys of the groupsclassNameIds - the primary keys of the class names of the models
the structures are related toname - the name keywordsdescription - the description keywordsstorageType - 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 fieldstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)orderByComparator - the comparator to order the structures
(optionally null)SystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
java.lang.String keywords)
throws java.rmi.RemoteException
companyId - the primary key of the structure's companygroupIds - the primary keys of the groupsclassNameIds - the primary keys of the class names of the models
the structures are related tokeywords - the keywords (space separated), which may occur in the
structure's name or description (optionally null)SystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
java.lang.String name,
java.lang.String description,
java.lang.String storageType,
int type,
boolean andOperator)
throws java.rmi.RemoteException
companyId - the primary key of the structure's companygroupIds - the primary keys of the groupsclassNameIds - the primary keys of the class names of the models
the structure's are related toname - the name keywordsdescription - the description keywordsstorageType - 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 fieldSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.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,
java.lang.String xsd,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
groupId - the primary key of the groupparentStructureId - the primary key of the new parent structureclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structurenameMap - the structure's new locales and localized namesdescriptionMap - the structure's new locales and localized
descriptionxsd - the structure's new XML schema definitionserviceContext - the service context to be applied. Can set the
modification date.PortalException - if the user did not have permission to update the
structure or if a portal exception occurredSystemException - if a system exception occurredjava.rmi.RemoteExceptionpublic static com.liferay.portlet.dynamicdatamapping.model.DDMStructureSoap updateStructure(long structureId,
long parentStructureId,
java.lang.String[] nameMapLanguageIds,
java.lang.String[] nameMapValues,
java.lang.String[] descriptionMapLanguageIds,
java.lang.String[] descriptionMapValues,
java.lang.String xsd,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
structureId - the primary key of the structureparentStructureId - the new parent structure primary keynameMap - the structure's new locales and localized namesdescriptionMap - the structure's new locales and localized
descriptionxsd - the new XML schema definition of the structureserviceContext - the service context to be applied. Can set the
modification date.PortalException - if the user did not have permission to update the
structure or if a portal exception occurredSystemException - if a system exception occurredjava.rmi.RemoteException