Class DDMStructureLocalServiceUtil
com.liferay.dynamic.data.mapping.service.impl.DDMStructureLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DDMStructure
addDDMStructure
(DDMStructure ddmStructure) Adds the ddm structure to the database.static DDMStructure
addStructure
(long userId, long groupId, long classNameId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, String storageType, com.liferay.portal.kernel.service.ServiceContext serviceContext) static 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, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructure
addStructure
(String externalReferenceCode, long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructure
addStructure
(String externalReferenceCode, long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, String definition, String storageType, com.liferay.portal.kernel.service.ServiceContext serviceContext) static void
addStructureResources
(DDMStructure structure, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the structure.static void
addStructureResources
(DDMStructure structure, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) Adds the model resources with the permissions to the structure.static DDMStructure
copyStructure
(long userId, long sourceStructureId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructure
copyStructure
(long userId, long sourceStructureId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) Copies a structure, creating a new structure with all the values extracted from the original one.static DDMStructure
createDDMStructure
(long structureId) Creates a new ddm structure with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static DDMStructure
deleteDDMStructure
(long structureId) Deletes the ddm structure with the primary key from the database.static DDMStructure
deleteDDMStructure
(DDMStructure ddmStructure) Deletes the ddm structure from the database.static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static void
deleteStructure
(long structureId) Deletes the structure and its resources.static void
deleteStructure
(long groupId, long classNameId, String structureKey) Deletes the matching structure and its resources.static DDMStructure
deleteStructure
(DDMStructure structure) Deletes the structure and its resources.static void
deleteStructures
(long groupId) Deletes all the structures of the group.static void
deleteStructures
(long groupId, long classNameId) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static DDMStructure
fetchDDMStructure
(long structureId) static DDMStructure
fetchDDMStructureByUuidAndGroupId
(String uuid, long groupId) Returns the ddm structure matching the UUID and group.static DDMStructure
fetchStructure
(long structureId) Returns the structure with the ID.static DDMStructure
fetchStructure
(long groupId, long classNameId, String structureKey) Returns the structure matching the class name ID, structure key, and group.static 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.static DDMStructure
fetchStructureByExternalReferenceCode
(String externalReferenceCode, long groupId, long classNameId) static DDMStructure
fetchStructureByUuidAndGroupId
(String uuid, long groupId, boolean includeAncestorStructures) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static List<DDMStructure>
getChildrenStructures
(long parentStructureId) static List<DDMStructure>
getClassStructures
(long companyId, long classNameId) Returns all the structures matching the class name ID.static List<DDMStructure>
getClassStructures
(long companyId, long classNameId, int start, int end) Returns a range of all the structures matching the class name ID.static List<DDMStructure>
getClassStructures
(long companyId, long classNameId, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns all the structures matching the class name ID ordered by the comparator.static DDMStructure
getDDMStructure
(long structureId) Returns the ddm structure with the primary key.static DDMStructure
getDDMStructureByUuidAndGroupId
(String uuid, long groupId) Returns the ddm structure matching the UUID and group.static List<DDMStructure>
getDDMStructures
(int start, int end) Returns a range of all the ddm structures.static List<DDMStructure>
getDDMStructuresByUuidAndCompanyId
(String uuid, long companyId) Returns all the ddm structures matching the UUID and company.static List<DDMStructure>
getDDMStructuresByUuidAndCompanyId
(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns a range of ddm structures matching the UUID and company.static int
Returns the number of ddm structures.static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static DDMStructureLocalService
static DDMStructure
getStructure
(long structureId) Returns the structure with the ID.static DDMStructure
getStructure
(long groupId, long classNameId, String structureKey) Returns the structure matching the class name ID, structure key, and group.static 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.static List<DDMStructure>
getStructure
(long groupId, String name, String description) Returns all the structures matching the group, name, and description.static DDMStructure
getStructureByExternalReferenceCode
(String externalReferenceCode, long groupId, long classNameId) static DDMForm
getStructureDDMForm
(DDMStructure structure) static List<DDMStructure>
Returns all the structures present in the system.static List<DDMStructure>
getStructures
(long groupId) Returns all the structures present in the group.static List<DDMStructure>
getStructures
(long[] groupIds) Returns all the structures belonging to the groups.static List<DDMStructure>
getStructures
(long[] groupIds, long classNameId) Returns all the structures matching the class name ID and belonging to the groups.static 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.static List<DDMStructure>
getStructures
(long[] groupIds, long classNameId, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) static List<DDMStructure>
getStructures
(long[] groupIds, long classNameId, String name, String description, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns an ordered range of all the structures matching the group, class name ID, name, and description.static List<DDMStructure>
getStructures
(long groupId, int start, int end) Returns a range of all the structures belonging to the group.static List<DDMStructure>
getStructures
(long groupId, long classNameId) Returns all the structures matching class name ID and group.static List<DDMStructure>
getStructures
(long companyId, long[] groupIds, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) static List<DDMStructure>
getStructures
(long companyId, long[] groupIds, long classNameId, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) static 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.static List<DDMStructure>
getStructures
(long groupId, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns an ordered range of all the structures matching the class name ID and group.static List<DDMStructure>
getStructures
(long groupId, String name, String description) static int
getStructuresCount
(long groupId) Returns the number of structures belonging to the group.static int
getStructuresCount
(long[] groupIds, long classNameId) Returns the number of structures matching the class name ID and belonging to the groups.static int
getStructuresCount
(long groupId, long classNameId) Returns the number of structures matching the class name ID and group.static int
getStructuresCount
(long companyId, long[] groupIds, long classNameId, String keywords, int status) static boolean
hasStructure
(long groupId, long classNameId, String structureKey) static String
prepareLocalizedDefinitionForImport
(DDMStructure structure, Locale defaultImportLocale) static void
revertStructure
(long userId, long structureId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) static List<DDMStructure>
search
(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) static List<DDMStructure>
search
(long companyId, long[] groupIds, long classNameId, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.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.static List<DDMStructure>
search
(long companyId, long[] groupIds, long classNameId, String name, String description, String storageType, int type, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.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.static int
searchCount
(long companyId, long[] groupIds, long classNameId, long classPK, String keywords) static int
searchCount
(long companyId, long[] groupIds, long classNameId, String keywords, int status) 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 classNameId, String name, String description, String storageType, int type, int status, boolean andOperator) Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and typestatic DDMStructure
updateDDMStructure
(DDMStructure ddmStructure) Updates the ddm structure in the database or adds it if it does not yet exist.static DDMStructure
updateStructure
(long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructure
updateStructure
(long userId, long structureId, long parentStructureId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructure
updateStructure
(long userId, long structureId, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructure
updateStructure
(String externalReferenceCode, long userId, long structureId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext)
-
Constructor Details
-
DDMStructureLocalServiceUtil
public DDMStructureLocalServiceUtil()
-
-
Method Details
-
addDDMStructure
Adds the ddm structure to the database. Also notifies the appropriate model listeners.Important: Inspect DDMStructureLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddmStructure
- the ddm structure- Returns:
- the ddm structure that was added
-
addStructure
public static DDMStructure addStructure(long userId, long groupId, long classNameId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, String storageType, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructure
public static DDMStructure addStructure(long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructure
public static DDMStructure addStructure(String externalReferenceCode, long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, String storageType, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructure
public static DDMStructure addStructure(String externalReferenceCode, long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String definition, String storageType, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructureResources
public static void addStructureResources(DDMStructure structure, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the resources to the structure.- Parameters:
structure
- the structure to add resources toaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructureResources
public static void addStructureResources(DDMStructure structure, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the model resources with the permissions to the structure.- Parameters:
structure
- the structure to add resources tomodelPermissions
- the model permissions to be added- Throws:
com.liferay.portal.kernel.exception.PortalException
-
copyStructure
public static DDMStructure copyStructure(long userId, long sourceStructureId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) Copies a structure, creating a new structure with all the values extracted from the original one. The new structure supports a new name and description.- Parameters:
userId
- the primary key of the structure's creator/ownersourceStructureId
- 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.- Returns:
- the new structure
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
copyStructure
public static DDMStructure copyStructure(long userId, long sourceStructureId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createDDMStructure
Creates a new ddm structure with the primary key. Does not add the ddm structure to the database.- Parameters:
structureId
- the primary key for the new ddm structure- Returns:
- the new ddm structure
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteDDMStructure
Deletes the ddm structure from the database. Also notifies the appropriate model listeners.Important: Inspect DDMStructureLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddmStructure
- the ddm structure- Returns:
- the ddm structure that was removed
-
deleteDDMStructure
public static DDMStructure deleteDDMStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException Deletes the ddm structure with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DDMStructureLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
structureId
- the primary key of the ddm structure- Returns:
- the ddm structure that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a ddm structure with the primary key could not be found
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteStructure
public static DDMStructure deleteStructure(DDMStructure structure) throws com.liferay.portal.kernel.exception.PortalException Deletes the structure and its resources.Before deleting the structure, this method verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
- Parameters:
structure
- the structure to be deleted- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteStructure
public static void deleteStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException Deletes the structure and its resources.Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
- Parameters:
structureId
- the primary key of the structure to be deleted- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteStructure
public static void deleteStructure(long groupId, long classNameId, String structureKey) throws com.liferay.portal.kernel.exception.PortalException Deletes the matching structure and its resources.Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
- Parameters:
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- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteStructures
public static void deleteStructures(long groupId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the structures of the group.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.
- Parameters:
groupId
- the primary key of the group- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteStructures
public static void deleteStructures(long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMStructureModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMStructureModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDDMStructure
-
fetchDDMStructureByUuidAndGroupId
Returns the ddm structure matching the UUID and group.- Parameters:
uuid
- the ddm structure's UUIDgroupId
- the primary key of the group- Returns:
- the matching ddm structure, or
null
if a matching ddm structure could not be found
-
fetchStructure
Returns the structure with the ID.- Parameters:
structureId
- the primary key of the structure- Returns:
- the structure with the structure ID, or
null
if a matching structure could not be found
-
fetchStructure
Returns the structure matching the class name ID, structure key, and group.- Parameters:
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- Returns:
- the matching structure, or
null
if a matching structure could not be found
-
fetchStructure
public static 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.This method first searches in the group. If the structure is still not found and
includeAncestorStructures
is set totrue
, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.- Parameters:
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- Returns:
- the matching structure, or
null
if a matching structure could not be found
-
fetchStructureByExternalReferenceCode
public static DDMStructure fetchStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) -
fetchStructureByUuidAndGroupId
public static DDMStructure fetchStructureByUuidAndGroupId(String uuid, long groupId, boolean includeAncestorStructures) -
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getChildrenStructures
-
getClassStructures
Returns all the structures matching the class name ID.- Parameters:
companyId
- the primary key of the structure's companyclassNameId
- the primary key of the class name for the structure's related model- Returns:
- the structures matching the class name ID
-
getClassStructures
public static List<DDMStructure> getClassStructures(long companyId, long classNameId, int start, int end) Returns a range of all the structures matching the class name ID.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching structures
-
getClassStructures
public static List<DDMStructure> getClassStructures(long companyId, long classNameId, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns all the structures matching the class name ID ordered by the comparator.- Parameters:
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 (optionallynull
)- Returns:
- the matching structures ordered by the comparator
-
getDDMStructure
public static DDMStructure getDDMStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddm structure with the primary key.- Parameters:
structureId
- the primary key of the ddm structure- Returns:
- the ddm structure
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a ddm structure with the primary key could not be found
-
getDDMStructureByUuidAndGroupId
public static DDMStructure getDDMStructureByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddm structure matching the UUID and group.- Parameters:
uuid
- the ddm structure's UUIDgroupId
- the primary key of the group- Returns:
- the matching ddm structure
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching ddm structure could not be found
-
getDDMStructures
Returns a range of all the ddm structures.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMStructureModelImpl
.- Parameters:
start
- the lower bound of the range of ddm structuresend
- the upper bound of the range of ddm structures (not inclusive)- Returns:
- the range of ddm structures
-
getDDMStructuresByUuidAndCompanyId
Returns all the ddm structures matching the UUID and company.- Parameters:
uuid
- the UUID of the ddm structurescompanyId
- the primary key of the company- Returns:
- the matching ddm structures, or an empty list if no matches were found
-
getDDMStructuresByUuidAndCompanyId
public static List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns a range of ddm structures matching the UUID and company.- Parameters:
uuid
- the UUID of the ddm structurescompanyId
- the primary key of the companystart
- the lower bound of the range of ddm structuresend
- the upper bound of the range of ddm structures (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching ddm structures, or an empty list if no matches were found
-
getDDMStructuresCount
public static int getDDMStructuresCount()Returns the number of ddm structures.- Returns:
- the number of ddm structures
-
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructure
public static DDMStructure getStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException Returns the structure with the ID.- Parameters:
structureId
- the primary key of the structure- Returns:
- the structure with the ID
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructure
public static DDMStructure getStructure(long groupId, long classNameId, String structureKey) throws com.liferay.portal.kernel.exception.PortalException Returns the structure matching the class name ID, structure key, and group.- Parameters:
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- Returns:
- the matching structure
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructure
public static DDMStructure getStructure(long groupId, long classNameId, String structureKey, boolean includeAncestorStructures) throws com.liferay.portal.kernel.exception.PortalException Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites.This method first searches in the group. If the structure is still not found and
includeAncestorStructures
is set totrue
, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.- Parameters:
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- Returns:
- the matching structure
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructure
Returns all the structures matching the group, name, and description.- Parameters:
groupId
- the primary key of the structure's groupname
- the structure's namedescription
- the structure's description- Returns:
- the matching structures
-
getStructureByExternalReferenceCode
public static DDMStructure getStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructureDDMForm
public static DDMForm getStructureDDMForm(DDMStructure structure) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructures
Returns all the structures present in the system.- Returns:
- the structures present in the system
-
getStructures
Returns all the structures present in the group.- Parameters:
groupId
- the primary key of the group- Returns:
- the structures present in the group
-
getStructures
Returns a range of all the structures belonging to the group.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching structures
-
getStructures
Returns all the structures matching class name ID and group.- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the structure's related model- Returns:
- the matching structures
-
getStructures
Returns a range of all the structures that match the class name ID and group.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching structures
-
getStructures
public static List<DDMStructure> getStructures(long groupId, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns an ordered range of all the structures matching the class name ID and group.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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 (optionallynull
)- Returns:
- the range of matching structures ordered by the comparator
-
getStructures
public static List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) -
getStructures
public static List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) -
getStructures
-
getStructures
Returns all the structures belonging to the groups.- Parameters:
groupIds
- the primary keys of the groups- Returns:
- the structures belonging to the groups
-
getStructures
Returns all the structures matching the class name ID and belonging to the groups.- Parameters:
groupIds
- the primary keys of the groupsclassNameId
- the primary key of the class name for the structure's related model- Returns:
- the matching structures
-
getStructures
public static 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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching structures
-
getStructures
public static List<DDMStructure> getStructures(long[] groupIds, long classNameId, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) -
getStructures
public static List<DDMStructure> getStructures(long[] groupIds, long classNameId, String name, String description, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) Returns an ordered range of all the structures matching the group, class name ID, name, and description.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupIds
- the primary keys of the groupsclassNameId
- the primary key of the class name for the structure's related modelname
- the name keywordsdescription
- the description keywordsstart
- 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 (optionallynull
)- Returns:
- the range of matching structures ordered by the comparator
-
getStructuresCount
public static int getStructuresCount(long groupId) Returns the number of structures belonging to the group.- Parameters:
groupId
- the primary key of the group- Returns:
- the number of structures belonging to the group
-
getStructuresCount
public static int getStructuresCount(long groupId, long classNameId) Returns the number of structures matching the class name ID and group.- Parameters:
groupId
- the primary key of the groupclassNameId
- the primary key of the class name for the structure's related model- Returns:
- the number of matching structures
-
getStructuresCount
public static int getStructuresCount(long companyId, long[] groupIds, long classNameId, String keywords, int status) -
getStructuresCount
public static int getStructuresCount(long[] groupIds, long classNameId) Returns the number of structures matching the class name ID and belonging to the groups.- Parameters:
groupIds
- the primary keys of the groupsclassNameId
- the primary key of the class name for the structure's related model- Returns:
- the number of matching structures
-
hasStructure
-
prepareLocalizedDefinitionForImport
public static String prepareLocalizedDefinitionForImport(DDMStructure structure, Locale defaultImportLocale) -
revertStructure
public static void revertStructure(long userId, long structureId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
public static List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
public static List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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 (optionallynull
)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 (optionallynull
)- Returns:
- the range of matching structures ordered by the comparator
-
search
public static List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, String name, String description, String storageType, int type, int status, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.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.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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, seeStorageType
.type
- the structure's type. For more information, seeDDMStructureConstants
.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 (optionallynull
)- Returns:
- the range of matching structures ordered by the comparator
-
searchCount
public static int searchCount(long companyId, long[] groupIds, long classNameId, long classPK, String keywords) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
searchCount
public static int searchCount(long companyId, long[] groupIds, long classNameId, String keywords, int status) Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.- Parameters:
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 (optionallynull
)- Returns:
- the number of matching structures
-
searchCount
public static int searchCount(long companyId, long[] groupIds, long classNameId, String name, String description, String storageType, int type, int status, boolean andOperator) Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type- Parameters:
companyId
- the primary key of the structure's companygroupIds
- the primary keys of the groupsclassNameId
-name
- the name keywordsdescription
- the description keywordsstorageType
- the structure's storage type. It can be "xml" or "expando". For more information, seeStorageType
.type
- the structure's type. For more information, seeDDMStructureConstants
.andOperator
- whether every field must match its keywords, or just one field- Returns:
- the number of matching structures
-
updateDDMStructure
Updates the ddm structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DDMStructureLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddmStructure
- the ddm structure- Returns:
- the ddm structure that was updated
-
updateStructure
public static DDMStructure updateStructure(long userId, long structureId, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStructure
public static DDMStructure updateStructure(long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStructure
public static DDMStructure updateStructure(long userId, long structureId, long parentStructureId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStructure
public static DDMStructure updateStructure(String externalReferenceCode, long userId, long structureId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-