Liferay 7.0-ce-b4

com.liferay.portlet.dynamicdatamapping
Interface DDMStructureManager


public interface DDMStructureManager


Field Summary
static int STRUCTURE_COMPARATOR_STRUCTURE_KEY
           
static long STRUCTURE_DEFAULT_PARENT_STRUCTURE_ID
           
static String STRUCTURE_INDEXER_FIELD_NAMESPACE
           
static String STRUCTURE_INDEXER_FIELD_PREFIX
           
static String STRUCTURE_INDEXER_FIELD_SEPARATOR
           
static int STRUCTURE_TYPE_AUTO
           
static int STRUCTURE_TYPE_DEFAULT
           
static String STRUCTURE_VERSION_DEFAULT
           
 
Method Summary
 void addAttributes(long structureId, Document document, DDMFormValues ddmFormValues)
           
 DDMStructure addStructure(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)
           
 void deleteStructure(long structureId)
           
 String extractAttributes(long structureId, DDMFormValues ddmFormValues, Locale locale)
           
 DDMStructure fetchStructure(long structureId)
           
 DDMStructure fetchStructure(long groupId, long classNameId, String structureKey)
           
 DDMStructure fetchStructureByUuidAndGroupId(String uuid, long groupId)
           
 List<DDMStructure> getClassStructures(long companyId, long classNameId)
           
 List<DDMStructure> getClassStructures(long companyId, long classNameId, int structureComparator)
           
 List<DDMStructure> getClassStructures(long companyId, long classNameId, int start, int end)
           
 JSONArray getDDMFormFieldsJSONArray(long structureId, String script)
           
 Class<?> getDDMStructureModelClass()
           
 Serializable getIndexedFieldValue(Serializable fieldValue, String fieldType)
           
 DDMStructure getStructure(long structureId)
           
 DDMStructure getStructure(long groupId, long classNameId, String structureKey)
           
 DDMStructure getStructureByUuidAndGroupId(String uuid, long groupId)
           
 List<DDMStructure> getStructures(long[] groupIds, long classNameId)
           
 int getStructureStorageLinksCount(long structureId)
           
 DDMStructure updateStructure(long userId, long structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, ServiceContext serviceContext)
           
 void updateStructureDefinition(long structureId, String definition)
           
 void updateStructureKey(long structureId, String structureKey)
           
 

Field Detail

STRUCTURE_COMPARATOR_STRUCTURE_KEY

static final int STRUCTURE_COMPARATOR_STRUCTURE_KEY
See Also:
Constant Field Values

STRUCTURE_DEFAULT_PARENT_STRUCTURE_ID

static final long STRUCTURE_DEFAULT_PARENT_STRUCTURE_ID
See Also:
Constant Field Values

STRUCTURE_INDEXER_FIELD_NAMESPACE

static final String STRUCTURE_INDEXER_FIELD_NAMESPACE
See Also:
Constant Field Values

STRUCTURE_INDEXER_FIELD_PREFIX

static final String STRUCTURE_INDEXER_FIELD_PREFIX
See Also:
Constant Field Values

STRUCTURE_INDEXER_FIELD_SEPARATOR

static final String STRUCTURE_INDEXER_FIELD_SEPARATOR
See Also:
Constant Field Values

STRUCTURE_TYPE_AUTO

static final int STRUCTURE_TYPE_AUTO
See Also:
Constant Field Values

STRUCTURE_TYPE_DEFAULT

static final int STRUCTURE_TYPE_DEFAULT
See Also:
Constant Field Values

STRUCTURE_VERSION_DEFAULT

static final String STRUCTURE_VERSION_DEFAULT
See Also:
Constant Field Values
Method Detail

addAttributes

void addAttributes(long structureId,
                   Document document,
                   DDMFormValues ddmFormValues)
                   throws PortalException
Throws:
PortalException

addStructure

DDMStructure addStructure(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

deleteStructure

void deleteStructure(long structureId)
                     throws PortalException
Throws:
PortalException

extractAttributes

String extractAttributes(long structureId,
                         DDMFormValues ddmFormValues,
                         Locale locale)
                         throws PortalException
Throws:
PortalException

fetchStructure

DDMStructure fetchStructure(long structureId)

fetchStructure

DDMStructure fetchStructure(long groupId,
                            long classNameId,
                            String structureKey)

fetchStructureByUuidAndGroupId

DDMStructure fetchStructureByUuidAndGroupId(String uuid,
                                            long groupId)

getClassStructures

List<DDMStructure> getClassStructures(long companyId,
                                      long classNameId)

getClassStructures

List<DDMStructure> getClassStructures(long companyId,
                                      long classNameId,
                                      int structureComparator)

getClassStructures

List<DDMStructure> getClassStructures(long companyId,
                                      long classNameId,
                                      int start,
                                      int end)

getDDMFormFieldsJSONArray

JSONArray getDDMFormFieldsJSONArray(long structureId,
                                    String script)
                                    throws PortalException
Throws:
PortalException

getDDMStructureModelClass

Class<?> getDDMStructureModelClass()

getIndexedFieldValue

Serializable getIndexedFieldValue(Serializable fieldValue,
                                  String fieldType)
                                  throws Exception
Throws:
Exception

getStructure

DDMStructure getStructure(long structureId)
                          throws PortalException
Throws:
PortalException

getStructure

DDMStructure getStructure(long groupId,
                          long classNameId,
                          String structureKey)
                          throws PortalException
Throws:
PortalException

getStructureByUuidAndGroupId

DDMStructure getStructureByUuidAndGroupId(String uuid,
                                          long groupId)
                                          throws PortalException
Throws:
PortalException

getStructures

List<DDMStructure> getStructures(long[] groupIds,
                                 long classNameId)

getStructureStorageLinksCount

int getStructureStorageLinksCount(long structureId)

updateStructure

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

updateStructureDefinition

void updateStructureDefinition(long structureId,
                               String definition)
                               throws PortalException
Throws:
PortalException

updateStructureKey

void updateStructureKey(long structureId,
                        String structureKey)
                        throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4