Liferay 6.0.5

com.liferay.portal.service
Interface ResourceCodeLocalService

All Known Implementing Classes:
ResourceCodeLocalServiceBaseImpl, ResourceCodeLocalServiceImpl, ResourceCodeLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ResourceCodeLocalService

The interface for the resource code local service.

Never modify or reference this interface directly. Always use ResourceCodeLocalServiceUtil to access the resource code local service. Add custom service methods to ResourceCodeLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:
ResourceCodeLocalServiceUtil, ResourceCodeLocalServiceBaseImpl, ResourceCodeLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 ResourceCode addResourceCode(long companyId, String name, int scope)
           
 ResourceCode addResourceCode(ResourceCode resourceCode)
          Adds the resource code to the database.
 void checkResourceCodes()
           
 void checkResourceCodes(long companyId, String name)
           
 ResourceCode createResourceCode(long codeId)
          Creates a new resource code with the primary key.
 void deleteResourceCode(long codeId)
          Deletes the resource code with the primary key from the database.
 void deleteResourceCode(ResourceCode resourceCode)
          Deletes the resource code from the database.
 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)
          Counts the number of rows that match the dynamic query.
 ResourceCode getResourceCode(long codeId)
          Gets the resource code with the primary key.
 ResourceCode getResourceCode(long companyId, String name, int scope)
           
 List<ResourceCode> getResourceCodes(int start, int end)
          Gets a range of all the resource codes.
 int getResourceCodesCount()
          Gets the number of resource codes.
 ResourceCode updateResourceCode(ResourceCode resourceCode)
          Updates the resource code in the database.
 ResourceCode updateResourceCode(ResourceCode resourceCode, boolean merge)
          Updates the resource code in the database.
 

Method Detail

addResourceCode

ResourceCode addResourceCode(ResourceCode resourceCode)
                             throws SystemException
Adds the resource code to the database. Also notifies the appropriate model listeners.

Parameters:
resourceCode - the resource code to add
Returns:
the resource code that was added
Throws:
SystemException - if a system exception occurred

createResourceCode

ResourceCode createResourceCode(long codeId)
Creates a new resource code with the primary key. Does not add the resource code to the database.

Parameters:
codeId - the primary key for the new resource code
Returns:
the new resource code

deleteResourceCode

void deleteResourceCode(long codeId)
                        throws PortalException,
                               SystemException
Deletes the resource code with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
codeId - the primary key of the resource code to delete
Throws:
PortalException - if a resource code with the primary key could not be found
SystemException - if a system exception occurred

deleteResourceCode

void deleteResourceCode(ResourceCode resourceCode)
                        throws SystemException
Deletes the resource code from the database. Also notifies the appropriate model listeners.

Parameters:
resourceCode - the resource code to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query to search with
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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

getResourceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourceCode getResourceCode(long codeId)
                             throws PortalException,
                                    SystemException
Gets the resource code with the primary key.

Parameters:
codeId - the primary key of the resource code to get
Returns:
the resource code
Throws:
PortalException - if a resource code with the primary key could not be found
SystemException - if a system exception occurred

getResourceCodes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ResourceCode> getResourceCodes(int start,
                                                                             int end)
                                    throws SystemException
Gets a range of all the resource codes.

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 resource codes to return
end - the upper bound of the range of resource codes to return (not inclusive)
Returns:
the range of resource codes
Throws:
SystemException - if a system exception occurred

getResourceCodesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getResourceCodesCount()
                          throws SystemException
Gets the number of resource codes.

Returns:
the number of resource codes
Throws:
SystemException - if a system exception occurred

updateResourceCode

ResourceCode updateResourceCode(ResourceCode resourceCode)
                                throws SystemException
Updates the resource code in the database. Also notifies the appropriate model listeners.

Parameters:
resourceCode - the resource code to update
Returns:
the resource code that was updated
Throws:
SystemException - if a system exception occurred

updateResourceCode

ResourceCode updateResourceCode(ResourceCode resourceCode,
                                boolean merge)
                                throws SystemException
Updates the resource code in the database. Also notifies the appropriate model listeners.

Parameters:
resourceCode - the resource code to update
merge - whether to merge the resource code 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 resource code that was updated
Throws:
SystemException - if a system exception occurred

addResourceCode

ResourceCode addResourceCode(long companyId,
                             String name,
                             int scope)
                             throws SystemException
Throws:
SystemException

checkResourceCodes

void checkResourceCodes()
                        throws SystemException
Throws:
SystemException

checkResourceCodes

void checkResourceCodes(long companyId,
                        String name)
                        throws SystemException
Throws:
SystemException

getResourceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ResourceCode getResourceCode(long companyId,
                                                                      String name,
                                                                      int scope)
                             throws SystemException
Throws:
SystemException

Liferay 6.0.5