|
Liferay 6.2.0-ce-rc4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.dynamicdatamapping.service.DDMStructureLocalServiceWrapper
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,
String xsd,
String storageType,
int type,
ServiceContext serviceContext)
Adds a structure referencing its parent structure. |
DDMStructure |
addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
ServiceContext serviceContext)
Adds a structure referencing a default parent structure, using the portal property dynamic.data.lists.storage.type storage type and
default structure type. |
DDMStructure |
addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
String storageType,
int type,
ServiceContext serviceContext)
Adds a structure referencing a default parent structure if the parent structure is not found. |
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)
|
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. |
DynamicQuery |
dynamicQuery()
|
List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator 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 that match the dynamic query. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
DDMStructure |
fetchDDMStructure(long structureId)
|
DDMStructure |
fetchDDMStructureByUuidAndCompanyId(String uuid,
long companyId)
Returns the d d m structure with the matching UUID and company. |
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 includeGlobalStructures)
Returns the structure matching the class name ID, structure key, and group, optionally in the global scope. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
List<DDMStructure> |
getClassStructures(long classNameId)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long) |
List<DDMStructure> |
getClassStructures(long classNameId,
int start,
int end)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long, int, int) |
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId)
Returns all the structures matching the class name ID. |
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId,
int start,
int end)
Returns a range of all the structures matching the class name ID. |
List<DDMStructure> |
getClassStructures(long companyId,
long classNameId,
OrderByComparator orderByComparator)
Returns all the structures matching the class name ID ordered by the comparator. |
List<DDMStructure> |
getClassStructures(long classNameId,
OrderByComparator orderByComparator)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long, OrderByComparator) |
DDMStructure |
getDDMStructure(long structureId)
Returns the d d m structure with the primary key. |
DDMStructure |
getDDMStructureByUuidAndCompanyId(String uuid,
long companyId)
Returns the d d m structure with the matching UUID and company. |
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. |
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 orderByComparator)
|
int |
getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
|
List<DDMStructure> |
getDLFileEntryTypeStructures(long dlFileEntryTypeId)
Returns all the structures for the document library file entry type. |
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 includeGlobalStructures)
Returns the structure matching the class name ID, structure key, and group, optionally in the global scope. |
List<DDMStructure> |
getStructure(long groupId,
String name,
String description)
Returns all the structures matching the group, name, and description. |
List<DDMStructure> |
getStructureEntries()
Deprecated. As of 6.2.0, replaced by getStructures() |
List<DDMStructure> |
getStructureEntries(long groupId)
Deprecated. As of 6.2.0, replaced by getStructures(long) |
List<DDMStructure> |
getStructureEntries(long groupId,
int start,
int end)
Deprecated. As of 6.2.0, replaced by getStructures(long, int,
int) |
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 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)
|
List<DDMStructure> |
search(long companyId,
long[] groupIds,
long[] classNameIds,
String keywords,
int start,
int end,
OrderByComparator orderByComparator)
Returns an ordered range of all the structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions. |
List<DDMStructure> |
search(long companyId,
long[] groupIds,
long[] classNameIds,
String name,
String description,
String storageType,
int type,
boolean andOperator,
int start,
int end,
OrderByComparator orderByComparator)
Returns an ordered range of all the structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type. |
int |
searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
String keywords)
Returns the number of structures matching the groups and class name IDs, and matching the keywords in the structure names and descriptions. |
int |
searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
String name,
String description,
String storageType,
int type,
boolean andOperator)
Returns the number of structures matching the groups, class name IDs, name keyword, description keyword, storage type, and type |
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 groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
ServiceContext serviceContext)
Updates the structure matching the class name ID, structure key, and group, replacing its old parent structure, name map, description map, and XSD with new ones. |
DDMStructure |
updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
ServiceContext serviceContext)
Updates the structure matching the structure ID, replacing its old parent structure, name map, description map, and XSD with new ones. |
DDMStructure |
updateXSD(long structureId,
String xsd,
ServiceContext serviceContext)
Updates the structure matching the structure ID, replacing its XSD with a new one. |
void |
updateXSDFieldMetadata(long structureId,
String fieldName,
String metadataEntryName,
String metadataEntryValue,
ServiceContext serviceContext)
Updates the structure matching the structure ID, replacing the metadata entry of the named field. |
| 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)
throws SystemException
addDDMStructure in interface DDMStructureLocalServiceddmStructure - the d d m structure
SystemException - if a system exception occurredpublic DDMStructure createDDMStructure(long structureId)
createDDMStructure in interface DDMStructureLocalServicestructureId - the primary key for the new d d m structure
public DDMStructure deleteDDMStructure(long structureId)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
throws SystemException
deleteDDMStructure in interface DDMStructureLocalServiceddmStructure - the d d m structure
SystemException - if a system exception occurredpublic DynamicQuery dynamicQuery()
dynamicQuery in interface DDMStructureLocalService
public List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery in interface DDMStructureLocalServicedynamicQuery - the dynamic query
SystemException - if a system exception occurred
public List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
throws SystemException
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 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)
SystemException - if a system exception occurred
public List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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 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)
SystemException - if a system exception occurred
public long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQueryCount in interface DDMStructureLocalServicedynamicQuery - the dynamic query
SystemException - if a system exception occurred
public long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
throws SystemException
dynamicQueryCount in interface DDMStructureLocalServicedynamicQuery - the dynamic queryprojection - the projection to apply to the query
SystemException - if a system exception occurred
public DDMStructure fetchDDMStructure(long structureId)
throws SystemException
fetchDDMStructure in interface DDMStructureLocalServiceSystemException
public DDMStructure fetchDDMStructureByUuidAndCompanyId(String uuid,
long companyId)
throws SystemException
fetchDDMStructureByUuidAndCompanyId in interface DDMStructureLocalServiceuuid - the d d m structure's UUIDcompanyId - the primary key of the company
null if a matching d d m structure could not be found
SystemException - if a system exception occurred
public DDMStructure fetchDDMStructureByUuidAndGroupId(String uuid,
long groupId)
throws SystemException
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
SystemException - if a system exception occurred
public DDMStructure getDDMStructure(long structureId)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
getPersistedModel in interface PersistedModelLocalServicegetPersistedModel in interface DDMStructureLocalServicePortalException
SystemException
public DDMStructure getDDMStructureByUuidAndCompanyId(String uuid,
long companyId)
throws PortalException,
SystemException
getDDMStructureByUuidAndCompanyId in interface DDMStructureLocalServiceuuid - the d d m structure's UUIDcompanyId - the primary key of the company
PortalException - if a matching d d m structure could not be found
SystemException - if a system exception occurred
public DDMStructure getDDMStructureByUuidAndGroupId(String uuid,
long groupId)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public List<DDMStructure> getDDMStructures(int start,
int end)
throws SystemException
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 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)
SystemException - if a system exception occurred
public int getDDMStructuresCount()
throws SystemException
getDDMStructuresCount in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public DDMStructure updateDDMStructure(DDMStructure ddmStructure)
throws SystemException
updateDDMStructure in interface DDMStructureLocalServiceddmStructure - the d d m structure
SystemException - if a system exception occurred
public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
throws SystemException
addDLFileEntryTypeDDMStructure in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
throws SystemException
addDLFileEntryTypeDDMStructure in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
throws SystemException
addDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
throws SystemException
addDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
throws SystemException
clearDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
throws SystemException
deleteDLFileEntryTypeDDMStructure in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
throws SystemException
deleteDLFileEntryTypeDDMStructure in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
throws SystemException
deleteDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
throws SystemException
deleteDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
throws SystemException
getDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end)
throws SystemException
getDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
getDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
throws SystemException
getDLFileEntryTypeDDMStructuresCount in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
throws SystemException
hasDLFileEntryTypeDDMStructure in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
throws SystemException
hasDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public void setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
throws SystemException
setDLFileEntryTypeDDMStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurredpublic String getBeanIdentifier()
getBeanIdentifier in interface DDMStructureLocalServicepublic void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier in interface DDMStructureLocalServicebeanIdentifier - the Spring bean ID for this bean
public DDMStructure addStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 descriptionsxsd - the structure's XML schema definitionstorageType - the structure's storage type. It can be "xml" or
"expando". For more information, see StorageType.type - the structure's type. For more information, see DDMStructureConstants.serviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions, and
group permissions for the structure.
PortalException - if a user with the primary key could not be
found, if the XSD was not well-formed, or if a portal exception
occurred
SystemException - if a system exception occurred
public DDMStructure addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 descriptionsxsd - the structure's XML schema definitionserviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions, and
group permissions for the structure.
PortalException - if a user with the primary key could not be
found, if the XSD was not well-formed, or if a portal exception
occurred
SystemException - if a system exception occurred
public DDMStructure addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 descriptionsxsd - the structure's XML schema definitionstorageType - the structure's storage type. It can be "xml" or
"expando". For more information, see StorageType.type - the structure's type. For more information, see DDMStructureConstants.serviceContext - the service context to be applied. Can set the
UUID, creation date, modification date, guest permissions and
group permissions for the structure.
PortalException - if a user with the primary key could not be
found, if the XSD was not well-formed, or if a portal exception
occurred
SystemException - if a system exception occurred
public void addStructureResources(DDMStructure structure,
boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public void addStructureResources(DDMStructure structure,
String[] groupPermissions,
String[] guestPermissions)
throws PortalException,
SystemException
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 occurred
SystemException - if a system exception occurred
public DDMStructure copyStructure(long userId,
long structureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public DDMStructure copyStructure(long userId,
long structureId,
ServiceContext serviceContext)
throws PortalException,
SystemException
copyStructure in interface DDMStructureLocalServicePortalException
SystemException
public void deleteStructure(DDMStructure structure)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public void deleteStructure(long structureId)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public void deleteStructure(long groupId,
long classNameId,
String structureKey)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public void deleteStructures(long groupId)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public DDMStructure fetchStructure(long structureId)
throws SystemException
fetchStructure in interface DDMStructureLocalServicestructureId - the primary key of the structure
null if a
matching structure could not be found
SystemException - if a system exception occurred
public DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey)
throws SystemException
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
SystemException - if a system exception occurred
public DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey,
boolean includeGlobalStructures)
throws PortalException,
SystemException
This method first searches in the group. If the structure is still not
found and includeGlobalStructures is set to
true, this method searches the global group.
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 structureincludeGlobalStructures - whether to include the global scope in
the search
null if a matching
structure could not be found
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public List<DDMStructure> getClassStructures(long classNameId)
throws SystemException
getClassStructures(long,
long)
getClassStructures in interface DDMStructureLocalServiceSystemException
public List<DDMStructure> getClassStructures(long classNameId,
int start,
int end)
throws SystemException
getClassStructures(long,
long, int, int)
getClassStructures in interface DDMStructureLocalServiceSystemException
public List<DDMStructure> getClassStructures(long companyId,
long classNameId)
throws SystemException
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
SystemException - if a system exception occurred
public List<DDMStructure> getClassStructures(long companyId,
long classNameId,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
public List<DDMStructure> getClassStructures(long companyId,
long classNameId,
OrderByComparator orderByComparator)
throws SystemException
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)
SystemException - if a system exception occurred
public List<DDMStructure> getClassStructures(long classNameId,
OrderByComparator orderByComparator)
throws SystemException
getClassStructures(long,
long, OrderByComparator)
getClassStructures in interface DDMStructureLocalServiceSystemException
public List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
throws SystemException
getDLFileEntryTypeStructures in interface DDMStructureLocalServicedlFileEntryTypeId - the primary key of the document library file
entry type
SystemException - if a system exception occurred
public DDMStructure getStructure(long structureId)
throws PortalException,
SystemException
getStructure in interface DDMStructureLocalServicestructureId - the primary key of the structure
PortalException - if a structure with the ID could not be found
SystemException - if a system exception occurred
public DDMStructure getStructure(long groupId,
long classNameId,
String structureKey)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public DDMStructure getStructure(long groupId,
long classNameId,
String structureKey,
boolean includeGlobalStructures)
throws PortalException,
SystemException
This method first searches in the group. If the structure is still not
found and includeGlobalStructures is set to
true, this method searches the global group.
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 structureincludeGlobalStructures - whether to include the global scope in
the search
PortalException - if a matching structure could not be found
SystemException - if a system exception occurred
public List<DDMStructure> getStructure(long groupId,
String name,
String description)
throws SystemException
getStructure in interface DDMStructureLocalServicegroupId - the primary key of the structure's groupname - the structure's namedescription - the structure's description
SystemException - if a system exception occurred
public List<DDMStructure> getStructureEntries()
throws SystemException
getStructures()
getStructureEntries in interface DDMStructureLocalServiceSystemException
public List<DDMStructure> getStructureEntries(long groupId)
throws SystemException
getStructures(long)
getStructureEntries in interface DDMStructureLocalServiceSystemException
public List<DDMStructure> getStructureEntries(long groupId,
int start,
int end)
throws SystemException
getStructures(long, int,
int)
getStructureEntries in interface DDMStructureLocalServiceSystemException
public List<DDMStructure> getStructures()
throws SystemException
getStructures in interface DDMStructureLocalServiceSystemException - if a system exception occurred
public List<DDMStructure> getStructures(long groupId)
throws SystemException
getStructures in interface DDMStructureLocalServicegroupId - the primary key of the group
SystemException - if a system exception occurred
public List<DDMStructure> getStructures(long groupId,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
public List<DDMStructure> getStructures(long groupId,
long classNameId)
throws SystemException
getStructures in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related model
SystemException - if a system exception occurred
public List<DDMStructure> getStructures(long groupId,
long classNameId,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
public List<DDMStructure> getStructures(long groupId,
long classNameId,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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)
SystemException - if a system exception occurred
public List<DDMStructure> getStructures(long groupId,
String name,
String description)
throws SystemException
getStructures in interface DDMStructureLocalServiceSystemException
public List<DDMStructure> getStructures(long[] groupIds)
throws SystemException
getStructures in interface DDMStructureLocalServicegroupIds - the primary keys of the groups
SystemException - if a system exception occurred
public List<DDMStructure> getStructures(long[] groupIds,
long classNameId)
throws SystemException
getStructures in interface DDMStructureLocalServicegroupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related model
SystemException - if a system exception occurred
public List<DDMStructure> getStructures(long[] groupIds,
long classNameId,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
public int getStructuresCount(long groupId)
throws SystemException
getStructuresCount in interface DDMStructureLocalServicegroupId - the primary key of the group
SystemException - if a system exception occurred
public int getStructuresCount(long groupId,
long classNameId)
throws SystemException
getStructuresCount in interface DDMStructureLocalServicegroupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related model
SystemException - if a system exception occurred
public int getStructuresCount(long[] groupIds,
long classNameId)
throws SystemException
getStructuresCount in interface DDMStructureLocalServicegroupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related model
SystemException - if a system exception occurred
public List<DDMStructure> search(long companyId,
long[] groupIds,
long[] classNameIds,
String keywords,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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 groupsclassNameIds - the primary keys of the class names of the models
the structures are related tokeywords - the keywords (space separated), which may occur in the
structure's name or description (optionally null)start - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)orderByComparator - the comparator to order the structures
(optionally null)
SystemException - if a system exception occurred
public List<DDMStructure> search(long companyId,
long[] groupIds,
long[] classNameIds,
String name,
String description,
String storageType,
int type,
boolean andOperator,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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 groupsclassNameIds - the primary keys of the class names of the models
the structures are related toname - the name keywordsdescription - the description keywordsstorageType - the structure's storage type. It can be "xml" or
"expando". For more information, see StorageType.type - the structure's type. For more information, see DDMStructureConstants.andOperator - whether every field must match its keywords, or just
one fieldstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)orderByComparator - the comparator to order the structures
(optionally null)
SystemException - if a system exception occurred
public int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
String keywords)
throws SystemException
searchCount in interface DDMStructureLocalServicecompanyId - the primary key of the structure's companygroupIds - the primary keys of the groupsclassNameIds - the primary keys of the class names of the models
the structures are related tokeywords - the keywords (space separated), which may occur in the
structure's name or description (optionally null)
SystemException - if a system exception occurred
public int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
String name,
String description,
String storageType,
int type,
boolean andOperator)
throws SystemException
searchCount in interface DDMStructureLocalServicecompanyId - the primary key of the structure's companygroupIds - the primary keys of the groupsclassNameIds - the primary keys of the class names of the models
the structure's are related toname - the name keywordsdescription - the description keywordsstorageType - the structure's storage type. It can be "xml" or
"expando". For more information, see StorageType.type - the structure's type. For more information, see DDMStructureConstants.andOperator - whether every field must match its keywords, or just
one field
SystemException - if a system exception occurred
public DDMStructure updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
ServiceContext serviceContext)
throws PortalException,
SystemException
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
descriptionxsd - 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
SystemException - if a system exception occurred
public DDMStructure updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String xsd,
ServiceContext serviceContext)
throws PortalException,
SystemException
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
descriptionsxsd - 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
SystemException - if a system exception occurred
public DDMStructure updateXSD(long structureId,
String xsd,
ServiceContext serviceContext)
throws PortalException,
SystemException
updateXSD in interface DDMStructureLocalServicestructureId - the primary key of the structurexsd - 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
SystemException - if a system exception occurred
public void updateXSDFieldMetadata(long structureId,
String fieldName,
String metadataEntryName,
String metadataEntryValue,
ServiceContext serviceContext)
throws PortalException,
SystemException
updateXSDFieldMetadata in interface DDMStructureLocalServicestructureId - the primary key of the structurefieldName - the name of the field whose metadata to updatemetadataEntryName - the metadata entry's namemetadataEntryValue - the metadata entry's valueserviceContext - 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
SystemException - if a system exception occurredpublic DDMStructureLocalService getWrappedDDMStructureLocalService()
getWrappedService()
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 6.2.0-ce-rc4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||