Liferay 6.2.0-ce-m3

com.liferay.portlet.dynamicdatamapping.service
Interface DDMStructureLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DDMStructureLocalServiceBaseImpl, DDMStructureLocalServiceImpl, DDMStructureLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DDMStructureLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the d d m structure local service.

This is a local service. 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.

See Also:
DDMStructureLocalServiceUtil, DDMStructureLocalServiceBaseImpl, DDMStructureLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 DDMStructure addDDMStructure(DDMStructure ddmStructure)
          Adds the d d m structure to the database.
 DDMStructure addStructure(long userId, long groupId, long parentStructureId, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext)
           
 DDMStructure addStructure(long userId, long groupId, long classNameId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
 DDMStructure addStructure(long userId, long groupId, String parentStructureKey, long classNameId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, String storageType, int type, ServiceContext serviceContext)
           
 void addStructureResources(DDMStructure structure, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addStructureResources(DDMStructure structure, String[] groupPermissions, String[] guestPermissions)
           
 DDMStructure copyStructure(long userId, long structureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, 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 deleteStructure(DDMStructure structure)
           
 void deleteStructure(long structureId)
           
 void deleteStructure(long groupId, String structureKey)
           
 void deleteStructures(long groupId)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 DDMStructure fetchDDMStructure(long structureId)
           
 DDMStructure fetchStructure(long structureId)
           
 DDMStructure fetchStructure(long groupId, String structureKey)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<DDMStructure> getClassStructures(long classNameId)
          Deprecated. getClassStructures(long, long)
 List<DDMStructure> getClassStructures(long classNameId, int start, int end)
          Deprecated. getClassStructures(long, long, int, int)
 List<DDMStructure> getClassStructures(long companyId, long classNameId)
           
 List<DDMStructure> getClassStructures(long companyId, long classNameId, int start, int end)
           
 List<DDMStructure> getClassStructures(long companyId, long classNameId, OrderByComparator orderByComparator)
           
 List<DDMStructure> getClassStructures(long classNameId, OrderByComparator orderByComparator)
          Deprecated. 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 with the UUID in the group.
 List<DDMStructure> getDDMStructures(int start, int end)
          Returns a range of all the d d m structures.
 int getDDMStructuresCount()
          Returns the number of d d m structures.
 List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 DDMStructure getStructure(long structureId)
           
 DDMStructure getStructure(long groupId, String structureKey)
           
 DDMStructure getStructure(long groupId, String structureKey, boolean includeGlobalStructures)
           
 List<DDMStructure> getStructure(long groupId, String name, String description)
           
 List<DDMStructure> getStructureEntries()
          Deprecated. getStructures()
 List<DDMStructure> getStructureEntries(long groupId)
          Deprecated. getStructures(long)
 List<DDMStructure> getStructureEntries(long groupId, int start, int end)
          Deprecated. getStructures(long, int, int)
 List<DDMStructure> getStructures()
           
 List<DDMStructure> getStructures(long groupId)
           
 List<DDMStructure> getStructures(long[] groupIds)
           
 List<DDMStructure> getStructures(long groupId, int start, int end)
           
 List<DDMStructure> getStructures(long groupId, long classNameId)
           
 List<DDMStructure> getStructures(long groupId, long classNameId, int start, int end)
           
 List<DDMStructure> getStructures(long groupId, long classNameId, int start, int end, OrderByComparator orderByComparator)
           
 int getStructuresCount(long groupId)
           
 int getStructuresCount(long groupId, long classNameId)
           
 List<DDMStructure> search(long companyId, long[] groupIds, long[] classNameIds, String keywords, int start, int end, OrderByComparator orderByComparator)
           
 List<DDMStructure> search(long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator, int start, int end, OrderByComparator orderByComparator)
           
 int searchCount(long companyId, long[] groupIds, long[] classNameIds, String keywords)
           
 int searchCount(long companyId, long[] groupIds, long[] classNameIds, String name, String description, String storageType, int type, boolean andOperator)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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 structureId, long parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
 DDMStructure updateStructure(long groupId, long parentStructureId, String structureKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
 

Method Detail

addDDMStructure

DDMStructure addDDMStructure(DDMStructure ddmStructure)
                             throws SystemException
Adds the d d m structure to the database. Also notifies the appropriate model listeners.

Parameters:
ddmStructure - the d d m structure
Returns:
the d d m structure that was added
Throws:
SystemException - if a system exception occurred

createDDMStructure

DDMStructure createDDMStructure(long structureId)
Creates a new d d m structure with the primary key. Does not add the d d m structure to the database.

Parameters:
structureId - the primary key for the new d d m structure
Returns:
the new d d m structure

deleteDDMStructure

DDMStructure deleteDDMStructure(long structureId)
                                throws PortalException,
                                       SystemException
Deletes the d d m structure with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
structureId - the primary key of the d d m structure
Returns:
the d d m structure that was removed
Throws:
PortalException - if a d d m structure with the primary key could not be found
SystemException - if a system exception occurred

deleteDDMStructure

DDMStructure deleteDDMStructure(DDMStructure ddmStructure)
                                throws SystemException
Deletes the d d m structure from the database. Also notifies the appropriate model listeners.

Parameters:
ddmStructure - the d d m structure
Returns:
the d d m structure that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

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.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

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.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchDDMStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchDDMStructure(long structureId)
                               throws SystemException
Throws:
SystemException

getDDMStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getDDMStructure(long structureId)
                             throws PortalException,
                                    SystemException
Returns the d d m structure with the primary key.

Parameters:
structureId - the primary key of the d d m structure
Returns:
the d d m structure
Throws:
PortalException - if a d d m structure with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getDDMStructureByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getDDMStructureByUuidAndGroupId(String uuid,
                                                                                      long groupId)
                                             throws PortalException,
                                                    SystemException
Returns the d d m structure with the UUID in the group.

Parameters:
uuid - the UUID of d d m structure
groupId - the group id of the d d m structure
Returns:
the d d m structure
Throws:
PortalException - if a d d m structure with the UUID in the group could not be found
SystemException - if a system exception occurred

getDDMStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getDDMStructures(int start,
                                                                             int end)
                                    throws SystemException
Returns a range of all the d d m structures.

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.

Parameters:
start - the lower bound of the range of d d m structures
end - the upper bound of the range of d d m structures (not inclusive)
Returns:
the range of d d m structures
Throws:
SystemException - if a system exception occurred

getDDMStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDMStructuresCount()
                          throws SystemException
Returns the number of d d m structures.

Returns:
the number of d d m structures
Throws:
SystemException - if a system exception occurred

updateDDMStructure

DDMStructure updateDDMStructure(DDMStructure ddmStructure)
                                throws SystemException
Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
ddmStructure - the d d m structure
Returns:
the d d m structure that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addStructure

DDMStructure addStructure(long userId,
                          long groupId,
                          String parentStructureKey,
                          long classNameId,
                          String structureKey,
                          Map<Locale,String> nameMap,
                          Map<Locale,String> descriptionMap,
                          String xsd,
                          String storageType,
                          int type,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addStructure

DDMStructure addStructure(long userId,
                          long groupId,
                          long parentStructureId,
                          long classNameId,
                          String structureKey,
                          Map<Locale,String> nameMap,
                          Map<Locale,String> descriptionMap,
                          String xsd,
                          String storageType,
                          int type,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addStructure

DDMStructure addStructure(long userId,
                          long groupId,
                          long classNameId,
                          Map<Locale,String> nameMap,
                          Map<Locale,String> descriptionMap,
                          String xsd,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addStructureResources

void addStructureResources(DDMStructure structure,
                           boolean addGroupPermissions,
                           boolean addGuestPermissions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

addStructureResources

void addStructureResources(DDMStructure structure,
                           String[] groupPermissions,
                           String[] guestPermissions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

copyStructure

DDMStructure copyStructure(long userId,
                           long structureId,
                           Map<Locale,String> nameMap,
                           Map<Locale,String> descriptionMap,
                           ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteStructure

void deleteStructure(DDMStructure structure)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteStructure

void deleteStructure(long structureId)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteStructure

void deleteStructure(long groupId,
                     String structureKey)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteStructures

void deleteStructures(long groupId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

fetchStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchStructure(long structureId)
                            throws SystemException
Throws:
SystemException

fetchStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure fetchStructure(long groupId,
                                                                     String structureKey)
                            throws SystemException
Throws:
SystemException

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long classNameId)
                                      throws SystemException
Deprecated. getClassStructures(long, long)

Throws:
SystemException

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long classNameId,
                                                                               int start,
                                                                               int end)
                                      throws SystemException
Deprecated. getClassStructures(long, long, int, int)

Throws:
SystemException

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long companyId,
                                                                               long classNameId)
                                      throws SystemException
Throws:
SystemException

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long companyId,
                                                                               long classNameId,
                                                                               int start,
                                                                               int end)
                                      throws SystemException
Throws:
SystemException

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long companyId,
                                                                               long classNameId,
                                                                               OrderByComparator orderByComparator)
                                      throws SystemException
Throws:
SystemException

getClassStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getClassStructures(long classNameId,
                                                                               OrderByComparator orderByComparator)
                                      throws SystemException
Deprecated. getClassStructures(long, long, OrderByComparator)

Throws:
SystemException

getDLFileEntryTypeStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getDLFileEntryTypeStructures(long dlFileEntryTypeId)
                                                throws SystemException
Throws:
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long structureId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long groupId,
                                                                   String structureKey)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructure getStructure(long groupId,
                                                                   String structureKey,
                                                                   boolean includeGlobalStructures)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructure(long groupId,
                                                                         String name,
                                                                         String description)
                                throws SystemException
Throws:
SystemException

getStructureEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructureEntries()
                                       throws SystemException
Deprecated. getStructures()

Throws:
SystemException

getStructureEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructureEntries(long groupId)
                                       throws SystemException
Deprecated. getStructures(long)

Throws:
SystemException

getStructureEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructureEntries(long groupId,
                                                                                int start,
                                                                                int end)
                                       throws SystemException
Deprecated. getStructures(long, int, int)

Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures()
                                 throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long groupId)
                                 throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long groupId,
                                                                          int start,
                                                                          int end)
                                 throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long groupId,
                                                                          long classNameId)
                                 throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long groupId,
                                                                          long classNameId,
                                                                          int start,
                                                                          int end)
                                 throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long groupId,
                                                                          long classNameId,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator orderByComparator)
                                 throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> getStructures(long[] groupIds)
                                 throws SystemException
Throws:
SystemException

getStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getStructuresCount(long groupId)
                       throws SystemException
Throws:
SystemException

getStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getStructuresCount(long groupId,
                                                                long classNameId)
                       throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructure> search(long companyId,
                                                                   long[] groupIds,
                                                                   long[] classNameIds,
                                                                   String keywords,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator orderByComparator)
                          throws SystemException
Throws:
SystemException

search

@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 orderByComparator)
                          throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long[] groupIds,
                                                         long[] classNameIds,
                                                         String keywords)
                throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long[] groupIds,
                                                         long[] classNameIds,
                                                         String name,
                                                         String description,
                                                         String storageType,
                                                         int type,
                                                         boolean andOperator)
                throws SystemException
Throws:
SystemException

updateStructure

DDMStructure updateStructure(long structureId,
                             long parentStructureId,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             String xsd,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateStructure

DDMStructure updateStructure(long groupId,
                             long parentStructureId,
                             String structureKey,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             String xsd,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

Liferay 6.2.0-ce-m3