public class ObjectFieldLocalServiceUtil
extends java.lang.Object
com.liferay.object.service.impl.ObjectFieldLocalServiceImpl
and
is an 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.ObjectFieldLocalService
Constructor and Description |
---|
ObjectFieldLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static ObjectField |
addCustomObjectField(long userId,
long listTypeDefinitionId,
long objectDefinitionId,
java.lang.String businessType,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.lang.String name,
boolean required,
java.util.List<ObjectFieldSetting> objectFieldSettings) |
static ObjectField |
addObjectField(ObjectField objectField)
Adds the object field to the database.
|
static ObjectField |
addSystemObjectField(long userId,
long objectDefinitionId,
java.lang.String businessType,
java.lang.String dbColumnName,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.lang.String name,
boolean required) |
static ObjectField |
createObjectField(long objectFieldId)
Creates a new object field with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static ObjectField |
deleteObjectField(long objectFieldId)
Deletes the object field with the primary key from the database.
|
static ObjectField |
deleteObjectField(ObjectField objectField)
Deletes the object field from the database.
|
static void |
deleteObjectFieldByObjectDefinitionId(java.lang.Long objectDefinitionId) |
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static ObjectField |
deleteRelationshipTypeObjectField(long objectFieldId) |
static <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
Returns the number of rows matching the dynamic query.
|
static ObjectField |
fetchObjectField(long objectFieldId) |
static ObjectField |
fetchObjectField(long objectDefinitionId,
java.lang.String name) |
static ObjectField |
fetchObjectFieldByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the object field with the matching UUID and company.
|
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static java.util.List<ObjectField> |
getActiveObjectFields(java.util.List<ObjectField> objectFields) |
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static ObjectField |
getObjectField(long objectFieldId)
Returns the object field with the primary key.
|
static ObjectField |
getObjectField(long objectDefinitionId,
java.lang.String name) |
static ObjectField |
getObjectFieldByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the object field with the matching UUID and company.
|
static java.util.List<ObjectField> |
getObjectFields(int start,
int end)
Returns a range of all the object fields.
|
static java.util.List<ObjectField> |
getObjectFields(long objectDefinitionId) |
static java.util.List<ObjectField> |
getObjectFields(long objectDefinitionId,
java.lang.String dbTableName) |
static int |
getObjectFieldsCount()
Returns the number of object fields.
|
static int |
getObjectFieldsCount(long objectDefinitionId) |
static int |
getObjectFieldsCountByListTypeDefinitionId(long listTypeDefinitionId) |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static ObjectFieldLocalService |
getService() |
static ObjectField |
updateCustomObjectField(long objectFieldId,
long listTypeDefinitionId,
java.lang.String businessType,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.lang.String name,
boolean required,
java.util.List<ObjectFieldSetting> objectFieldSettings) |
static ObjectField |
updateObjectField(ObjectField objectField)
Updates the object field in the database or adds it if it does not yet exist.
|
public static ObjectField addCustomObjectField(long userId, long listTypeDefinitionId, long objectDefinitionId, java.lang.String businessType, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, java.lang.String name, boolean required, java.util.List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectField addObjectField(ObjectField objectField)
Important: Inspect ObjectFieldLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
objectField
- the object fieldpublic static ObjectField addSystemObjectField(long userId, long objectDefinitionId, java.lang.String businessType, java.lang.String dbColumnName, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, java.lang.String name, boolean required) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectField createObjectField(long objectFieldId)
objectFieldId
- the primary key for the new object fieldpublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectField deleteObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect ObjectFieldLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
objectFieldId
- the primary key of the object fieldcom.liferay.portal.kernel.exception.PortalException
- if a object field with the primary key could not be foundpublic static ObjectField deleteObjectField(ObjectField objectField) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect ObjectFieldLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
objectField
- the object fieldcom.liferay.portal.kernel.exception.PortalException
public static void deleteObjectFieldByObjectDefinitionId(java.lang.Long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectField deleteRelationshipTypeObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFieldModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFieldModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static ObjectField fetchObjectField(long objectFieldId)
public static ObjectField fetchObjectField(long objectDefinitionId, java.lang.String name)
public static ObjectField fetchObjectFieldByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the object field's UUIDcompanyId
- the primary key of the companynull
if a matching object field could not be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static java.util.List<ObjectField> getActiveObjectFields(java.util.List<ObjectField> objectFields) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static ObjectField getObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
objectFieldId
- the primary key of the object fieldcom.liferay.portal.kernel.exception.PortalException
- if a object field with the primary key could not be foundpublic static ObjectField getObjectField(long objectDefinitionId, java.lang.String name) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectField getObjectFieldByUuidAndCompanyId(java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the object field's UUIDcompanyId
- the primary key of the companycom.liferay.portal.kernel.exception.PortalException
- if a matching object field could not be foundpublic static java.util.List<ObjectField> getObjectFields(int start, int end)
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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFieldModelImpl
.
start
- the lower bound of the range of object fieldsend
- the upper bound of the range of object fields (not inclusive)public static java.util.List<ObjectField> getObjectFields(long objectDefinitionId)
public static java.util.List<ObjectField> getObjectFields(long objectDefinitionId, java.lang.String dbTableName)
public static int getObjectFieldsCount()
public static int getObjectFieldsCount(long objectDefinitionId)
public static int getObjectFieldsCountByListTypeDefinitionId(long listTypeDefinitionId)
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectField updateCustomObjectField(long objectFieldId, long listTypeDefinitionId, java.lang.String businessType, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, java.lang.String name, boolean required, java.util.List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectField updateObjectField(ObjectField objectField)
Important: Inspect ObjectFieldLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
objectField
- the object fieldpublic static ObjectFieldLocalService getService()