|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseLocalServiceImpl
com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLocalServiceBaseImpl
com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl
public class DDMStructureLocalServiceImpl
Provides the local service for accessing, adding, deleting, and updating dynamic data mapping (DDM) structures.
DDM structures (structures) are used in Liferay to store structured content like document types, dynamic data definitions, or web contents.
Structures support inheritance via parent structures. They also support multi-language names and descriptions.
Structures can be related to many models in Liferay, such as those for web contents, dynamic data lists, and documents. This relationship can be established via the model's class name ID.
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
DDMStructureLocalServiceImpl()
|
|
| Method Summary | |
|---|---|
DDMStructure |
addStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
String storageType,
int type,
ServiceContext serviceContext)
|
DDMStructure |
addStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
String storageType,
int type,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by addStructure(long, long,
long, long, String, Map, Map, DDMForm, String, int,
ServiceContext) |
DDMStructure |
addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
|
DDMStructure |
addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by addStructure(long, long,
long, Map, Map, DDMForm, ServiceContext) |
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)
|
DDMStructure |
addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
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) |
void |
addStructureResources(DDMStructure structure,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the structure. |
void |
addStructureResources(DDMStructure structure,
String[] groupPermissions,
String[] guestPermissions)
Adds the model resources with the permissions to the structure. |
protected DDMStructureVersion |
addStructureVersion(DDMStructure structure,
String version)
|
DDMStructure |
copyStructure(long userId,
long structureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
Copies a structure, creating a new structure with all the values extracted from the original one. |
DDMStructure |
copyStructure(long userId,
long structureId,
ServiceContext serviceContext)
|
void |
deleteStructure(DDMStructure structure)
Deletes the structure and its resources. |
void |
deleteStructure(long structureId)
Deletes the structure and its resources. |
void |
deleteStructure(long groupId,
long classNameId,
String structureKey)
Deletes the matching structure and its resources. |
protected Set<Long> |
deleteStructures(List<DDMStructure> structures)
|
void |
deleteStructures(long groupId)
Deletes all the structures of the group. |
void |
deleteStructures(long groupId,
long classNameId)
|
protected DDMStructure |
doUpdateStructure(long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext,
DDMStructure structure)
|
DDMStructure |
fetchStructure(long structureId)
Returns the structure with the ID. |
DDMStructure |
fetchStructure(long groupId,
long classNameId,
String structureKey)
Returns the structure matching the class name ID, structure key, and group. |
DDMStructure |
fetchStructure(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. |
protected void |
getChildrenStructureIds(List<Long> structureIds,
long groupId,
long parentStructureId)
|
protected List<Long> |
getChildrenStructureIds(long groupId,
long structureId)
|
List<DDMStructure> |
getClassStructures(long classNameId)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long) |
List<DDMStructure> |
getClassStructures(long classNameId,
int start,
int end)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long, int, int) |
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId)
Returns all the structures matching the class name ID. |
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId,
int start,
int end)
Returns a range of all the structures matching the class name ID. |
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
Returns all the structures matching the class name ID ordered by the comparator. |
List<DDMStructure> |
getClassStructures(long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long, OrderByComparator) |
protected Set<String> |
getDDMFormFieldsNames(DDMForm ddmForm)
|
List<DDMStructure> |
getDLFileEntryTypeStructures(long dlFileEntryTypeId)
Returns all the structures for the document library file entry type. |
List<DDMStructure> |
getJournalFolderStructures(long[] groupIds,
long journalFolderId,
int restrictionType)
|
protected String |
getNextVersion(String version,
boolean majorVersion)
|
protected DDMForm |
getParentDDMForm(long parentStructureId)
|
DDMStructure |
getStructure(long structureId)
Returns the structure with the ID. |
DDMStructure |
getStructure(long groupId,
long classNameId,
String structureKey)
Returns the structure matching the class name ID, structure key, and group. |
DDMStructure |
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. |
List<DDMStructure> |
getStructure(long groupId,
String name,
String description)
Returns all the structures matching the group, name, and description. |
List<DDMStructure> |
getStructureEntries()
Deprecated. As of 6.2.0, replaced by getStructures() |
List<DDMStructure> |
getStructureEntries(long groupId)
Deprecated. As of 6.2.0, replaced by getStructures(long) |
List<DDMStructure> |
getStructureEntries(long groupId,
int start,
int end)
Deprecated. As of 6.2.0, replaced by getStructures(long, int,
int) |
protected String |
getStructureKey(String structureKey)
|
List<DDMStructure> |
getStructures()
Returns all the structures present in the system. |
List<DDMStructure> |
getStructures(long groupId)
Returns all the structures present in the group. |
List<DDMStructure> |
getStructures(long[] groupIds)
Returns all the structures belonging to the groups. |
List<DDMStructure> |
getStructures(long[] groupIds,
long classNameId)
Returns all the structures matching the class name ID and belonging to the groups. |
List<DDMStructure> |
getStructures(long[] groupIds,
long classNameId,
int start,
int end)
Returns a range of all the structures matching the class name ID and belonging to the groups. |
List<DDMStructure> |
getStructures(long groupId,
int start,
int end)
Returns a range of all the structures belonging to the group. |
List<DDMStructure> |
getStructures(long groupId,
long classNameId)
Returns all the structures matching class name ID and group. |
List<DDMStructure> |
getStructures(long groupId,
long classNameId,
int start,
int end)
Returns a range of all the structures that match the class name ID and group. |
List<DDMStructure> |
getStructures(long groupId,
long classNameId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
Returns an ordered range of all the structures matching the class name ID and group. |
List<DDMStructure> |
getStructures(long groupId,
String name,
String description)
|
int |
getStructuresCount(long groupId)
Returns the number of structures belonging to the group. |
int |
getStructuresCount(long[] groupIds,
long classNameId)
Returns the number of structures matching the class name ID and belonging to the groups. |
int |
getStructuresCount(long groupId,
long classNameId)
Returns the number of structures matching the class name ID and group. |
protected List<DDMTemplate> |
getStructureTemplates(DDMStructure structure,
String type)
|
List<DDMStructure> |
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. |
List<DDMStructure> |
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. |
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. |
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 |
protected void |
syncStructureTemplatesFields(DDMStructure structure)
|
DDMStructure |
updateDDMForm(long structureId,
DDMForm ddmForm,
ServiceContext serviceContext)
|
DDMStructure |
updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
|
DDMStructure |
updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by updateStructure(long, long,
long, String, Map, Map, DDMForm, ServiceContext) |
DDMStructure |
updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
|
DDMStructure |
updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by updateStructure(long, long,
Map, Map, DDMForm, ServiceContext) |
DDMStructure |
updateXSD(long structureId,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by #updateDDMForm(long, String,
ServiceContext) |
protected void |
validate(DDMForm parentDDMForm,
DDMForm ddmForm)
|
protected void |
validate(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
DDMForm ddmForm)
|
protected void |
validate(Map<Locale,String> nameMap,
DDMForm parentDDMForm,
DDMForm ddmForm)
|
protected void |
validate(Map<Locale,String> nameMap,
Locale contentDefaultLocale)
|
| Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
|---|
getClassLoader |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DDMStructureLocalServiceImpl()
| Method Detail |
|---|
public DDMStructure addStructure(long userId,
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
PortalException
@Deprecated
public DDMStructure addStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException
addStructure(long, long,
long, long, String, Map, Map, DDMForm, String, int,
ServiceContext)
userId - the primary key of the structure's creator/ownergroupId - 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
descriptionsdefinition - 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 a user with the primary key could not be
found, if the XSD was not well-formed, or if a portal
exception occurred
public DDMStructure addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
public DDMStructure addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
throws PortalException
addStructure(long, long,
long, Map, Map, DDMForm, ServiceContext)
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
descriptionsdefinition - 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 XSD was not well-formed, or if a portal
exception occurred
public 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
PortalException
@Deprecated
public DDMStructure addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException
addStructure(long, long,
String, long, String, Map, Map, DDMForm, String, int,
ServiceContext)
userId - the primary key of the structure's creator/ownergroupId - the primary key of the groupparentStructureKey - the unique string identifying the parent
structure (optionally null)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
descriptionsdefinition - 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 a user with the primary key could not be
found, if the XSD was not well-formed, or if a portal
exception occurred
public void addStructureResources(DDMStructure structure,
boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException
structure - the structure to add resources toaddGroupPermissions - whether to add group permissionsaddGuestPermissions - whether to add guest permissions
PortalException - if a portal exception occurred
public void addStructureResources(DDMStructure structure,
String[] groupPermissions,
String[] guestPermissions)
throws PortalException
structure - the structure to add resources togroupPermissions - the group permissions to be addedguestPermissions - the guest permissions to be added
PortalException - if a portal exception occurred
public DDMStructure copyStructure(long userId,
long structureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
throws PortalException
userId - the primary key of the structure's creator/ownerstructureId - 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 a portal exception occurred
public DDMStructure copyStructure(long userId,
long structureId,
ServiceContext serviceContext)
throws PortalException
PortalException
@SystemEvent(type=1)
public void deleteStructure(DDMStructure structure)
throws PortalException
Before deleting the structure, this method verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
structure - the structure to be deleted
PortalException - if a portal exception occurred
public void deleteStructure(long structureId)
throws PortalException
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 deleted
PortalException - if a portal exception occurred
public void deleteStructure(long groupId,
long classNameId,
String structureKey)
throws PortalException
Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
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 structure
PortalException - if a portal exception occurred
public void deleteStructures(long groupId)
throws PortalException
Before deleting the structures, the system verifies whether each structure is required by another entity. If any of the structures are needed, an exception is thrown.
groupId - the primary key of the group
PortalException - if a portal exception occurred
public void deleteStructures(long groupId,
long classNameId)
throws PortalException
PortalExceptionpublic DDMStructure fetchStructure(long structureId)
structureId - the primary key of the structure
null if a
matching structure could not be found
public DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey)
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 structure
null if a matching
structure could not be found
public DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
throws PortalException
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.
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 structureincludeAncestorStructures - whether to include ancestor sites (that
have sharing enabled) and include global scoped sites in the
search
null if a matching
structure could not be found
PortalException - if a portal exception occurred@Deprecated public List<DDMStructure> getClassStructures(long classNameId)
getClassStructures(long,
long)
@Deprecated
public List<DDMStructure> getClassStructures(long classNameId,
int start,
int end)
getClassStructures(long,
long, int, int)
public List<DDMStructure> getClassStructures(long companyId,
long classNameId)
companyId - the primary key of the structure's companyclassNameId - the primary key of the class name for the structure's
related model
public List<DDMStructure> getClassStructures(long companyId,
long classNameId,
int start,
int end)
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 companyclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
public List<DDMStructure> getClassStructures(long companyId,
long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
companyId - the primary key of the structure's companyclassNameId - the primary key of the class name for the structure's
related modelorderByComparator - the comparator to order the structures
(optionally null)
@Deprecated
public List<DDMStructure> getClassStructures(long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
getClassStructures(long,
long, OrderByComparator)
public List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
dlFileEntryTypeId - the primary key of the document library file
entry type
public List<DDMStructure> getJournalFolderStructures(long[] groupIds,
long journalFolderId,
int restrictionType)
throws PortalException
PortalException
public DDMStructure getStructure(long structureId)
throws PortalException
structureId - the primary key of the structure
PortalException - if a structure with the ID could not be found
public DDMStructure getStructure(long groupId,
long classNameId,
String structureKey)
throws PortalException
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 structure
PortalException - if a matching structure could not be found
public DDMStructure getStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
throws PortalException
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.
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 structureincludeAncestorStructures - whether to include ancestor sites (that
have sharing enabled) and include global scoped sites in the
search in the search
PortalException - if a matching structure could not be found
public List<DDMStructure> getStructure(long groupId,
String name,
String description)
groupId - the primary key of the structure's groupname - the structure's namedescription - the structure's description
@Deprecated public List<DDMStructure> getStructureEntries()
getStructures()
@Deprecated public List<DDMStructure> getStructureEntries(long groupId)
getStructures(long)
@Deprecated
public List<DDMStructure> getStructureEntries(long groupId,
int start,
int end)
getStructures(long, int,
int)
public List<DDMStructure> getStructures()
public List<DDMStructure> getStructures(long groupId)
groupId - the primary key of the group
public List<DDMStructure> getStructures(long groupId,
int start,
int end)
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.
groupId - the primary key of the groupstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
public List<DDMStructure> getStructures(long groupId,
long classNameId)
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related model
public List<DDMStructure> getStructures(long groupId,
long classNameId,
int start,
int end)
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.
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
public List<DDMStructure> getStructures(long groupId,
long classNameId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
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.
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstart - 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)
public List<DDMStructure> getStructures(long groupId,
String name,
String description)
public List<DDMStructure> getStructures(long[] groupIds)
groupIds - the primary keys of the groups
public List<DDMStructure> getStructures(long[] groupIds,
long classNameId)
groupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related model
public List<DDMStructure> getStructures(long[] groupIds,
long classNameId,
int start,
int end)
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.
groupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
public int getStructuresCount(long groupId)
groupId - the primary key of the group
public int getStructuresCount(long groupId,
long classNameId)
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related model
public int getStructuresCount(long[] groupIds,
long classNameId)
groupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related model
public List<DDMStructure> search(long companyId,
long[] groupIds,
long[] classNameIds,
String keywords,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
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)
public List<DDMStructure> search(long companyId,
long[] groupIds,
long[] classNameIds,
String name,
String description,
String storageType,
int type,
boolean andOperator,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
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)
public int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
String keywords)
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)
public int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
String name,
String description,
String storageType,
int type,
boolean andOperator)
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 field
public DDMStructure updateDDMForm(long structureId,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
public DDMStructure updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
public DDMStructure updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
throws PortalException
updateStructure(long, long,
long, String, Map, Map, DDMForm, ServiceContext)
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
descriptiondefinition - the structure's new XML schema definitionserviceContext - the service context to be applied. Can set the
structure's modification date.
PortalException - if a matching structure could not be found,
if the XSD was not well-formed, or if a portal exception
occurred
public DDMStructure updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
public DDMStructure updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
throws PortalException
updateStructure(long, long,
Map, Map, DDMForm, ServiceContext)
structureId - the primary key of the structureparentStructureId - the primary key of the new parent structurenameMap - the structure's new locales and localized namesdescriptionMap - the structure's new locales and localized
descriptionsdefinition - the structure's new XML schema definitionserviceContext - the service context to be applied. Can set the
structure's modification date.
PortalException - if a matching structure could not be found,
if the XSD was not well-formed, or if a portal exception
occurred
@Deprecated
public DDMStructure updateXSD(long structureId,
String definition,
ServiceContext serviceContext)
throws PortalException
#updateDDMForm(long, String,
ServiceContext)
structureId - the primary key of the structuredefinition - the structure's new XML schema definitionserviceContext - the service context to be applied. Can set the
structure's modification date.
PortalException - if a matching structure could not be found,
if the XSD was not well-formed, or if a portal exception
occurred
protected DDMStructureVersion addStructureVersion(DDMStructure structure,
String version)
protected Set<Long> deleteStructures(List<DDMStructure> structures)
throws PortalException
PortalException
protected DDMStructure doUpdateStructure(long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext,
DDMStructure structure)
throws PortalException
PortalException
protected void getChildrenStructureIds(List<Long> structureIds,
long groupId,
long parentStructureId)
throws PortalException
PortalException
protected List<Long> getChildrenStructureIds(long groupId,
long structureId)
throws PortalException
PortalExceptionprotected Set<String> getDDMFormFieldsNames(DDMForm ddmForm)
protected String getNextVersion(String version,
boolean majorVersion)
protected DDMForm getParentDDMForm(long parentStructureId)
protected String getStructureKey(String structureKey)
protected List<DDMTemplate> getStructureTemplates(DDMStructure structure,
String type)
protected void syncStructureTemplatesFields(DDMStructure structure)
protected void validate(DDMForm parentDDMForm,
DDMForm ddmForm)
throws PortalException
PortalException
protected void validate(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
DDMForm ddmForm)
throws PortalException
PortalException
protected void validate(Map<Locale,String> nameMap,
DDMForm parentDDMForm,
DDMForm ddmForm)
throws PortalException
PortalException
protected void validate(Map<Locale,String> nameMap,
Locale contentDefaultLocale)
throws PortalException
PortalException
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||