|
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.portlet.dynamicdatamapping.service.DDMStructureLocalServiceWrapper
@ProviderType public class DDMStructureLocalServiceWrapper
Provides a wrapper for DDMStructureLocalService.
DDMStructureLocalService| Constructor Summary | |
|---|---|
DDMStructureLocalServiceWrapper(DDMStructureLocalService ddmStructureLocalService)
|
|
| Method Summary | ||
|---|---|---|
DDMStructure |
addDDMStructure(DDMStructure ddmStructure)
Adds the d d m structure to the database. |
|
void |
addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
|
|
void |
addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
|
|
void |
addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
|
|
void |
addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
|
|
DDMStructure |
addStructure(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,
ServiceContext serviceContext)
|
|
DDMStructure |
addStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
String storageType,
int type,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by addStructure(long, long,
long, long, String, Map, Map, DDMForm, DDMFormLayout, String,
int, ServiceContext) |
|
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 definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by addStructure(long, long,
long, Map, Map, DDMForm, DDMFormLayout, 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 definition,
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) |
|
void |
addStructureResources(DDMStructure structure,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the structure. |
|
void |
addStructureResources(DDMStructure structure,
String[] groupPermissions,
String[] guestPermissions)
Adds the model resources with the permissions to the structure. |
|
void |
clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
|
|
DDMStructure |
copyStructure(long userId,
long structureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
Copies a structure, creating a new structure with all the values extracted from the original one. |
|
DDMStructure |
copyStructure(long userId,
long structureId,
ServiceContext serviceContext)
|
|
DDMStructure |
createDDMStructure(long structureId)
Creates a new d d m structure with the primary key. |
|
DDMStructure |
deleteDDMStructure(DDMStructure ddmStructure)
Deletes the d d m structure from the database. |
|
DDMStructure |
deleteDDMStructure(long structureId)
Deletes the d d m structure with the primary key from the database. |
|
void |
deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
|
|
void |
deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
|
|
void |
deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
|
|
void |
deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
|
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
void |
deleteStructure(DDMStructure structure)
Deletes the structure and its resources. |
|
void |
deleteStructure(long structureId)
Deletes the structure and its resources. |
|
void |
deleteStructure(long groupId,
long classNameId,
String structureKey)
Deletes the matching structure and its resources. |
|
void |
deleteStructures(long groupId)
Deletes all the structures of the group. |
|
void |
deleteStructures(long groupId,
long classNameId)
|
|
DynamicQuery |
dynamicQuery()
|
|
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
DDMStructure |
fetchDDMStructure(long structureId)
|
|
DDMStructure |
fetchDDMStructureByUuidAndGroupId(String uuid,
long groupId)
Returns the d d m structure matching the UUID and group. |
|
DDMStructure |
fetchStructure(long structureId)
Returns the structure with the ID. |
|
DDMStructure |
fetchStructure(long groupId,
long classNameId,
String structureKey)
Returns the structure matching the class name ID, structure key, and group. |
|
DDMStructure |
fetchStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites. |
|
ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
|
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId)
Returns all the structures matching the class name ID. |
|
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId,
int start,
int end)
Returns a range of all the structures matching the class name ID. |
|
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
Returns all the structures matching the class name ID ordered by the comparator. |
|
DDMStructure |
getDDMStructure(long structureId)
Returns the d d m structure with the primary key. |
|
DDMStructure |
getDDMStructureByUuidAndGroupId(String uuid,
long groupId)
Returns the d d m structure matching the UUID and group. |
|
List<DDMStructure> |
getDDMStructures(int start,
int end)
Returns a range of all the d d m structures. |
|
List<DDMStructure> |
getDDMStructuresByUuidAndCompanyId(String uuid,
long companyId)
Returns all the d d m structures matching the UUID and company. |
|
List<DDMStructure> |
getDDMStructuresByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
Returns a range of d d m structures matching the UUID and company. |
|
int |
getDDMStructuresCount()
Returns the number of d d m structures. |
|
List<DDMStructure> |
getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
|
|
List<DDMStructure> |
getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end)
|
|
List<DDMStructure> |
getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
|
|
int |
getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
|
|
long[] |
getDLFileEntryTypePrimaryKeys(long structureId)
Returns the fileEntryTypeIds of the document library file entry types associated with the d d m structure. |
|
List<DDMStructure> |
getDLFileEntryTypeStructures(long dlFileEntryTypeId)
Returns all the structures for the document library file entry type. |
|
ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext)
|
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
DDMStructure |
getStructure(long structureId)
Returns the structure with the ID. |
|
DDMStructure |
getStructure(long groupId,
long classNameId,
String structureKey)
Returns the structure matching the class name ID, structure key, and group. |
|
DDMStructure |
getStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites. |
|
List<DDMStructure> |
getStructure(long groupId,
String name,
String description)
Returns all the structures matching the group, name, and description. |
|
List<DDMStructure> |
getStructures()
Returns all the structures present in the system. |
|
List<DDMStructure> |
getStructures(long groupId)
Returns all the structures present in the group. |
|
List<DDMStructure> |
getStructures(long[] groupIds)
Returns all the structures belonging to the groups. |
|
List<DDMStructure> |
getStructures(long[] groupIds,
long classNameId)
Returns all the structures matching the class name ID and belonging to the groups. |
|
List<DDMStructure> |
getStructures(long[] groupIds,
long classNameId,
int start,
int end)
Returns a range of all the structures matching the class name ID and belonging to the groups. |
|
List<DDMStructure> |
getStructures(long groupId,
int start,
int end)
Returns a range of all the structures belonging to the group. |
|
List<DDMStructure> |
getStructures(long groupId,
long classNameId)
Returns all the structures matching class name ID and group. |
|
List<DDMStructure> |
getStructures(long groupId,
long classNameId,
int start,
int end)
Returns a range of all the structures that match the class name ID and group. |
|
List<DDMStructure> |
getStructures(long groupId,
long classNameId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
Returns an ordered range of all the structures matching the class name ID and group. |
|
List<DDMStructure> |
getStructures(long groupId,
String name,
String description)
|
|
int |
getStructuresCount(long groupId)
Returns the number of structures belonging to the group. |
|
int |
getStructuresCount(long[] groupIds,
long classNameId)
Returns the number of structures matching the class name ID and belonging to the groups. |
|
int |
getStructuresCount(long groupId,
long classNameId)
Returns the number of structures matching the class name ID and group. |
|
DDMStructureLocalService |
getWrappedDDMStructureLocalService()
Deprecated. As of 6.1.0, replaced by getWrappedService() |
|
DDMStructureLocalService |
getWrappedService()
|
|
boolean |
hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
|
|
boolean |
hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
|
|
void |
revertStructure(long userId,
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 |
|
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
|
void |
setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
|
|
void |
setWrappedDDMStructureLocalService(DDMStructureLocalService ddmStructureLocalService)
Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.dynamicdatamapping.service.DDMStructureLocalService) |
|
void |
setWrappedService(DDMStructureLocalService ddmStructureLocalService)
|
|
DDMStructure |
updateDDMStructure(DDMStructure ddmStructure)
Updates the d d m structure in the database or adds it if it does not yet exist. |
|
DDMStructure |
updateStructure(long userId,
long structureId,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
ServiceContext serviceContext)
|
|
DDMStructure |
updateStructure(long userId,
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 userId,
long structureId,
long parentStructureId,
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, long, String, Map, Map, DDMForm, DDMFormLayout,
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,
long, Map, Map, DDMForm, DDMFormLayout, ServiceContext) |
|
DDMStructure |
updateXSD(long structureId,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by #updateStructure(long,
DDMForm, DDMFormLayout, ServiceContext) |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DDMStructureLocalServiceWrapper(DDMStructureLocalService ddmStructureLocalService)
| Method Detail |
|---|
public DDMStructure addDDMStructure(DDMStructure ddmStructure)
addDDMStructure in interface DDMStructureLocalServiceddmStructure - the d d m structure
public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
addDLFileEntryTypeDDMStructure in interface DDMStructureLocalService
public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
addDLFileEntryTypeDDMStructure in interface DDMStructureLocalService
public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
addDLFileEntryTypeDDMStructures in interface DDMStructureLocalService
public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
addDLFileEntryTypeDDMStructures in interface DDMStructureLocalService
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
addStructure in interface DDMStructureLocalServicePortalException
@Deprecated
public DDMStructure addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
throws PortalException
addStructure(long, long,
long, Map, Map, DDMForm, DDMFormLayout, ServiceContext)
dynamic.data.lists.storage.type storage type and
default structure type.
addStructure in interface DDMStructureLocalServiceuserId - the primary key of the structure's creator/ownergroupId - the primary key of the groupclassNameId - the primary key of the class name for the
structure's related modelnameMap - the structure's locales and localized namesdescriptionMap - the structure's locales and localized
descriptionsdefinition - the structure's XML schema definitionserviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions,
and group permissions for the structure.
PortalException - if a user with the primary key could not be
found, if the XSD was not well-formed, or if a portal
exception occurred
public DDMStructure addStructure(long userId,
long groupId,
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
addStructure in interface DDMStructureLocalServicePortalException
@Deprecated
public DDMStructure addStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException
addStructure(long, long,
long, long, String, Map, Map, DDMForm, DDMFormLayout, String,
int, ServiceContext)
addStructure in interface DDMStructureLocalServiceuserId - the primary key of the structure's creator/ownergroupId - the primary key of the groupparentStructureId - the primary key of the parent structure
(optionally DDMStructureConstants.DEFAULT_PARENT_STRUCTURE_ID)classNameId - the primary key of the class name for the
structure's related modelstructureKey - the unique string identifying the structure
(optionally null)nameMap - the structure's locales and localized namesdescriptionMap - the structure's locales and localized
descriptionsdefinition - the structure's XML schema definitionstorageType - the structure's storage type. It can be "xml" or
"expando". For more information, see StorageType.type - the structure's type. For more information, see DDMStructureConstants.serviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions,
and group permissions for the structure.
PortalException - if a user with the primary key could not be
found, if the XSD was not well-formed, or if a portal
exception occurred
public DDMStructure addStructure(long userId,
long groupId,
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
addStructure in interface DDMStructureLocalServicePortalException
@Deprecated
public DDMStructure addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException
addStructure(long, long,
String, long, String, Map, Map, DDMForm, DDMFormLayout,
String, int, ServiceContext)
addStructure in interface DDMStructureLocalServiceuserId - the primary key of the structure's creator/ownergroupId - the primary key of the groupparentStructureKey - the unique string identifying the parent
structure (optionally null)classNameId - the primary key of the class name for the
structure's related modelstructureKey - the unique string identifying the structure
(optionally null)nameMap - the structure's locales and localized namesdescriptionMap - the structure's locales and localized
descriptionsdefinition - the structure's XML schema definitionstorageType - the structure's storage type. It can be "xml" or
"expando". For more information, see StorageType.type - the structure's type. For more information, see DDMStructureConstants.serviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions and
group permissions for the structure.
PortalException - if a user with the primary key could not be
found, if the XSD was not well-formed, or if a portal
exception occurred
public void addStructureResources(DDMStructure structure,
boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException
addStructureResources in interface DDMStructureLocalServicestructure - the structure to add resources toaddGroupPermissions - whether to add group permissionsaddGuestPermissions - whether to add guest permissions
PortalException - if a portal exception occurred
public void addStructureResources(DDMStructure structure,
String[] groupPermissions,
String[] guestPermissions)
throws PortalException
addStructureResources in interface DDMStructureLocalServicestructure - the structure to add resources togroupPermissions - the group permissions to be addedguestPermissions - the guest permissions to be added
PortalException - if a portal exception occurredpublic void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
clearDLFileEntryTypeDDMStructures in interface DDMStructureLocalService
public DDMStructure copyStructure(long userId,
long structureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
throws PortalException
copyStructure in interface DDMStructureLocalServiceuserId - the primary key of the structure's creator/ownerstructureId - the primary key of the structure to be copiednameMap - the new structure's locales and localized namesdescriptionMap - the new structure's locales and localized
descriptionsserviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions, and
group permissions for the structure.
PortalException - if a portal exception occurred
public DDMStructure copyStructure(long userId,
long structureId,
ServiceContext serviceContext)
throws PortalException
copyStructure in interface DDMStructureLocalServicePortalExceptionpublic DDMStructure createDDMStructure(long structureId)
createDDMStructure in interface DDMStructureLocalServicestructureId - the primary key for the new d d m structure
public DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
deleteDDMStructure in interface DDMStructureLocalServiceddmStructure - the d d m structure
public DDMStructure deleteDDMStructure(long structureId)
throws PortalException
deleteDDMStructure in interface DDMStructureLocalServicestructureId - the primary key of the d d m structure
PortalException - if a d d m structure with the primary key could not be found
public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
deleteDLFileEntryTypeDDMStructure in interface DDMStructureLocalService
public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
deleteDLFileEntryTypeDDMStructure in interface DDMStructureLocalService
public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
deleteDLFileEntryTypeDDMStructures in interface DDMStructureLocalService
public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
deleteDLFileEntryTypeDDMStructures in interface DDMStructureLocalService
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
deletePersistedModel in interface PersistedModelLocalServicedeletePersistedModel in interface DDMStructureLocalServicePortalException
public void deleteStructure(long groupId,
long classNameId,
String structureKey)
throws PortalException
Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
deleteStructure in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structure
PortalException - if a portal exception occurred
public void deleteStructure(DDMStructure structure)
throws PortalException
Before deleting the structure, this method verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
deleteStructure in interface DDMStructureLocalServicestructure - the structure to be deleted
PortalException - if a portal exception occurred
public void deleteStructure(long structureId)
throws PortalException
Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
deleteStructure in interface DDMStructureLocalServicestructureId - the primary key of the structure to be deleted
PortalException - if a portal exception occurred
public void deleteStructures(long groupId)
throws PortalException
Before deleting the structures, the system verifies whether each structure is required by another entity. If any of the structures are needed, an exception is thrown.
deleteStructures in interface DDMStructureLocalServicegroupId - the primary key of the group
PortalException - if a portal exception occurred
public void deleteStructures(long groupId,
long classNameId)
throws PortalException
deleteStructures in interface DDMStructureLocalServicePortalExceptionpublic DynamicQuery dynamicQuery()
dynamicQuery in interface DDMStructureLocalServicepublic <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery in interface DDMStructureLocalServicedynamicQuery - the dynamic query
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery in interface DDMStructureLocalServicedynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery in interface DDMStructureLocalServicedynamicQuery - 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 (optionally null)
public long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQueryCount in interface DDMStructureLocalServicedynamicQuery - the dynamic query
public long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQueryCount in interface DDMStructureLocalServicedynamicQuery - the dynamic queryprojection - the projection to apply to the query
public DDMStructure fetchDDMStructure(long structureId)
fetchDDMStructure in interface DDMStructureLocalService
public DDMStructure fetchDDMStructureByUuidAndGroupId(String uuid,
long groupId)
fetchDDMStructureByUuidAndGroupId in interface DDMStructureLocalServiceuuid - the d d m structure's UUIDgroupId - the primary key of the group
null if a matching d d m structure could not be found
public DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey)
fetchStructure in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structure
null if a matching
structure could not be found
public DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
throws PortalException
This method first searches in the group. If the structure is still not
found and includeAncestorStructures is set to
true, this method searches the group's ancestor sites (that
have sharing enabled) and lastly searches global scoped sites.
fetchStructure in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structureincludeAncestorStructures - whether to include ancestor sites (that
have sharing enabled) and include global scoped sites in the
search
null if a matching
structure could not be found
PortalException - if a portal exception occurredpublic DDMStructure fetchStructure(long structureId)
fetchStructure in interface DDMStructureLocalServicestructureId - the primary key of the structure
null if a
matching structure could not be foundpublic ActionableDynamicQuery getActionableDynamicQuery()
getActionableDynamicQuery in interface DDMStructureLocalServicepublic String getBeanIdentifier()
getBeanIdentifier in interface DDMStructureLocalService
public List<DDMStructure> getClassStructures(long companyId,
long classNameId)
getClassStructures in interface DDMStructureLocalServicecompanyId - the primary key of the structure's companyclassNameId - the primary key of the class name for the structure's
related model
public List<DDMStructure> getClassStructures(long companyId,
long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
getClassStructures in interface DDMStructureLocalServicecompanyId - the primary key of the structure's companyclassNameId - the primary key of the class name for the structure's
related modelorderByComparator - the comparator to order the structures
(optionally null)
public List<DDMStructure> getClassStructures(long companyId,
long classNameId,
int start,
int end)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
getClassStructures in interface DDMStructureLocalServicecompanyId - the primary key of the structure's companyclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
public DDMStructure getDDMStructure(long structureId)
throws PortalException
getDDMStructure in interface DDMStructureLocalServicestructureId - the primary key of the d d m structure
PortalException - if a d d m structure with the primary key could not be found
public DDMStructure getDDMStructureByUuidAndGroupId(String uuid,
long groupId)
throws PortalException
getDDMStructureByUuidAndGroupId in interface DDMStructureLocalServiceuuid - the d d m structure's UUIDgroupId - the primary key of the group
PortalException - if a matching d d m structure could not be found
public List<DDMStructure> getDDMStructures(int start,
int end)
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
getDDMStructures in interface DDMStructureLocalServicestart - the lower bound of the range of d d m structuresend - the upper bound of the range of d d m structures (not inclusive)
public List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid,
long companyId)
getDDMStructuresByUuidAndCompanyId in interface DDMStructureLocalServiceuuid - the UUID of the d d m structurescompanyId - the primary key of the company
public List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
getDDMStructuresByUuidAndCompanyId in interface DDMStructureLocalServiceuuid - the UUID of the d d m structurescompanyId - the primary key of the companystart - the lower bound of the range of d d m structuresend - the upper bound of the range of d d m structures (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
public int getDDMStructuresCount()
getDDMStructuresCount in interface DDMStructureLocalServicepublic List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
getDLFileEntryTypeDDMStructures in interface DDMStructureLocalService
public List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end)
getDLFileEntryTypeDDMStructures in interface DDMStructureLocalService
public List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
getDLFileEntryTypeDDMStructures in interface DDMStructureLocalServicepublic int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
getDLFileEntryTypeDDMStructuresCount in interface DDMStructureLocalServicepublic long[] getDLFileEntryTypePrimaryKeys(long structureId)
getDLFileEntryTypePrimaryKeys in interface DDMStructureLocalServicestructureId - the structureId of the d d m structure
public List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
getDLFileEntryTypeStructures in interface DDMStructureLocalServicedlFileEntryTypeId - the primary key of the document library file
entry type
public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
getExportActionableDynamicQuery in interface DDMStructureLocalService
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
getPersistedModel in interface PersistedModelLocalServicegetPersistedModel in interface DDMStructureLocalServicePortalException
public DDMStructure getStructure(long groupId,
long classNameId,
String structureKey)
throws PortalException
getStructure in interface DDMStructureLocalServicegroupId - the primary key of the structure's groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structure
PortalException - if a matching structure could not be found
public DDMStructure getStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
throws PortalException
This method first searches in the group. If the structure is still not
found and includeAncestorStructures is set to
true, this method searches the group's ancestor sites (that
have sharing enabled) and lastly searches global scoped sites.
getStructure in interface DDMStructureLocalServicegroupId - the primary key of the structure's groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structureincludeAncestorStructures - whether to include ancestor sites (that
have sharing enabled) and include global scoped sites in the
search in the search
PortalException - if a matching structure could not be found
public List<DDMStructure> getStructure(long groupId,
String name,
String description)
getStructure in interface DDMStructureLocalServicegroupId - the primary key of the structure's groupname - the structure's namedescription - the structure's description
public DDMStructure getStructure(long structureId)
throws PortalException
getStructure in interface DDMStructureLocalServicestructureId - the primary key of the structure
PortalException - if a structure with the ID could not be foundpublic List<DDMStructure> getStructures()
getStructures in interface DDMStructureLocalServicepublic List<DDMStructure> getStructures(long groupId)
getStructures in interface DDMStructureLocalServicegroupId - the primary key of the group
public List<DDMStructure> getStructures(long groupId,
long classNameId)
getStructures in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related model
public List<DDMStructure> getStructures(long groupId,
long classNameId,
int start,
int end)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
getStructures in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
public List<DDMStructure> getStructures(long groupId,
long classNameId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
getStructures in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)orderByComparator - the comparator to order the structures
(optionally null)
public List<DDMStructure> getStructures(long groupId,
String name,
String description)
getStructures in interface DDMStructureLocalService
public List<DDMStructure> getStructures(long groupId,
int start,
int end)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
getStructures in interface DDMStructureLocalServicegroupId - the primary key of the groupstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
public List<DDMStructure> getStructures(long[] groupIds)
getStructures in interface DDMStructureLocalServicegroupIds - the primary keys of the groups
public List<DDMStructure> getStructures(long[] groupIds,
long classNameId)
getStructures in interface DDMStructureLocalServicegroupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related model
public List<DDMStructure> getStructures(long[] groupIds,
long classNameId,
int start,
int end)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
getStructures in interface DDMStructureLocalServicegroupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
public int getStructuresCount(long groupId)
getStructuresCount in interface DDMStructureLocalServicegroupId - the primary key of the group
public int getStructuresCount(long groupId,
long classNameId)
getStructuresCount in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related model
public int getStructuresCount(long[] groupIds,
long classNameId)
getStructuresCount in interface DDMStructureLocalServicegroupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related model
public boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
hasDLFileEntryTypeDDMStructure in interface DDMStructureLocalServicepublic boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
hasDLFileEntryTypeDDMStructures in interface DDMStructureLocalService
public void revertStructure(long userId,
long structureId,
String version,
ServiceContext serviceContext)
throws PortalException
revertStructure in interface DDMStructureLocalServicePortalException
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.
search in interface DDMStructureLocalServicecompanyId - 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.
search in interface DDMStructureLocalServicecompanyId - 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)
searchCount in interface DDMStructureLocalServicecompanyId - 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)
searchCount in interface DDMStructureLocalServicecompanyId - the primary key of the structure's companygroupIds - the primary keys of the groupsname - 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 void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier in interface DDMStructureLocalServicebeanIdentifier - the Spring bean ID for this bean
public void setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
setDLFileEntryTypeDDMStructures in interface DDMStructureLocalServicepublic DDMStructure updateDDMStructure(DDMStructure ddmStructure)
updateDDMStructure in interface DDMStructureLocalServiceddmStructure - the d d m structure
@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, long, String, Map, Map, DDMForm, DDMFormLayout,
ServiceContext)
updateStructure in interface DDMStructureLocalServicegroupId - the primary key of the groupparentStructureId - the primary key of the new parent structureclassNameId - the primary key of the class name for the
structure's related modelstructureKey - the unique string identifying the structurenameMap - the structure's new locales and localized namesdescriptionMap - the structure's new locales and localized
descriptiondefinition - the structure's new XML schema definitionserviceContext - the service context to be applied. Can set the
structure's modification date.
PortalException - if a matching structure could not be found,
if the XSD was not well-formed, or if a portal exception
occurred
@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,
long, Map, Map, DDMForm, DDMFormLayout, ServiceContext)
updateStructure in interface DDMStructureLocalServicestructureId - the primary key of the structureparentStructureId - the primary key of the new parent structurenameMap - the structure's new locales and localized namesdescriptionMap - the structure's new locales and localized
descriptionsdefinition - the structure's new XML schema definitionserviceContext - the service context to be applied. Can set the
structure's modification date.
PortalException - if a matching structure could not be found,
if the XSD was not well-formed, or if a portal exception
occurred
public DDMStructure updateStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
ServiceContext serviceContext)
throws PortalException
updateStructure in interface DDMStructureLocalServicePortalException
public DDMStructure updateStructure(long userId,
long structureId,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
ServiceContext serviceContext)
throws PortalException
updateStructure in interface DDMStructureLocalServicePortalException
public DDMStructure updateStructure(long userId,
long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
DDMFormLayout ddmFormLayout,
ServiceContext serviceContext)
throws PortalException
updateStructure in interface DDMStructureLocalServicePortalException
@Deprecated
public DDMStructure updateXSD(long structureId,
String definition,
ServiceContext serviceContext)
throws PortalException
#updateStructure(long,
DDMForm, DDMFormLayout, ServiceContext)
updateXSD in interface DDMStructureLocalServicestructureId - the primary key of the structuredefinition - the structure's new XML schema definitionserviceContext - the service context to be applied. Can set the
structure's modification date.
PortalException - if a matching structure could not be found,
if the XSD was not well-formed, or if a portal exception
occurred@Deprecated public DDMStructureLocalService getWrappedDDMStructureLocalService()
getWrappedService()
@Deprecated public void setWrappedDDMStructureLocalService(DDMStructureLocalService ddmStructureLocalService)
setWrappedService(com.liferay.portlet.dynamicdatamapping.service.DDMStructureLocalService)
public DDMStructureLocalService getWrappedService()
getWrappedService in interface ServiceWrapper<DDMStructureLocalService>public void setWrappedService(DDMStructureLocalService ddmStructureLocalService)
setWrappedService in interface ServiceWrapper<DDMStructureLocalService>
|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||