Liferay 7.0-ce-m3

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

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

@ProviderType
public class DDMStructureServiceHttp
extends Object

Provides the HTTP 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 requires an additional HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

See Also:
DDMStructureServiceSoap, HttpPrincipal, DDMStructureServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
DDMStructureServiceHttp()
           
 
Method Summary
static DDMStructure addStructure(HttpPrincipal httpPrincipal, long userId, long groupId, long classNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructure addStructure(HttpPrincipal httpPrincipal, long userId, long groupId, long classNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
static DDMStructure addStructure(HttpPrincipal httpPrincipal, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, String storageType, int type, ServiceContext serviceContext)
           
static DDMStructure addStructure(HttpPrincipal httpPrincipal, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext)
           
static DDMStructure addStructure(HttpPrincipal httpPrincipal, long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, String storageType, int type, ServiceContext serviceContext)
           
static DDMStructure addStructure(HttpPrincipal httpPrincipal, long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext)
           
static DDMStructure copyStructure(HttpPrincipal httpPrincipal, long structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, ServiceContext serviceContext)
           
static DDMStructure copyStructure(HttpPrincipal httpPrincipal, long structureId, ServiceContext serviceContext)
           
static void deleteStructure(HttpPrincipal httpPrincipal, long structureId)
           
static DDMStructure fetchStructure(HttpPrincipal httpPrincipal, long groupId, long classNameId, String structureKey)
           
static List<DDMStructure> getJournalFolderStructures(HttpPrincipal httpPrincipal, long[] groupIds, long journalFolderId, int restrictionType)
           
static DDMStructure getStructure(HttpPrincipal httpPrincipal, long structureId)
           
static DDMStructure getStructure(HttpPrincipal httpPrincipal, long groupId, long classNameId, String structureKey)
           
static DDMStructure getStructure(HttpPrincipal httpPrincipal, long groupId, long classNameId, String structureKey, boolean includeAncestorStructures)
           
static List<DDMStructure> getStructures(HttpPrincipal httpPrincipal, long groupId)
           
static List<DDMStructure> getStructures(HttpPrincipal httpPrincipal, long[] groupIds)
           
static List<DDMStructure> getStructures(HttpPrincipal httpPrincipal, long[] groupIds, long classNameId)
           
static List<DDMStructure> getStructures(HttpPrincipal httpPrincipal, long[] groupIds, long classNameId, int start, int end)
           
static List<DDMStructure> search(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, String keywords, int start, int end, OrderByComparator<DDMStructure> orderByComparator)
           
static List<DDMStructure> search(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator, int start, int end, OrderByComparator<DDMStructure> orderByComparator)
           
static int searchCount(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, String keywords)
           
static int searchCount(HttpPrincipal httpPrincipal, long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator)
           
static DDMStructure updateStructure(HttpPrincipal httpPrincipal, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructure updateStructure(HttpPrincipal httpPrincipal, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, ServiceContext serviceContext)
           
static DDMStructure updateStructure(HttpPrincipal httpPrincipal, long structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, ServiceContext serviceContext)
           
static DDMStructure updateStructure(HttpPrincipal httpPrincipal, long structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String definition, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DDMStructureServiceHttp

public DDMStructureServiceHttp()
Method Detail

addStructure

public static DDMStructure addStructure(HttpPrincipal httpPrincipal,
                                        long userId,
                                        long groupId,
                                        long classNameId,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        DDMForm ddmForm,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

addStructure

public static DDMStructure addStructure(HttpPrincipal httpPrincipal,
                                        long userId,
                                        long groupId,
                                        long classNameId,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        String xsd,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

addStructure

public static DDMStructure addStructure(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long parentStructureId,
                                        long classNameId,
                                        String structureKey,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        DDMForm ddmForm,
                                        String storageType,
                                        int type,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

addStructure

public static DDMStructure addStructure(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long parentStructureId,
                                        long classNameId,
                                        String structureKey,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        String xsd,
                                        String storageType,
                                        int type,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

addStructure

public static DDMStructure addStructure(HttpPrincipal httpPrincipal,
                                        long userId,
                                        long groupId,
                                        String parentStructureKey,
                                        long classNameId,
                                        String structureKey,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        DDMForm ddmForm,
                                        String storageType,
                                        int type,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

addStructure

public static DDMStructure addStructure(HttpPrincipal httpPrincipal,
                                        long userId,
                                        long groupId,
                                        String parentStructureKey,
                                        long classNameId,
                                        String structureKey,
                                        Map<Locale,String> nameMap,
                                        Map<Locale,String> descriptionMap,
                                        String xsd,
                                        String storageType,
                                        int type,
                                        ServiceContext serviceContext)
                                 throws PortalException
Throws:
PortalException

copyStructure

public static DDMStructure copyStructure(HttpPrincipal httpPrincipal,
                                         long structureId,
                                         Map<Locale,String> nameMap,
                                         Map<Locale,String> descriptionMap,
                                         ServiceContext serviceContext)
                                  throws PortalException
Throws:
PortalException

copyStructure

public static DDMStructure copyStructure(HttpPrincipal httpPrincipal,
                                         long structureId,
                                         ServiceContext serviceContext)
                                  throws PortalException
Throws:
PortalException

deleteStructure

public static void deleteStructure(HttpPrincipal httpPrincipal,
                                   long structureId)
                            throws PortalException
Throws:
PortalException

fetchStructure

public static DDMStructure fetchStructure(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          long classNameId,
                                          String structureKey)
                                   throws PortalException
Throws:
PortalException

getJournalFolderStructures

public static List<DDMStructure> getJournalFolderStructures(HttpPrincipal httpPrincipal,
                                                            long[] groupIds,
                                                            long journalFolderId,
                                                            int restrictionType)
                                                     throws PortalException
Throws:
PortalException

getStructure

public static DDMStructure getStructure(HttpPrincipal httpPrincipal,
                                        long structureId)
                                 throws PortalException
Throws:
PortalException

getStructure

public static DDMStructure getStructure(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long classNameId,
                                        String structureKey)
                                 throws PortalException
Throws:
PortalException

getStructure

public static DDMStructure getStructure(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        long classNameId,
                                        String structureKey,
                                        boolean includeAncestorStructures)
                                 throws PortalException
Throws:
PortalException

getStructures

public static List<DDMStructure> getStructures(HttpPrincipal httpPrincipal,
                                               long groupId)

getStructures

public static List<DDMStructure> getStructures(HttpPrincipal httpPrincipal,
                                               long[] groupIds)

getStructures

public static List<DDMStructure> getStructures(HttpPrincipal httpPrincipal,
                                               long[] groupIds,
                                               long classNameId)

getStructures

public static List<DDMStructure> getStructures(HttpPrincipal httpPrincipal,
                                               long[] groupIds,
                                               long classNameId,
                                               int start,
                                               int end)

search

public static List<DDMStructure> search(HttpPrincipal httpPrincipal,
                                        long companyId,
                                        long[] groupIds,
                                        long[] classNameIds,
                                        String keywords,
                                        int start,
                                        int end,
                                        OrderByComparator<DDMStructure> orderByComparator)

search

public static List<DDMStructure> search(HttpPrincipal httpPrincipal,
                                        long companyId,
                                        long[] groupIds,
                                        long[] classNameIds,
                                        String name,
                                        String description,
                                        String storageType,
                                        int type,
                                        boolean andOperator,
                                        int start,
                                        int end,
                                        OrderByComparator<DDMStructure> orderByComparator)

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              String keywords)

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long[] groupIds,
                              long[] classNameIds,
                              String name,
                              String description,
                              String storageType,
                              int type,
                              boolean andOperator)

updateStructure

public static DDMStructure updateStructure(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           long parentStructureId,
                                           long classNameId,
                                           String structureKey,
                                           Map<Locale,String> nameMap,
                                           Map<Locale,String> descriptionMap,
                                           DDMForm ddmForm,
                                           ServiceContext serviceContext)
                                    throws PortalException
Throws:
PortalException

updateStructure

public static DDMStructure updateStructure(HttpPrincipal httpPrincipal,
                                           long groupId,
                                           long parentStructureId,
                                           long classNameId,
                                           String structureKey,
                                           Map<Locale,String> nameMap,
                                           Map<Locale,String> descriptionMap,
                                           String definition,
                                           ServiceContext serviceContext)
                                    throws PortalException
Throws:
PortalException

updateStructure

public static DDMStructure updateStructure(HttpPrincipal httpPrincipal,
                                           long structureId,
                                           long parentStructureId,
                                           Map<Locale,String> nameMap,
                                           Map<Locale,String> descriptionMap,
                                           DDMForm ddmForm,
                                           ServiceContext serviceContext)
                                    throws PortalException
Throws:
PortalException

updateStructure

public static DDMStructure updateStructure(HttpPrincipal httpPrincipal,
                                           long structureId,
                                           long parentStructureId,
                                           Map<Locale,String> nameMap,
                                           Map<Locale,String> descriptionMap,
                                           String definition,
                                           ServiceContext serviceContext)
                                    throws PortalException
Throws:
PortalException

Liferay 7.0-ce-m3