Class DDMStructureServiceWrapper
- All Implemented Interfaces:
DDMStructureService,com.liferay.portal.kernel.service.BaseService,com.liferay.portal.kernel.service.ServiceWrapper<DDMStructureService>
DDMStructureService.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddStructure(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) addStructure(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) addStructure(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) copyStructure(long sourceStructureId, com.liferay.portal.kernel.service.ServiceContext serviceContext) copyStructure(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.voiddeleteStructure(long structureId) Deletes the structure and its resources.fetchStructure(long groupId, long classNameId, String structureKey) Returns the structure matching the class name ID, structure key, and group.fetchStructure(long groupId, long classNameId, String structureKey, boolean includeAncestorStructures) fetchStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) Returns the OSGi service identifier.getStructure(long structureId) Returns the structure with the ID.getStructure(long groupId, long classNameId, String structureKey) Returns the structure matching the class name ID, structure key, and group.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.getStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) getStructures(long companyId, long[] groupIds, long classNameId, int status) getStructures(long companyId, long[] groupIds, long classNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) getStructures(long companyId, long[] groupIds, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) getStructures(long companyId, long[] groupIds, long classNameId, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) intgetStructuresCount(long companyId, long[] groupIds, long classNameId) intgetStructuresCount(long companyId, long[] groupIds, long classNameId, String keywords, int status) voidrevertStructure(long structureId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) search(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) search(long companyId, long[] groupIds, long classNameId, String keywords, int type, 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.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.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.intsearchCount(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status) intsearchCount(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.intsearchCount(long companyId, long[] groupIds, long classNameId, String keywords, int type, int status) Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.intsearchCount(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 typevoidsetWrappedService(DDMStructureService ddmStructureService) updateStructure(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) updateStructure(long structureId, long parentStructureId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)
-
Constructor Details
-
DDMStructureServiceWrapper
public DDMStructureServiceWrapper() -
DDMStructureServiceWrapper
-
-
Method Details
-
addStructure
public DDMStructure addStructure(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) - Specified by:
addStructurein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructure
public DDMStructure addStructure(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) - Specified by:
addStructurein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructure
public DDMStructure addStructure(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) - Specified by:
addStructurein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
copyStructure
public DDMStructure copyStructure(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.- Specified by:
copyStructurein interfaceDDMStructureService- Parameters:
sourceStructureId- 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 DDMStructure copyStructure(long sourceStructureId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
copyStructurein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteStructure
public 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.
- Specified by:
deleteStructurein interfaceDDMStructureService- Parameters:
structureId- the primary key of the structure to be deleted- Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchStructure
public DDMStructure fetchStructure(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.- Specified by:
fetchStructurein interfaceDDMStructureService- 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
nullif a matching structure could not be found - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchStructure
public DDMStructure fetchStructure(long groupId, long classNameId, String structureKey, boolean includeAncestorStructures) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
fetchStructurein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchStructureByExternalReferenceCode
public DDMStructure fetchStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
fetchStructureByExternalReferenceCodein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfaceDDMStructureService- Returns:
- the OSGi service identifier
-
getStructure
public DDMStructure getStructure(long structureId) throws com.liferay.portal.kernel.exception.PortalException Returns the structure with the ID.- Specified by:
getStructurein interfaceDDMStructureService- Parameters:
structureId- the primary key of the structure- Returns:
- the structure with the ID
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructure
public 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.- Specified by:
getStructurein interfaceDDMStructureService- 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 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
includeAncestorStructuresis set totrue, this method searches the group's ancestor sites (that have sharing enabled) and lastly searches global scoped sites.- Specified by:
getStructurein interfaceDDMStructureService- 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- Returns:
- the matching structure
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructureByExternalReferenceCode
public DDMStructure getStructureByExternalReferenceCode(String externalReferenceCode, long groupId, long classNameId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getStructureByExternalReferenceCodein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructures
public List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int status) - Specified by:
getStructuresin interfaceDDMStructureService
-
getStructures
public List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) - Specified by:
getStructuresin interfaceDDMStructureService
-
getStructures
public List<DDMStructure> getStructures(long companyId, long[] groupIds, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) - Specified by:
getStructuresin interfaceDDMStructureService
-
getStructures
public 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) - Specified by:
getStructuresin interfaceDDMStructureService
-
getStructuresCount
public int getStructuresCount(long companyId, long[] groupIds, long classNameId) - Specified by:
getStructuresCountin interfaceDDMStructureService
-
getStructuresCount
public int getStructuresCount(long companyId, long[] groupIds, long classNameId, String keywords, int status) - Specified by:
getStructuresCountin interfaceDDMStructureService
-
revertStructure
public void revertStructure(long structureId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
revertStructurein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
public List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructure> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
searchin interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
public List<DDMStructure> search(long companyId, long[] groupIds, long classNameId, String keywords, int type, 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
searchin interfaceDDMStructureService- 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)type- the structure's type. For more information, seeDDMStructureConstants.status- the workflow's status.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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
searchin interfaceDDMStructureService- 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)status- the workflow's status.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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
searchin interfaceDDMStructureService- 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.status- the workflow's status.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 int searchCount(long companyId, long[] groupIds, long classNameId, long classPK, String keywords, int status) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
searchCountin interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
searchCount
public 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.- Specified by:
searchCountin interfaceDDMStructureService- 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)status- the workflow's status.- Returns:
- the number of matching structures
-
searchCount
public int searchCount(long companyId, long[] groupIds, long classNameId, String keywords, int type, int status) Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions.- Specified by:
searchCountin interfaceDDMStructureService- 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)type- the structure's type. For more information, seeDDMStructureConstants.status- the workflow's status.- Returns:
- the number of matching structures
-
searchCount
public 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- Specified by:
searchCountin interfaceDDMStructureService- 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 field- Returns:
- the number of matching structures
-
updateStructure
public DDMStructure updateStructure(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) - Specified by:
updateStructurein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStructure
public DDMStructure updateStructure(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) - Specified by:
updateStructurein interfaceDDMStructureService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getWrappedService
- Specified by:
getWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<DDMStructureService>
-
setWrappedService
- Specified by:
setWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<DDMStructureService>
-