|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.dynamicdatamapping.service.DDMStructureLocalServiceUtil
@ProviderType public class DDMStructureLocalServiceUtil
Provides the local service utility for DDMStructure. This utility wraps
DDMStructureLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.
DDMStructureLocalService,
DDMStructureLocalServiceBaseImpl,
DDMStructureLocalServiceImpl| Constructor Summary | |
|---|---|
DDMStructureLocalServiceUtil()
|
|
| Method Summary | ||
|---|---|---|
static DDMStructure |
addDDMStructure(DDMStructure ddmStructure)
Adds the d d m structure to the database. |
|
static void |
addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
|
|
static void |
addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
|
|
static void |
addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
|
|
static void |
addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
|
|
static void |
addJournalFolderDDMStructure(long folderId,
DDMStructure ddmStructure)
|
|
static void |
addJournalFolderDDMStructure(long folderId,
long structureId)
|
|
static void |
addJournalFolderDDMStructures(long folderId,
List<DDMStructure> DDMStructures)
|
|
static void |
addJournalFolderDDMStructures(long folderId,
long[] structureIds)
|
|
static 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)
|
|
static 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) |
|
static DDMStructure |
addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
|
|
static 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) |
|
static 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)
|
|
static 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) |
|
static void |
addStructureResources(DDMStructure structure,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the structure. |
|
static void |
addStructureResources(DDMStructure structure,
String[] groupPermissions,
String[] guestPermissions)
Adds the model resources with the permissions to the structure. |
|
static void |
clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
|
|
static void |
clearJournalFolderDDMStructures(long folderId)
|
|
static 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. |
|
static DDMStructure |
copyStructure(long userId,
long structureId,
ServiceContext serviceContext)
|
|
static DDMStructure |
createDDMStructure(long structureId)
Creates a new d d m structure with the primary key. |
|
static DDMStructure |
deleteDDMStructure(DDMStructure ddmStructure)
Deletes the d d m structure from the database. |
|
static DDMStructure |
deleteDDMStructure(long structureId)
Deletes the d d m structure with the primary key from the database. |
|
static void |
deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
|
|
static void |
deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
|
|
static void |
deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
|
|
static void |
deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
|
|
static void |
deleteJournalFolderDDMStructure(long folderId,
DDMStructure ddmStructure)
|
|
static void |
deleteJournalFolderDDMStructure(long folderId,
long structureId)
|
|
static void |
deleteJournalFolderDDMStructures(long folderId,
List<DDMStructure> DDMStructures)
|
|
static void |
deleteJournalFolderDDMStructures(long folderId,
long[] structureIds)
|
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static void |
deleteStructure(DDMStructure structure)
Deletes the structure and its resources. |
|
static void |
deleteStructure(long structureId)
Deletes the structure and its resources. |
|
static void |
deleteStructure(long groupId,
long classNameId,
String structureKey)
Deletes the matching structure and its resources. |
|
static void |
deleteStructures(long groupId)
Deletes all the structures of the group. |
|
static void |
deleteStructures(long groupId,
long classNameId)
|
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
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. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
static DDMStructure |
fetchDDMStructure(long structureId)
|
|
static DDMStructure |
fetchDDMStructureByUuidAndGroupId(String uuid,
long groupId)
Returns the d d m structure matching the UUID and group. |
|
static DDMStructure |
fetchStructure(long structureId)
Returns the structure with the ID. |
|
static DDMStructure |
fetchStructure(long groupId,
long classNameId,
String structureKey)
Returns the structure matching the class name ID, structure key, and group. |
|
static DDMStructure |
fetchStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites. |
|
static ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
|
static List<DDMStructure> |
getClassStructures(long classNameId)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long) |
|
static List<DDMStructure> |
getClassStructures(long classNameId,
int start,
int end)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long, int, int) |
|
static List<DDMStructure> |
getClassStructures(long companyId,
long classNameId)
Returns all the structures matching the class name ID. |
|
static List<DDMStructure> |
getClassStructures(long companyId,
long classNameId,
int start,
int end)
Returns a range of all the structures matching the class name ID. |
|
static List<DDMStructure> |
getClassStructures(long companyId,
long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
Returns all the structures matching the class name ID ordered by the comparator. |
|
static List<DDMStructure> |
getClassStructures(long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
Deprecated. As of 6.2.0, replaced by getClassStructures(long,
long, OrderByComparator) |
|
static DDMStructure |
getDDMStructure(long structureId)
Returns the d d m structure with the primary key. |
|
static DDMStructure |
getDDMStructureByUuidAndGroupId(String uuid,
long groupId)
Returns the d d m structure matching the UUID and group. |
|
static List<DDMStructure> |
getDDMStructures(int start,
int end)
Returns a range of all the d d m structures. |
|
static List<DDMStructure> |
getDDMStructuresByUuidAndCompanyId(String uuid,
long companyId)
Returns all the d d m structures matching the UUID and company. |
|
static 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. |
|
static int |
getDDMStructuresCount()
Returns the number of d d m structures. |
|
static List<DDMStructure> |
getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
|
|
static List<DDMStructure> |
getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end)
|
|
static List<DDMStructure> |
getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
|
|
static int |
getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
|
|
static long[] |
getDLFileEntryTypePrimaryKeys(long structureId)
Returns the fileEntryTypeIds of the document library file entry types associated with the d d m structure. |
|
static List<DDMStructure> |
getDLFileEntryTypeStructures(long dlFileEntryTypeId)
Returns all the structures for the document library file entry type. |
|
static ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext)
|
|
static List<DDMStructure> |
getJournalFolderDDMStructures(long folderId)
|
|
static List<DDMStructure> |
getJournalFolderDDMStructures(long folderId,
int start,
int end)
|
|
static List<DDMStructure> |
getJournalFolderDDMStructures(long folderId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
|
|
static int |
getJournalFolderDDMStructuresCount(long folderId)
|
|
static long[] |
getJournalFolderPrimaryKeys(long structureId)
Returns the folderIds of the journal folders associated with the d d m structure. |
|
static List<DDMStructure> |
getJournalFolderStructures(long[] groupIds,
long journalFolderId,
int restrictionType)
|
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
static DDMStructureLocalService |
getService()
|
|
static DDMStructure |
getStructure(long structureId)
Returns the structure with the ID. |
|
static DDMStructure |
getStructure(long groupId,
long classNameId,
String structureKey)
Returns the structure matching the class name ID, structure key, and group. |
|
static DDMStructure |
getStructure(long groupId,
long classNameId,
String structureKey,
boolean includeAncestorStructures)
Returns the structure matching the class name ID, structure key, and group, optionally searching ancestor sites (that have sharing enabled) and global scoped sites. |
|
static List<DDMStructure> |
getStructure(long groupId,
String name,
String description)
Returns all the structures matching the group, name, and description. |
|
static List<DDMStructure> |
getStructureEntries()
Deprecated. As of 6.2.0, replaced by getStructures() |
|
static List<DDMStructure> |
getStructureEntries(long groupId)
Deprecated. As of 6.2.0, replaced by getStructures(long) |
|
static List<DDMStructure> |
getStructureEntries(long groupId,
int start,
int end)
Deprecated. As of 6.2.0, replaced by getStructures(long, int,
int) |
|
static List<DDMStructure> |
getStructures()
Returns all the structures present in the system. |
|
static List<DDMStructure> |
getStructures(long groupId)
Returns all the structures present in the group. |
|
static List<DDMStructure> |
getStructures(long[] groupIds)
Returns all the structures belonging to the groups. |
|
static List<DDMStructure> |
getStructures(long[] groupIds,
long classNameId)
Returns all the structures matching the class name ID and belonging to the groups. |
|
static List<DDMStructure> |
getStructures(long[] groupIds,
long classNameId,
int start,
int end)
Returns a range of all the structures matching the class name ID and belonging to the groups. |
|
static List<DDMStructure> |
getStructures(long groupId,
int start,
int end)
Returns a range of all the structures belonging to the group. |
|
static List<DDMStructure> |
getStructures(long groupId,
long classNameId)
Returns all the structures matching class name ID and group. |
|
static List<DDMStructure> |
getStructures(long groupId,
long classNameId,
int start,
int end)
Returns a range of all the structures that match the class name ID and group. |
|
static List<DDMStructure> |
getStructures(long groupId,
long classNameId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
Returns an ordered range of all the structures matching the class name ID and group. |
|
static List<DDMStructure> |
getStructures(long groupId,
String name,
String description)
|
|
static int |
getStructuresCount(long groupId)
Returns the number of structures belonging to the group. |
|
static int |
getStructuresCount(long[] groupIds,
long classNameId)
Returns the number of structures matching the class name ID and belonging to the groups. |
|
static int |
getStructuresCount(long groupId,
long classNameId)
Returns the number of structures matching the class name ID and group. |
|
static boolean |
hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
|
|
static boolean |
hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
|
|
static boolean |
hasJournalFolderDDMStructure(long folderId,
long structureId)
|
|
static boolean |
hasJournalFolderDDMStructures(long folderId)
|
|
static 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. |
|
static 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. |
|
static 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. |
|
static 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 |
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
|
static void |
setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
|
|
static void |
setJournalFolderDDMStructures(long folderId,
long[] structureIds)
|
|
void |
setService(DDMStructureLocalService service)
Deprecated. As of 6.2.0 |
|
static DDMStructure |
updateDDMForm(long structureId,
DDMForm ddmForm,
ServiceContext serviceContext)
|
|
static DDMStructure |
updateDDMStructure(DDMStructure ddmStructure)
Updates the d d m structure in the database or adds it if it does not yet exist. |
|
static DDMStructure |
updateStructure(long groupId,
long parentStructureId,
long classNameId,
String structureKey,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
|
|
static 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) |
|
static DDMStructure |
updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
|
|
static 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) |
|
static DDMStructure |
updateXSD(long structureId,
String definition,
ServiceContext serviceContext)
Deprecated. As of 7.0.0, replaced by #updateDDMForm(long, String,
ServiceContext) |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DDMStructureLocalServiceUtil()
| Method Detail |
|---|
public static DDMStructure addDDMStructure(DDMStructure ddmStructure)
ddmStructure - the d d m structure
public static void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
public static void addDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
public static void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
public static void addDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
public static void addJournalFolderDDMStructure(long folderId,
DDMStructure ddmStructure)
public static void addJournalFolderDDMStructure(long folderId,
long structureId)
public static void addJournalFolderDDMStructures(long folderId,
List<DDMStructure> DDMStructures)
public static void addJournalFolderDDMStructures(long folderId,
long[] structureIds)
public static DDMStructure addStructure(long userId,
long groupId,
long classNameId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
public static 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
public static 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
public static 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
public static 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
public static 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
public static 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
public static 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 occurredpublic static void clearDLFileEntryTypeDDMStructures(long fileEntryTypeId)
public static void clearJournalFolderDDMStructures(long folderId)
public static 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
public static DDMStructure copyStructure(long userId,
long structureId,
ServiceContext serviceContext)
throws PortalException
PortalExceptionpublic static DDMStructure createDDMStructure(long structureId)
structureId - the primary key for the new d d m structure
public static DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
ddmStructure - the d d m structure
public static 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
public static void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
DDMStructure ddmStructure)
public static void deleteDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
public static void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
List<DDMStructure> DDMStructures)
public static void deleteDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
public static void deleteJournalFolderDDMStructure(long folderId,
DDMStructure ddmStructure)
public static void deleteJournalFolderDDMStructure(long folderId,
long structureId)
public static void deleteJournalFolderDDMStructures(long folderId,
List<DDMStructure> DDMStructures)
public static void deleteJournalFolderDDMStructures(long folderId,
long[] structureIds)
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalException
public static 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
public static 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
public static 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
public static 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
public static void deleteStructures(long groupId,
long classNameId)
throws PortalException
PortalExceptionpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <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)
public static <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)
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static DDMStructure fetchDDMStructure(long structureId)
public static 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
public static 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
public static 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 occurredpublic static DDMStructure fetchStructure(long structureId)
structureId - the primary key of the structure
null if a
matching structure could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static String getBeanIdentifier()
@Deprecated public static List<DDMStructure> getClassStructures(long classNameId)
getClassStructures(long,
long)
@Deprecated
public static List<DDMStructure> getClassStructures(long classNameId,
OrderByComparator<DDMStructure> orderByComparator)
getClassStructures(long,
long, OrderByComparator)
@Deprecated
public static List<DDMStructure> getClassStructures(long classNameId,
int start,
int end)
getClassStructures(long,
long, int, int)
public static 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
public static 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)
public static 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)
public static 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
public static 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
public static 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)
public static List<DDMStructure> getDDMStructuresByUuidAndCompanyId(String uuid,
long companyId)
uuid - the UUID of the d d m structurescompanyId - the primary key of the company
public static 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)
public static int getDDMStructuresCount()
public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId)
public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end)
public static List<DDMStructure> getDLFileEntryTypeDDMStructures(long fileEntryTypeId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
public static int getDLFileEntryTypeDDMStructuresCount(long fileEntryTypeId)
public static long[] getDLFileEntryTypePrimaryKeys(long structureId)
structureId - the structureId of the d d m structure
public static List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
dlFileEntryTypeId - the primary key of the document library file
entry type
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static List<DDMStructure> getJournalFolderDDMStructures(long folderId)
public static List<DDMStructure> getJournalFolderDDMStructures(long folderId,
int start,
int end)
public static List<DDMStructure> getJournalFolderDDMStructures(long folderId,
int start,
int end,
OrderByComparator<DDMStructure> orderByComparator)
public static int getJournalFolderDDMStructuresCount(long folderId)
public static long[] getJournalFolderPrimaryKeys(long structureId)
structureId - the structureId of the d d m structure
public static List<DDMStructure> getJournalFolderStructures(long[] groupIds,
long journalFolderId,
int restrictionType)
throws PortalException
PortalException
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalException
public static 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
public static 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
public static 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
public static 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 public static List<DDMStructure> getStructureEntries()
getStructures()
@Deprecated public static List<DDMStructure> getStructureEntries(long groupId)
getStructures(long)
@Deprecated
public static List<DDMStructure> getStructureEntries(long groupId,
int start,
int end)
getStructures(long, int,
int)
public static List<DDMStructure> getStructures()
public static List<DDMStructure> getStructures(long groupId)
groupId - the primary key of the group
public static 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
public static 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)
public static 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)
public static List<DDMStructure> getStructures(long groupId,
String name,
String description)
public static 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)
public static List<DDMStructure> getStructures(long[] groupIds)
groupIds - the primary keys of the groups
public static 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
public static 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)
public static int getStructuresCount(long groupId)
groupId - the primary key of the group
public static 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
public static 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
public static boolean hasDLFileEntryTypeDDMStructure(long fileEntryTypeId,
long structureId)
public static boolean hasDLFileEntryTypeDDMStructures(long fileEntryTypeId)
public static boolean hasJournalFolderDDMStructure(long folderId,
long structureId)
public static boolean hasJournalFolderDDMStructures(long folderId)
public static 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)
public static 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)
public static 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)
public static 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
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
public static void setDLFileEntryTypeDDMStructures(long fileEntryTypeId,
long[] structureIds)
public static void setJournalFolderDDMStructures(long folderId,
long[] structureIds)
public static DDMStructure updateDDMForm(long structureId,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalExceptionpublic static DDMStructure updateDDMStructure(DDMStructure ddmStructure)
ddmStructure - the d d m structure
public static 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
public static 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
public static DDMStructure updateStructure(long structureId,
long parentStructureId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
DDMForm ddmForm,
ServiceContext serviceContext)
throws PortalException
PortalException
@Deprecated
public static 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
public static 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
occurredpublic static DDMStructureLocalService getService()
@Deprecated public void setService(DDMStructureLocalService service)
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||