|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseServiceImpl
com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureServiceBaseImpl
com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureServiceImpl
public class DDMStructureServiceImpl
Provides the remote service for accessing, adding, deleting, and updating dynamic data mapping (DDM) structures. Its methods include permission checks.
DDMStructureLocalServiceImpl| Field Summary |
|---|
| Fields inherited from class com.liferay.portal.service.BaseServiceImpl |
|---|
ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS |
| Constructor Summary | |
|---|---|
DDMStructureServiceImpl()
|
|
| Method Summary | |
|---|---|
DDMStructure |
addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
ServiceContext serviceContext)
|
DDMStructure |
addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by addStructure(long, long,
long, Map, Map, DDMForm, DDMFormLayout, ServiceContext) |
DDMStructure |
addStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
String storageType,
int type,
ServiceContext serviceContext)
|
DDMStructure |
addStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
String storageType,
int type,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by addStructure(long, long,
long, String, Map, Map, DDMForm, DDMFormLayout, String, int,
ServiceContext) |
DDMStructure |
addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
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 xsd,
String storageType,
int type,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by addStructure(long, long,
String, long, String, Map, Map, DDMForm, DDMFormLayout,
String, int, ServiceContext) |
DDMStructure |
copyStructure(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 structureId,
ServiceContext serviceContext)
|
void |
deleteStructure(long structureId)
Deletes the structure and its resources. |
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)
|
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> |
getStructures(long groupId)
Returns all the structures in the group that the user has permission to view. |
List<DDMStructure> |
getStructures(long[] groupIds)
Returns all the structures in the groups that the user has permission to view. |
List<DDMStructure> |
getStructures(long[] groupIds,
long classNameId)
Returns all the structures matching the groups and class name ID that the user has permission to view. |
List<DDMStructure> |
getStructures(long[] groupIds,
long classNameId,
int start,
int end)
|
void |
revertStructure(long structureId,
String version,
ServiceContext serviceContext)
|
List<DDMStructure> |
search(long companyId,
long[] groupIds,
long classNameId,
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 classNameId,
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 classNameId,
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 classNameId,
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 |
DDMStructure |
updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
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, DDMFormLayout,
ServiceContext) |
DDMStructure |
updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
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, DDMFormLayout, ServiceContext) |
| Methods inherited from class com.liferay.portal.service.BaseServiceImpl |
|---|
getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DDMStructureServiceImpl()
| Method Detail |
|---|
public DDMStructure addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
public DDMStructure addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
ServiceContext serviceContext)
throws PortalException
addStructure(long, long,
long, Map, Map, DDMForm, DDMFormLayout, 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
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 occurred
public DDMStructure addStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
public DDMStructure addStructure(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
addStructure(long, long,
long, String, Map, Map, DDMForm, DDMFormLayout, String, int,
ServiceContext)
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 occurred
public DDMStructure addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
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 xsd,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException
addStructure(long, long,
String, long, String, Map, Map, DDMForm, DDMFormLayout,
String, int, ServiceContext)
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 occurred
public DDMStructure copyStructure(long structureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
throws PortalException
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 occurred
public DDMStructure copyStructure(long structureId,
ServiceContext serviceContext)
throws PortalException
PortalException
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 the user did not have permission to delete the
structure or if a portal exception occurred
public DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey)
throws PortalException
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
PortalException - if the user did not have permission to view the
structure or if a portal exception occurred
public DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
throws PortalException
PortalException
public DDMStructure getStructure(long structureId)
throws PortalException
structureId - the primary key of the structure
PortalException - if the user did not have permission to view the
structure or 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 the user did not have permission to view the
structure or 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
PortalException - if the user did not have permission to view the
structure or if a matching structure could not be foundpublic List<DDMStructure> getStructures(long groupId)
groupId - the primary key of the group
public List<DDMStructure> getStructures(long[] groupIds)
groupIds - the primary key 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)
public void revertStructure(long structureId,
String version,
ServiceContext serviceContext)
throws PortalException
PortalException
public List<DDMStructure> search(long companyId,
long[] groupIds,
long classNameId,
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 groupsclassNameId - the primary key of the class name of the model the
structure is 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 classNameId,
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 groupsclassNameId - the primary key of the class name of the model the
structure is 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 classNameId,
String keywords)
companyId - the primary key of the structure's companygroupIds - the primary keys of the groupsclassNameId - the primary key of the class name of the model the
structure is 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 classNameId,
String name,
String description,
String storageType,
int type,
boolean andOperator)
companyId - the primary key of the structure's companygroupIds - the primary keys of the groupsclassNameId - the primary key of the class name of the model the
structure is 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 updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
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, DDMFormLayout,
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
modification date.
PortalException - if the user did not have permission to update
the structure or if a portal exception occurred
public DDMStructure updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
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, DDMFormLayout, ServiceContext)
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
descriptiondefinition - 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 occurred
|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||