Liferay 7.0-ce-b4

com.liferay.portal.service
Class PortalPreferencesLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.PortalPreferencesLocalServiceUtil

@ProviderType
public class PortalPreferencesLocalServiceUtil
extends Object

Provides the local service utility for PortalPreferences. This utility wraps PortalPreferencesLocalServiceImpl 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.

See Also:
PortalPreferencesLocalService, PortalPreferencesLocalServiceBaseImpl, PortalPreferencesLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
PortalPreferencesLocalServiceUtil()
           
 
Method Summary
static PortalPreferences addPortalPreferences(long ownerId, int ownerType, String defaultPreferences)
           
static PortalPreferences addPortalPreferences(long companyId, long ownerId, int ownerType, String defaultPreferences)
          Deprecated. As of 6.2.0, replaced by addPortalPreferences(long, int, String)
static PortalPreferences addPortalPreferences(PortalPreferences portalPreferences)
          Adds the portal preferences to the database.
static PortalPreferences createPortalPreferences(long portalPreferencesId)
          Creates a new portal preferences with the primary key.
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static PortalPreferences deletePortalPreferences(long portalPreferencesId)
          Deletes the portal preferences with the primary key from the database.
static PortalPreferences deletePortalPreferences(PortalPreferences portalPreferences)
          Deletes the portal preferences from the database.
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static
<T> List<T>
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 PortalPreferences fetchPortalPreferences(long portalPreferencesId)
           
static ActionableDynamicQuery getActionableDynamicQuery()
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static PortalPreferences getPortalPreferences(long portalPreferencesId)
          Returns the portal preferences with the primary key.
static List<PortalPreferences> getPortalPreferenceses(int start, int end)
          Returns a range of all the portal preferenceses.
static int getPortalPreferencesesCount()
          Returns the number of portal preferenceses.
static PortletPreferences getPreferences(long ownerId, int ownerType)
           
static PortletPreferences getPreferences(long ownerId, int ownerType, String defaultPreferences)
           
static PortletPreferences getPreferences(long companyId, long ownerId, int ownerType)
          Deprecated. As of 6.2.0, replaced by getPreferences(long, int)
static PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, String defaultPreferences)
          Deprecated. As of 6.2.0, replaced by getPreferences(long, int, String)
static PortalPreferencesLocalService getService()
           
static PortalPreferences updatePortalPreferences(PortalPreferences portalPreferences)
          Updates the portal preferences in the database or adds it if it does not yet exist.
static PortalPreferences updatePreferences(long ownerId, int ownerType, PortalPreferences portalPreferences)
           
static PortalPreferences updatePreferences(long ownerId, int ownerType, String xml)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortalPreferencesLocalServiceUtil

public PortalPreferencesLocalServiceUtil()
Method Detail

addPortalPreferences

@Deprecated
public static PortalPreferences addPortalPreferences(long companyId,
                                                                long ownerId,
                                                                int ownerType,
                                                                String defaultPreferences)
Deprecated. As of 6.2.0, replaced by addPortalPreferences(long, int, String)


addPortalPreferences

public static PortalPreferences addPortalPreferences(long ownerId,
                                                     int ownerType,
                                                     String defaultPreferences)

addPortalPreferences

public static PortalPreferences addPortalPreferences(PortalPreferences portalPreferences)
Adds the portal preferences to the database. Also notifies the appropriate model listeners.

Parameters:
portalPreferences - the portal preferences
Returns:
the portal preferences that was added

createPortalPreferences

public static PortalPreferences createPortalPreferences(long portalPreferencesId)
Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.

Parameters:
portalPreferencesId - the primary key for the new portal preferences
Returns:
the new portal preferences

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

deletePortalPreferences

public static PortalPreferences deletePortalPreferences(PortalPreferences portalPreferences)
Deletes the portal preferences from the database. Also notifies the appropriate model listeners.

Parameters:
portalPreferences - the portal preferences
Returns:
the portal preferences that was removed

deletePortalPreferences

public static PortalPreferences deletePortalPreferences(long portalPreferencesId)
                                                 throws PortalException
Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
portalPreferencesId - the primary key of the portal preferences
Returns:
the portal preferences that was removed
Throws:
PortalException - if a portal preferences with the primary key could not be found

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)
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 PortalPreferencesModelImpl. 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

dynamicQuery

public static <T> List<T> 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.

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 PortalPreferencesModelImpl. 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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchPortalPreferences

public static PortalPreferences fetchPortalPreferences(long portalPreferencesId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getPortalPreferences

public static PortalPreferences getPortalPreferences(long portalPreferencesId)
                                              throws PortalException
Returns the portal preferences with the primary key.

Parameters:
portalPreferencesId - the primary key of the portal preferences
Returns:
the portal preferences
Throws:
PortalException - if a portal preferences with the primary key could not be found

getPortalPreferenceses

public static List<PortalPreferences> getPortalPreferenceses(int start,
                                                             int end)
Returns a range of all the portal preferenceses.

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 PortalPreferencesModelImpl. 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 portal preferenceses
end - the upper bound of the range of portal preferenceses (not inclusive)
Returns:
the range of portal preferenceses

getPortalPreferencesesCount

public static int getPortalPreferencesesCount()
Returns the number of portal preferenceses.

Returns:
the number of portal preferenceses

getPreferences

@Deprecated
public static PortletPreferences getPreferences(long companyId,
                                                           long ownerId,
                                                           int ownerType)
Deprecated. As of 6.2.0, replaced by getPreferences(long, int)


getPreferences

@Deprecated
public static PortletPreferences getPreferences(long companyId,
                                                           long ownerId,
                                                           int ownerType,
                                                           String defaultPreferences)
Deprecated. As of 6.2.0, replaced by getPreferences(long, int, String)


getPreferences

public static PortletPreferences getPreferences(long ownerId,
                                                int ownerType)

getPreferences

public static PortletPreferences getPreferences(long ownerId,
                                                int ownerType,
                                                String defaultPreferences)

updatePortalPreferences

public static PortalPreferences updatePortalPreferences(PortalPreferences portalPreferences)
Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
portalPreferences - the portal preferences
Returns:
the portal preferences that was updated

updatePreferences

public static PortalPreferences updatePreferences(long ownerId,
                                                  int ownerType,
                                                  PortalPreferences portalPreferences)

updatePreferences

public static PortalPreferences updatePreferences(long ownerId,
                                                  int ownerType,
                                                  String xml)

getService

public static PortalPreferencesLocalService getService()

Liferay 7.0-ce-b4