|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface DDMStructureLocalServiceProvides the local service interface for DDMStructure. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
DDMStructureLocalServiceUtil,
DDMStructureLocalServiceBaseImpl,
DDMStructureLocalServiceImpl| 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)
|
|
void |
addJournalFolderDDMStructure(long folderId,
DDMStructure ddmStructure)
|
|
void |
addJournalFolderDDMStructure(long folderId,
long structureId)
|
|
void |
addJournalFolderDDMStructures(long folderId,
List<DDMStructure> DDMStructures)
|
|
void |
addJournalFolderDDMStructures(long folderId,
long[] structureIds)
|
|
DDMStructure |
addStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
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, String, int,
ServiceContext) |
|
DDMStructure |
addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
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, ServiceContext) |
|
DDMStructure |
addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
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, 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)
|
|
void |
clearJournalFolderDDMStructures(long folderId)
|
|
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 |
deleteJournalFolderDDMStructure(long folderId,
DDMStructure ddmStructure)
|
|
void |
deleteJournalFolderDDMStructure(long folderId,
long structureId)
|
|
void |
deleteJournalFolderDDMStructures(long folderId,
List<DDMStructure> DDMStructures)
|
|
void |
deleteJournalFolderDDMStructures(long folderId,
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 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<DDMStructure> orderByComparator)
Returns all the structures matching the class name ID ordered by the comparator. |
|
List<DDMStructure> |
getClassStructures(long classNameId,
OrderByComparator<DDMStructure> 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 |
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)
|
|
List<DDMStructure> |
getJournalFolderDDMStructures(long folderId)
|
|
List<DDMStructure> |
getJournalFolderDDMStructures(long folderId,
int start,
int end)
|
|
List<DDMStructure> |
getJournalFolderDDMStructures(long folderId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
|
|
int |
getJournalFolderDDMStructuresCount(long folderId)
|
|
long[] |
getJournalFolderPrimaryKeys(long structureId)
Returns the folderIds of the journal folders associated with the d d m structure. |
|
List<DDMStructure> |
getJournalFolderStructures(long[] groupIds,
long journalFolderId,
int restrictionType)
|
|
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> |
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<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. |
|
boolean |
hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
|
|
boolean |
hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
|
|
boolean |
hasJournalFolderDDMStructure(long folderId,
long structureId)
|
|
boolean |
hasJournalFolderDDMStructures(long folderId)
|
|
List<DDMStructure> |
search(long companyId,
long[] groupIds,
long[] classNameIds,
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[] classNameIds,
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[] 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 |
setJournalFolderDDMStructures(long folderId,
long[] structureIds)
|
|
DDMStructure |
updateDDMForm(long structureId,
DDMForm ddmForm,
ServiceContext serviceContext)
|
|
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,
DDMForm ddmForm,
ServiceContext serviceContext)
|
|
DDMStructure |
updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by updateStructure(long, long,
long, String, Map, Map, DDMForm, ServiceContext) |
|
DDMStructure |
updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
|
|
DDMStructure |
updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by updateStructure(long, long,
Map, Map, DDMForm, ServiceContext) |
|
DDMStructure |
updateXSD(long structureId,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by #updateDDMForm(long, String,
ServiceContext) |
|
| Method Detail |
|---|
@Indexable(type=REINDEX) DDMStructure addDDMStructure(DDMStructure ddmStructure)
ddmStructure - the d d m structure
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)
void addJournalFolderDDMStructure(long folderId,
DDMStructure ddmStructure)
void addJournalFolderDDMStructure(long folderId,
long structureId)
void addJournalFolderDDMStructures(long folderId,
List<DDMStructure> DDMStructures)
void addJournalFolderDDMStructures(long folderId,
long[] structureIds)
DDMStructure addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
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, ServiceContext)
dynamic.data.lists.storage.type storage type and
default structure type.
userId - the primary key of the structure's creator/ownergroupId - the primary key of the groupclassNameId - the primary key of the class name for the
structure's related modelnameMap - the structure's locales and localized namesdescriptionMap - the structure's locales and localized
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
DDMStructure addStructure(long userId,
long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
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, String, int,
ServiceContext)
userId - 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
DDMStructure addStructure(long userId,
long groupId,
String parentStructureKey,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
String storageType,
int type,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
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, String, int,
ServiceContext)
userId - 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
void addStructureResources(DDMStructure structure,
boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException
structure - the structure to add resources toaddGroupPermissions - whether to add group permissionsaddGuestPermissions - whether to add guest permissions
PortalException - if a portal exception occurred
void addStructureResources(DDMStructure structure,
String[] groupPermissions,
String[] guestPermissions)
throws PortalException
structure - the structure to add resources togroupPermissions - the group permissions to be addedguestPermissions - the guest permissions to be added
PortalException - if a portal exception occurredvoid clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
void clearJournalFolderDDMStructures(long folderId)
DDMStructure copyStructure(long userId,
long structureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
ServiceContext serviceContext)
throws PortalException
userId - 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
DDMStructure copyStructure(long userId,
long structureId,
ServiceContext serviceContext)
throws PortalException
PortalExceptionDDMStructure createDDMStructure(long structureId)
structureId - the primary key for the new d d m structure
@Indexable(type=DELETE) DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
ddmStructure - the d d m structure
@Indexable(type=DELETE)
DDMStructure deleteDDMStructure(long structureId)
throws PortalException
structureId - the primary key of the d d m structure
PortalException - if a d d m structure with the primary key could not be found
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 deleteJournalFolderDDMStructure(long folderId,
DDMStructure ddmStructure)
void deleteJournalFolderDDMStructure(long folderId,
long structureId)
void deleteJournalFolderDDMStructures(long folderId,
List<DDMStructure> DDMStructures)
void deleteJournalFolderDDMStructures(long folderId,
long[] structureIds)
PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
deletePersistedModel in interface PersistedModelLocalServicePortalException
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.
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structure
PortalException - if a portal exception occurred
@SystemEvent(type=1)
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.
structure - the structure to be deleted
PortalException - if a portal exception occurred
void deleteStructure(long structureId)
throws PortalException
Before deleting the structure, the system verifies whether the structure is required by another entity. If it is needed, an exception is thrown.
structureId - the primary key of the structure to be deleted
PortalException - if a portal exception occurred
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.
groupId - the primary key of the group
PortalException - if a portal exception occurred
void deleteStructures(long groupId,
long classNameId)
throws PortalException
PortalExceptionDynamicQuery dynamicQuery()
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
<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 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 - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
<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 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 - 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)
long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure fetchDDMStructure(long structureId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure fetchDDMStructureByUuidAndGroupId(String uuid,
long groupId)
uuid - 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
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure fetchStructure(long groupId,
long classNameId,
String structureKey)
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structure
null if a matching
structure could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structureincludeAncestorStructures - whether to include ancestor sites (that
have sharing enabled) and include global scoped sites in the
search
null if a matching
structure could not be found
PortalException - if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure fetchStructure(long structureId)
structureId - the primary key of the structure
null if a
matching structure could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()
String getBeanIdentifier()
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getClassStructures(long classNameId)
getClassStructures(long,
long)
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getClassStructures(long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
getClassStructures(long,
long, OrderByComparator)
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getClassStructures(long classNameId,
int start,
int end)
getClassStructures(long,
long, int, int)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getClassStructures(long companyId,
long classNameId)
companyId - the primary key of the structure's companyclassNameId - the primary key of the class name for the structure's
related model
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getClassStructures(long companyId,
long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
companyId - the primary key of the structure's companyclassNameId - the primary key of the class name for the structure's
related modelorderByComparator - the comparator to order the structures
(optionally null)
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
companyId - the primary key of the structure's companyclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure getDDMStructure(long structureId)
throws PortalException
structureId - the primary key of the d d m structure
PortalException - if a d d m structure with the primary key could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure getDDMStructureByUuidAndGroupId(String uuid,
long groupId)
throws PortalException
uuid - 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
@Transactional(propagation=SUPPORTS,
readOnly=true)
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 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.
start - the lower bound of the range of d d m structuresend - the upper bound of the range of d d m structures (not inclusive)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid,
long companyId)
uuid - the UUID of the d d m structurescompanyId - the primary key of the company
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
uuid - 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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getDDMStructuresCount()
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
long[] getDLFileEntryTypePrimaryKeys(long structureId)
structureId - the structureId of the d d m structure
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
dlFileEntryTypeId - the primary key of the document library file
entry type
@Transactional(propagation=SUPPORTS,
readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getJournalFolderDDMStructures(long folderId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getJournalFolderDDMStructures(long folderId,
int start,
int end)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getJournalFolderDDMStructures(long folderId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getJournalFolderDDMStructuresCount(long folderId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
long[] getJournalFolderPrimaryKeys(long structureId)
structureId - the structureId of the d d m structure
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getJournalFolderStructures(long[] groupIds,
long journalFolderId,
int restrictionType)
throws PortalException
PortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
getPersistedModel in interface PersistedModelLocalServicePortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure getStructure(long groupId,
long classNameId,
String structureKey)
throws PortalException
groupId - the primary key of the structure's groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structure
PortalException - if a matching structure could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure getStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
throws PortalException
This method first searches in the group. If the structure is still not
found and includeAncestorStructures is set to
true, this method searches the group's ancestor sites (that
have sharing enabled) and lastly searches global scoped sites.
groupId - the primary key of the structure's groupclassNameId - the primary key of the class name for the structure's
related modelstructureKey - the unique string identifying the structureincludeAncestorStructures - whether to include ancestor sites (that
have sharing enabled) and include global scoped sites in the
search in the search
PortalException - if a matching structure could not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructure(long groupId,
String name,
String description)
groupId - the primary key of the structure's groupname - the structure's namedescription - the structure's description
@Transactional(propagation=SUPPORTS,
readOnly=true)
DDMStructure getStructure(long structureId)
throws PortalException
structureId - the primary key of the structure
PortalException - if a structure with the ID could not be found
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructureEntries()
getStructures()
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructureEntries(long groupId)
getStructures(long)
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructureEntries(long groupId,
int start,
int end)
getStructures(long, int,
int)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructures()
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructures(long groupId)
groupId - the primary key of the group
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructures(long groupId,
long classNameId)
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related model
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)orderByComparator - the comparator to order the structures
(optionally null)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructures(long groupId,
String name,
String description)
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
groupId - the primary key of the groupstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructures(long[] groupIds)
groupIds - the primary keys of the groups
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> getStructures(long[] groupIds,
long classNameId)
groupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related model
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
groupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related modelstart - the lower bound of the range of structures to returnend - the upper bound of the range of structures to return (not
inclusive)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getStructuresCount(long groupId)
groupId - the primary key of the group
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getStructuresCount(long groupId,
long classNameId)
groupId - the primary key of the groupclassNameId - the primary key of the class name for the structure's
related model
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getStructuresCount(long[] groupIds,
long classNameId)
groupIds - the primary keys of the groupsclassNameId - the primary key of the class name for the structure's
related model
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasJournalFolderDDMStructure(long folderId,
long structureId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasJournalFolderDDMStructures(long folderId)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> search(long companyId,
long[] groupIds,
long[] classNameIds,
String keywords,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
companyId - the primary key of the structure's companygroupIds - the primary keys of the 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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DDMStructure> search(long companyId,
long[] groupIds,
long[] classNameIds,
String name,
String description,
String storageType,
int type,
boolean andOperator,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
companyId - the primary key of the structure's companygroupIds - the primary keys of the 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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
String keywords)
companyId - 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)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long[] groupIds,
long[] classNameIds,
String name,
String description,
String storageType,
int type,
boolean andOperator)
companyId - 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
void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
void setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
void setJournalFolderDDMStructures(long folderId,
long[] structureIds)
DDMStructure updateDDMForm(long structureId,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException@Indexable(type=REINDEX) DDMStructure updateDDMStructure(DDMStructure ddmStructure)
ddmStructure - the d d m structure
DDMStructure updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
DDMStructure updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
throws PortalException
updateStructure(long, long,
long, String, Map, Map, DDMForm, ServiceContext)
groupId - the primary key of the groupparentStructureId - the primary key of the new parent structureclassNameId - the primary key of the class name for the
structure's related modelstructureKey - the unique string identifying the structurenameMap - the structure's new locales and localized namesdescriptionMap - the structure's new locales and localized
descriptiondefinition - the structure's new XML schema definitionserviceContext - the service context to be applied. Can set the
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
DDMStructure updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
DDMStructure updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
String definition,
ServiceContext serviceContext)
throws PortalException
updateStructure(long, long,
Map, Map, DDMForm, ServiceContext)
structureId - 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
@Deprecated
DDMStructure updateXSD(long structureId,
String definition,
ServiceContext serviceContext)
throws PortalException
#updateDDMForm(long, String,
ServiceContext)
structureId - 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
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||