Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface LayoutSetPrototypeLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
LayoutSetPrototypeLocalServiceBaseImpl, LayoutSetPrototypeLocalServiceImpl, LayoutSetPrototypeLocalServiceWrapper

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

The interface for the layout set prototype 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:
LayoutSetPrototypeLocalServiceUtil, LayoutSetPrototypeLocalServiceBaseImpl, LayoutSetPrototypeLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 LayoutSetPrototype addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
          Adds the layout set prototype to the database.
 LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext)
           
 LayoutSetPrototype createLayoutSetPrototype(long layoutSetPrototypeId)
          Creates a new layout set prototype with the primary key.
 LayoutSetPrototype deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
          Deletes the layout set prototype from the database.
 LayoutSetPrototype deleteLayoutSetPrototype(long layoutSetPrototypeId)
          Deletes the layout set prototype 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.
 LayoutSetPrototype fetchLayoutSetPrototype(long layoutSetPrototypeId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 LayoutSetPrototype getLayoutSetPrototype(long layoutSetPrototypeId)
          Returns the layout set prototype with the primary key.
 LayoutSetPrototype getLayoutSetPrototypeByUuid(String uuid)
           
 List<LayoutSetPrototype> getLayoutSetPrototypes(int start, int end)
          Returns a range of all the layout set prototypes.
 List<LayoutSetPrototype> getLayoutSetPrototypes(long companyId)
           
 int getLayoutSetPrototypesCount()
          Returns the number of layout set prototypes.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<LayoutSetPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator obc)
           
 int searchCount(long companyId, Boolean active)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
          Updates the layout set prototype in the database or adds it if it does not yet exist.
 LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype, boolean merge)
          Updates the layout set prototype in the database or adds it if it does not yet exist.
 LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale,String> nameMap, String description, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext)
           
 LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, String settings)
           
 

Method Detail

addLayoutSetPrototype

LayoutSetPrototype addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
                                         throws SystemException
Adds the layout set prototype to the database. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototype - the layout set prototype
Returns:
the layout set prototype that was added
Throws:
SystemException - if a system exception occurred

createLayoutSetPrototype

LayoutSetPrototype createLayoutSetPrototype(long layoutSetPrototypeId)
Creates a new layout set prototype with the primary key. Does not add the layout set prototype to the database.

Parameters:
layoutSetPrototypeId - the primary key for the new layout set prototype
Returns:
the new layout set prototype

deleteLayoutSetPrototype

LayoutSetPrototype deleteLayoutSetPrototype(long layoutSetPrototypeId)
                                            throws PortalException,
                                                   SystemException
Deletes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototypeId - the primary key of the layout set prototype
Returns:
the layout set prototype that was removed
Throws:
PortalException - if a layout set prototype with the primary key could not be found
SystemException - if a system exception occurred

deleteLayoutSetPrototype

LayoutSetPrototype deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
                                            throws PortalException,
                                                   SystemException
Deletes the layout set prototype from the database. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototype - the layout set prototype
Returns:
the layout set prototype that was removed
Throws:
PortalException
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.

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.

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

fetchLayoutSetPrototype

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetPrototype fetchLayoutSetPrototype(long layoutSetPrototypeId)
                                           throws SystemException
Throws:
SystemException

getLayoutSetPrototype

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetPrototype getLayoutSetPrototype(long layoutSetPrototypeId)
                                         throws PortalException,
                                                SystemException
Returns the layout set prototype with the primary key.

Parameters:
layoutSetPrototypeId - the primary key of the layout set prototype
Returns:
the layout set prototype
Throws:
PortalException - if a layout set prototype 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

getLayoutSetPrototypes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSetPrototype> getLayoutSetPrototypes(int start,
                                                                                         int end)
                                                throws SystemException
Returns a range of all the layout set prototypes.

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.

Parameters:
start - the lower bound of the range of layout set prototypes
end - the upper bound of the range of layout set prototypes (not inclusive)
Returns:
the range of layout set prototypes
Throws:
SystemException - if a system exception occurred

getLayoutSetPrototypesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutSetPrototypesCount()
                                throws SystemException
Returns the number of layout set prototypes.

Returns:
the number of layout set prototypes
Throws:
SystemException - if a system exception occurred

updateLayoutSetPrototype

LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
                                            throws SystemException
Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototype - the layout set prototype
Returns:
the layout set prototype that was updated
Throws:
SystemException - if a system exception occurred

updateLayoutSetPrototype

LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype,
                                            boolean merge)
                                            throws SystemException
Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototype - the layout set prototype
merge - whether to merge the layout set prototype with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the layout set prototype 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

addLayoutSetPrototype

LayoutSetPrototype addLayoutSetPrototype(long userId,
                                         long companyId,
                                         Map<Locale,String> nameMap,
                                         String description,
                                         boolean active,
                                         boolean layoutsUpdateable,
                                         ServiceContext serviceContext)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

getLayoutSetPrototypeByUuid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetPrototype getLayoutSetPrototypeByUuid(String uuid)
                                               throws PortalException,
                                                      SystemException
Throws:
PortalException
SystemException

getLayoutSetPrototypes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSetPrototype> getLayoutSetPrototypes(long companyId)
                                                throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSetPrototype> search(long companyId,
                                                                         Boolean active,
                                                                         int start,
                                                                         int end,
                                                                         OrderByComparator obc)
                                throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         Boolean active)
                throws SystemException
Throws:
SystemException

updateLayoutSetPrototype

LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId,
                                            Map<Locale,String> nameMap,
                                            String description,
                                            boolean active,
                                            boolean layoutsUpdateable,
                                            ServiceContext serviceContext)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

updateLayoutSetPrototype

LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId,
                                            String settings)
                                            throws PortalException,
                                                   SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3