Liferay 6.2-ce-ga5

com.liferay.portlet.dynamicdatamapping.service
Interface DDMContentLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DDMContentLocalServiceWrapper

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

Provides the local service interface for DDMContent. 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:
DDMContentLocalServiceUtil, com.liferay.portlet.dynamicdatamapping.service.base.DDMContentLocalServiceBaseImpl, com.liferay.portlet.dynamicdatamapping.service.impl.DDMContentLocalServiceImpl

Method Summary
 DDMContent addContent(long userId, long groupId, String name, String description, String xml, ServiceContext serviceContext)
           
 DDMContent addDDMContent(DDMContent ddmContent)
          Adds the d d m content to the database.
 DDMContent createDDMContent(long contentId)
          Creates a new d d m content with the primary key.
 void deleteContent(DDMContent content)
           
 void deleteContents(long groupId)
           
 DDMContent deleteDDMContent(DDMContent ddmContent)
          Deletes the d d m content from the database.
 DDMContent deleteDDMContent(long contentId)
          Deletes the d d m content with the primary key from the database.
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 DDMContent fetchDDMContent(long contentId)
           
 DDMContent fetchDDMContentByUuidAndCompanyId(String uuid, long companyId)
          Returns the d d m content with the matching UUID and company.
 DDMContent fetchDDMContentByUuidAndGroupId(String uuid, long groupId)
          Returns the d d m content matching the UUID and group.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 DDMContent getContent(long contentId)
           
 List<DDMContent> getContents()
           
 List<DDMContent> getContents(long groupId)
           
 List<DDMContent> getContents(long groupId, int start, int end)
           
 int getContentsCount(long groupId)
           
 DDMContent getDDMContent(long contentId)
          Returns the d d m content with the primary key.
 DDMContent getDDMContentByUuidAndCompanyId(String uuid, long companyId)
          Returns the d d m content with the matching UUID and company.
 DDMContent getDDMContentByUuidAndGroupId(String uuid, long groupId)
          Returns the d d m content matching the UUID and group.
 List<DDMContent> getDDMContents(int start, int end)
          Returns a range of all the d d m contents.
 int getDDMContentsCount()
          Returns the number of d d m contents.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 DDMContent updateContent(long contentId, String name, String description, String xml, ServiceContext serviceContext)
           
 DDMContent updateDDMContent(DDMContent ddmContent)
          Updates the d d m content in the database or adds it if it does not yet exist.
 

Method Detail

addDDMContent

@Indexable(type=REINDEX)
DDMContent addDDMContent(DDMContent ddmContent)
                         throws SystemException
Adds the d d m content to the database. Also notifies the appropriate model listeners.

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

createDDMContent

DDMContent createDDMContent(long contentId)
Creates a new d d m content with the primary key. Does not add the d d m content to the database.

Parameters:
contentId - the primary key for the new d d m content
Returns:
the new d d m content

deleteDDMContent

@Indexable(type=DELETE)
DDMContent deleteDDMContent(long contentId)
                            throws PortalException,
                                   SystemException
Deletes the d d m content with the primary key from the database. Also notifies the appropriate model listeners.

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

deleteDDMContent

@Indexable(type=DELETE)
DDMContent deleteDDMContent(DDMContent ddmContent)
                            throws SystemException
Deletes the d d m content from the database. Also notifies the appropriate model listeners.

Parameters:
ddmContent - the d d m content
Returns:
the d d m content 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 DDMContentModelImpl. 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 DDMContentModelImpl. 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

dynamicQueryCount

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

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

fetchDDMContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMContent fetchDDMContent(long contentId)
                           throws SystemException
Throws:
SystemException

fetchDDMContentByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMContent fetchDDMContentByUuidAndCompanyId(String uuid,
                                                                                      long companyId)
                                             throws SystemException
Returns the d d m content with the matching UUID and company.

Parameters:
uuid - the d d m content's UUID
companyId - the primary key of the company
Returns:
the matching d d m content, or null if a matching d d m content could not be found
Throws:
SystemException - if a system exception occurred

fetchDDMContentByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMContent fetchDDMContentByUuidAndGroupId(String uuid,
                                                                                    long groupId)
                                           throws SystemException
Returns the d d m content matching the UUID and group.

Parameters:
uuid - the d d m content's UUID
groupId - the primary key of the group
Returns:
the matching d d m content, or null if a matching d d m content could not be found
Throws:
SystemException - if a system exception occurred

getDDMContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMContent getDDMContent(long contentId)
                         throws PortalException,
                                SystemException
Returns the d d m content with the primary key.

Parameters:
contentId - the primary key of the d d m content
Returns:
the d d m content
Throws:
PortalException - if a d d m content 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

getDDMContentByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMContent getDDMContentByUuidAndCompanyId(String uuid,
                                                                                    long companyId)
                                           throws PortalException,
                                                  SystemException
Returns the d d m content with the matching UUID and company.

Parameters:
uuid - the d d m content's UUID
companyId - the primary key of the company
Returns:
the matching d d m content
Throws:
PortalException - if a matching d d m content could not be found
SystemException - if a system exception occurred

getDDMContentByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMContent getDDMContentByUuidAndGroupId(String uuid,
                                                                                  long groupId)
                                         throws PortalException,
                                                SystemException
Returns the d d m content matching the UUID and group.

Parameters:
uuid - the d d m content's UUID
groupId - the primary key of the group
Returns:
the matching d d m content
Throws:
PortalException - if a matching d d m content could not be found
SystemException - if a system exception occurred

getDDMContents

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

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 DDMContentModelImpl. 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 contents
end - the upper bound of the range of d d m contents (not inclusive)
Returns:
the range of d d m contents
Throws:
SystemException - if a system exception occurred

getDDMContentsCount

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

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

updateDDMContent

@Indexable(type=REINDEX)
DDMContent updateDDMContent(DDMContent ddmContent)
                            throws SystemException
Updates the d d m content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
ddmContent - the d d m content
Returns:
the d d m content 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

addContent

DDMContent addContent(long userId,
                      long groupId,
                      String name,
                      String description,
                      String xml,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

deleteContent

void deleteContent(DDMContent content)
                   throws SystemException
Throws:
SystemException

deleteContents

void deleteContents(long groupId)
                    throws SystemException
Throws:
SystemException

getContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMContent getContent(long contentId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getContents

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

getContents

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

getContents

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

getContentsCount

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

updateContent

DDMContent updateContent(long contentId,
                         String name,
                         String description,
                         String xml,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5