@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DDLRecordSetService
extends com.liferay.portal.kernel.service.BaseService
DDLRecordSetServiceUtil
,
com.liferay.dynamic.data.lists.service.base.DDLRecordSetServiceBaseImpl
,
com.liferay.dynamic.data.lists.service.impl.DDLRecordSetServiceImpl
Modifier and Type | Method and Description |
---|---|
DDLRecordSet |
addRecordSet(long groupId,
long ddmStructureId,
java.lang.String recordSetKey,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int minDisplayRows,
int scope,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a record set referencing the DDM structure.
|
void |
deleteRecordSet(long recordSetId)
Deletes a record set and its resources.
|
DDLRecordSet |
fetchRecordSet(long recordSetId)
Returns a record set with the ID.
|
java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
DDLRecordSet |
getRecordSet(long recordSetId)
Returns a record set with the ID.
|
java.util.List<DDLRecordSet> |
getRecordSets(long[] groupIds)
Returns all the record sets matching the groups, filtered by the user's
VIEW permission. |
java.util.List<DDLRecordSet> |
search(long companyId,
long groupId,
java.lang.String keywords,
int scope,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator)
Returns a range of all record sets matching the parameters, filtered by
the user's
VIEW permission. |
java.util.List<DDLRecordSet> |
search(long companyId,
long groupId,
java.lang.String name,
java.lang.String description,
int scope,
boolean andOperator,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator)
Returns an ordered range of record sets, filtered by the user's
VIEW permission. |
int |
searchCount(long companyId,
long groupId,
java.lang.String keywords,
int scope)
Returns the number of record sets matching the parameters, filtered by
the user's
VIEW permission. |
int |
searchCount(long companyId,
long groupId,
java.lang.String name,
java.lang.String description,
int scope,
boolean andOperator)
Returns the number of all record sets matching the parameters, filtered
by the user's
VIEW permission. |
DDLRecordSet |
updateMinDisplayRows(long recordSetId,
int minDisplayRows,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the number of minimum rows to display for the record set.
|
DDLRecordSet |
updateRecordSet(long recordSetId,
DDMFormValues settingsDDMFormValues)
Updates the the record set's settings.
|
DDLRecordSet |
updateRecordSet(long recordSetId,
long ddmStructureId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int minDisplayRows,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the DDM structure, name, description, and minimum number of
display rows for the record set matching the record set ID.
|
DDLRecordSet |
updateRecordSet(long groupId,
long ddmStructureId,
java.lang.String recordSetKey,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int minDisplayRows,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the DDM structure, name, description, and minimum number of
display rows for the record set matching the group ID and record set key.
|
DDLRecordSet addRecordSet(long groupId, long ddmStructureId, java.lang.String recordSetKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int minDisplayRows, int scope, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the record set's groupddmStructureId
- the primary key of the record set's DDM structurerecordSetKey
- the mnemonic primary key of the record set. If
null
, the record set key will be autogenerated.nameMap
- the record set's locales and localized namesdescriptionMap
- the record set's locales and localized
descriptionsminDisplayRows
- the record set's minimum number of rows to be
displayed in spreadsheet viewscope
- the record set's scope, used to scope the record set's
data. For more information search
DDLRecordSetConstants
in the
dynamic.data.lists.api
module for constants starting
with the "SCOPE_" prefix.serviceContext
- serviceContext the service context to be applied.
This can set the UUID, guest permissions, and group permissions
for the record set.com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurredvoid deleteRecordSet(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException
recordSetId
- the primary key of the record setcom.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) DDLRecordSet fetchRecordSet(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException
recordSetId
- the primary key of the record setnull
if the matching
record set is not foundcom.liferay.portal.kernel.exception.PortalException
- if a portal exception occurredjava.lang.String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) DDLRecordSet getRecordSet(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException
recordSetId
- the primary key of the record setcom.liferay.portal.kernel.exception.PortalException
- if a matching record set could not be found or if
the user did not have the required permission to access the
record set@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<DDLRecordSet> getRecordSets(long[] groupIds)
VIEW
permission.groupIds
- the primary keys of the record set's groups@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<DDLRecordSet> search(long companyId, long groupId, java.lang.String keywords, int scope, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator)
VIEW
permission. The keywords parameter is used
for matching String values to the record set's name or description.
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.
companyId
- the primary key of the record set's companygroupId
- the primary key of the record set's groupkeywords
- the keywords (space separated), which my occur in the
record set name or description (optionally null
). If
the keywords value is not null
, the search uses the
OR operator in connecting query criteria; otherwise it uses the
AND operator.scope
- the record set's scope. Constant used to scope the record
set's data. For more information search the
dynamic.data.lists.api
module's
DDLRecordSetConstants
class for constants prefixed
with "SCOPE_".start
- the lower bound of the range of record sets to returnend
- the upper bound of the range of record sets to return (not
inclusive)orderByComparator
- the comparator to order the record sets@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<DDLRecordSet> search(long companyId, long groupId, java.lang.String name, java.lang.String description, int scope, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator)
VIEW
permission. Company ID and group ID must be matched. If
the and operator is set to true
, only record sets with a
matching name, description, and scope are returned. If the and operator
is set to false
, only one parameter of name, description,
and scope is needed to return matching record sets.
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.
companyId
- the primary key of the record set's companygroupId
- the primary key of the record set's groupname
- the name keywords (space separated, optionally
null
)description
- the description keywords (space separated, optionally
null
)scope
- the record set's scope. Constant used to scope the record
set's data. For more information search the
dynamic.data.lists.api
module's
DDLRecordSetConstants
class for constants prefixed
with "SCOPE_".andOperator
- whether every field must match its value or keywords,
or just one field must match. Company and group must match their
values.start
- the lower bound of the range of record sets to returnend
- the upper bound of the range of record sets to return (not
inclusive)orderByComparator
- the comparator to order the record sets@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long groupId, java.lang.String keywords, int scope)
VIEW
permission. The keywords parameter is used
for matching record set names or descriptions.companyId
- the primary key of the record set's companygroupId
- the primary key of the record set's group.keywords
- the keywords (space separated) to look for and match in
the record set name or description (optionally
null
). If the keywords value is not
null
, the OR operator is used in connecting query
criteria; otherwise it uses the AND operator.scope
- the record set's scope. A constant used to scope the record
set's data. For more information search the
dynamic.data.lists.api
module's
DDLRecordSetConstants
class for constants prefixed
with "SCOPE_".@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long groupId, java.lang.String name, java.lang.String description, int scope, boolean andOperator)
VIEW
permission. If the and operator is set to
true
, only record sets with a matching name, description,
and scope are counted. If the and operator is set to false
,
only one parameter of name, description, and scope is needed to count
matching record sets.companyId
- the primary key of the record set's companygroupId
- the primary key of the record set's groupname
- the name keywords (space separated). This can be
null
.description
- the description keywords (space separated). Can be
null
.scope
- the record set's scope. A constant used to scope the record
set's data. For more information search the
dynamic.data.lists.api
module's
DDLRecordSetConstants
class for constants prefixed
with "SCOPE_".andOperator
- whether every field must match its value or keywords,
or just one field must match. Company and group must match their
values.DDLRecordSet updateMinDisplayRows(long recordSetId, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
recordSetId
- the primary key of the record setminDisplayRows
- the record set's minimum number of rows to be
displayed in spreadsheet viewserviceContext
- the service context to be applied. This can set
the record set modified date.com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurredDDLRecordSet updateRecordSet(long recordSetId, DDMFormValues settingsDDMFormValues) throws com.liferay.portal.kernel.exception.PortalException
recordSetId
- the primary key of the record setsettingsDDMFormValues
- the record set's settings. For more
information see DDMFormValues
in the
dynamic.data.mapping.api
module.com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurredDDLRecordSet updateRecordSet(long recordSetId, long ddmStructureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
recordSetId
- the primary key of the record setddmStructureId
- the primary key of the record set's DDM structurenameMap
- the record set's locales and localized namesdescriptionMap
- the record set's locales and localized
descriptionsminDisplayRows
- the record set's minimum number of rows to be
displayed in spreadsheet view.serviceContext
- the service context to be applied. Can set the
record set modified date.com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurredDDLRecordSet updateRecordSet(long groupId, long ddmStructureId, java.lang.String recordSetKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the record set's groupddmStructureId
- the primary key of the record set's DDM structurerecordSetKey
- the record set's mnemonic primary keynameMap
- the record set's locales and localized namesdescriptionMap
- the record set's locales and localized
descriptionsminDisplayRows
- the record set's minimum number of rows to be
displayed in spreadsheet viewserviceContext
- the service context to be applied. This can set
the record set modified date.com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred