public class ObjectDefinitionLocalServiceUtil
extends java.lang.Object
com.liferay.object.service.impl.ObjectDefinitionLocalServiceImpl
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.ObjectDefinitionLocalService
Constructor and Description |
---|
ObjectDefinitionLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static ObjectDefinition |
addCustomObjectDefinition(long userId,
boolean enableComments,
boolean enableLocalization,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.lang.String name,
java.lang.String panelAppOrder,
java.lang.String panelCategoryKey,
java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap,
java.lang.String scope,
java.lang.String storageType,
java.util.List<ObjectField> objectFields) |
static ObjectDefinition |
addObjectDefinition(ObjectDefinition objectDefinition)
Adds the object definition to the database.
|
static ObjectDefinition |
addObjectDefinition(java.lang.String externalReferenceCode,
long userId) |
static ObjectDefinition |
addOrUpdateSystemObjectDefinition(long companyId,
SystemObjectDefinitionManager systemObjectDefinitionManager) |
static ObjectDefinition |
addSystemObjectDefinition(long userId,
java.lang.String className,
java.lang.String dbTableName,
boolean enableComments,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
boolean modifiable,
java.lang.String name,
java.lang.String panelAppOrder,
java.lang.String panelCategoryKey,
java.lang.String pkObjectFieldDBColumnName,
java.lang.String pkObjectFieldName,
java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap,
java.lang.String scope,
java.lang.String titleObjectFieldName,
int version,
int status,
java.util.List<ObjectField> objectFields) |
static ObjectDefinition |
createObjectDefinition(long objectDefinitionId)
Creates a new object definition with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static void |
deleteCompanyObjectDefinitions(long companyId) |
static ObjectDefinition |
deleteObjectDefinition(long objectDefinitionId)
Deletes the object definition with the primary key from the database.
|
static ObjectDefinition |
deleteObjectDefinition(ObjectDefinition objectDefinition)
Deletes the object definition from the database.
|
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static void |
deployObjectDefinition(ObjectDefinition objectDefinition) |
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 ObjectDefinition |
enableAccountEntryRestricted(ObjectRelationship objectRelationship) |
static ObjectDefinition |
fetchObjectDefinition(long objectDefinitionId) |
static ObjectDefinition |
fetchObjectDefinition(long companyId,
java.lang.String name) |
static ObjectDefinition |
fetchObjectDefinitionByClassName(long companyId,
java.lang.String className) |
static ObjectDefinition |
fetchObjectDefinitionByExternalReferenceCode(java.lang.String externalReferenceCode,
long companyId) |
static ObjectDefinition |
fetchObjectDefinitionByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the object definition with the matching UUID and company.
|
static ObjectDefinition |
fetchSystemObjectDefinition(java.lang.String name) |
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static java.util.List<ObjectDefinition> |
getCustomObjectDefinitions(int status) |
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 java.util.List<ObjectDefinition> |
getModifiableObjectDefinitions(long companyId,
boolean active,
int status) |
static ObjectDefinition |
getObjectDefinition(long objectDefinitionId)
Returns the object definition with the primary key.
|
static ObjectDefinition |
getObjectDefinitionByExternalReferenceCode(java.lang.String externalReferenceCode,
long companyId) |
static ObjectDefinition |
getObjectDefinitionByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the object definition with the matching UUID and company.
|
static java.util.List<ObjectDefinition> |
getObjectDefinitions(int start,
int end)
Returns a range of all the object definitions.
|
static java.util.List<ObjectDefinition> |
getObjectDefinitions(long companyId,
boolean active,
boolean system,
int status) |
static java.util.List<ObjectDefinition> |
getObjectDefinitions(long companyId,
boolean active,
int status) |
static int |
getObjectDefinitionsCount()
Returns the number of object definitions.
|
static int |
getObjectDefinitionsCount(long companyId) |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static ObjectDefinitionLocalService |
getService() |
static java.util.List<ObjectDefinition> |
getSystemObjectDefinitions() |
static boolean |
hasObjectRelationship(long objectDefinitionId) |
static ObjectDefinition |
publishCustomObjectDefinition(long userId,
long objectDefinitionId) |
static ObjectDefinition |
publishSystemObjectDefinition(long userId,
long objectDefinitionId) |
static void |
setService(ObjectDefinitionLocalService service) |
static void |
undeployObjectDefinition(ObjectDefinition objectDefinition) |
static ObjectDefinition |
updateCustomObjectDefinition(java.lang.String externalReferenceCode,
long objectDefinitionId,
long accountEntryRestrictedObjectFieldId,
long descriptionObjectFieldId,
long titleObjectFieldId,
boolean accountEntryRestricted,
boolean active,
boolean enableCategorization,
boolean enableComments,
boolean enableLocalization,
boolean enableObjectEntryHistory,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.lang.String name,
java.lang.String panelAppOrder,
java.lang.String panelCategoryKey,
boolean portlet,
java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap,
java.lang.String scope) |
static ObjectDefinition |
updateExternalReferenceCode(long objectDefinitionId,
java.lang.String externalReferenceCode) |
static ObjectDefinition |
updateObjectDefinition(ObjectDefinition objectDefinition)
Updates the object definition in the database or adds it if it does not yet exist.
|
static ObjectDefinition |
updateSystemObjectDefinition(java.lang.String externalReferenceCode,
long objectDefinitionId,
long titleObjectFieldId) |
static ObjectDefinition |
updateTitleObjectFieldId(long objectDefinitionId,
long titleObjectFieldId) |
public static ObjectDefinition addCustomObjectDefinition(long userId, boolean enableComments, boolean enableLocalization, java.util.Map<java.util.Locale,java.lang.String> labelMap, java.lang.String name, java.lang.String panelAppOrder, java.lang.String panelCategoryKey, java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap, java.lang.String scope, java.lang.String storageType, java.util.List<ObjectField> objectFields) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition addObjectDefinition(ObjectDefinition objectDefinition)
Important: Inspect ObjectDefinitionLocalServiceImpl 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.
objectDefinition
- the object definitionpublic static ObjectDefinition addObjectDefinition(java.lang.String externalReferenceCode, long userId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition addOrUpdateSystemObjectDefinition(long companyId, SystemObjectDefinitionManager systemObjectDefinitionManager) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition addSystemObjectDefinition(long userId, java.lang.String className, java.lang.String dbTableName, boolean enableComments, java.util.Map<java.util.Locale,java.lang.String> labelMap, boolean modifiable, java.lang.String name, java.lang.String panelAppOrder, java.lang.String panelCategoryKey, java.lang.String pkObjectFieldDBColumnName, java.lang.String pkObjectFieldName, java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap, java.lang.String scope, java.lang.String titleObjectFieldName, int version, int status, java.util.List<ObjectField> objectFields) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition createObjectDefinition(long objectDefinitionId)
objectDefinitionId
- the primary key for the new object definitionpublic 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 void deleteCompanyObjectDefinitions(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition deleteObjectDefinition(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect ObjectDefinitionLocalServiceImpl 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.
objectDefinitionId
- the primary key of the object definitioncom.liferay.portal.kernel.exception.PortalException
- if a object definition with the primary key could not be foundpublic static ObjectDefinition deleteObjectDefinition(ObjectDefinition objectDefinition) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect ObjectDefinitionLocalServiceImpl 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.
objectDefinition
- the object definitioncom.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 void deployObjectDefinition(ObjectDefinition objectDefinition)
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.ObjectDefinitionModelImpl
.
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.ObjectDefinitionModelImpl
.
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 ObjectDefinition enableAccountEntryRestricted(ObjectRelationship objectRelationship) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition fetchObjectDefinition(long objectDefinitionId)
public static ObjectDefinition fetchObjectDefinition(long companyId, java.lang.String name)
public static ObjectDefinition fetchObjectDefinitionByClassName(long companyId, java.lang.String className)
public static ObjectDefinition fetchObjectDefinitionByExternalReferenceCode(java.lang.String externalReferenceCode, long companyId)
public static ObjectDefinition fetchObjectDefinitionByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the object definition's UUIDcompanyId
- the primary key of the companynull
if a matching object definition could not be foundpublic static ObjectDefinition fetchSystemObjectDefinition(java.lang.String name)
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static java.util.List<ObjectDefinition> getCustomObjectDefinitions(int status)
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 java.util.List<ObjectDefinition> getModifiableObjectDefinitions(long companyId, boolean active, int status)
public static ObjectDefinition getObjectDefinition(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
objectDefinitionId
- the primary key of the object definitioncom.liferay.portal.kernel.exception.PortalException
- if a object definition with the primary key could not be foundpublic static ObjectDefinition getObjectDefinitionByExternalReferenceCode(java.lang.String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition getObjectDefinitionByUuidAndCompanyId(java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the object definition's UUIDcompanyId
- the primary key of the companycom.liferay.portal.kernel.exception.PortalException
- if a matching object definition could not be foundpublic static java.util.List<ObjectDefinition> getObjectDefinitions(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.ObjectDefinitionModelImpl
.
start
- the lower bound of the range of object definitionsend
- the upper bound of the range of object definitions (not inclusive)public static java.util.List<ObjectDefinition> getObjectDefinitions(long companyId, boolean active, boolean system, int status)
public static java.util.List<ObjectDefinition> getObjectDefinitions(long companyId, boolean active, int status)
public static int getObjectDefinitionsCount()
public static int getObjectDefinitionsCount(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
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 java.util.List<ObjectDefinition> getSystemObjectDefinitions()
public static boolean hasObjectRelationship(long objectDefinitionId)
public static ObjectDefinition publishCustomObjectDefinition(long userId, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition publishSystemObjectDefinition(long userId, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void undeployObjectDefinition(ObjectDefinition objectDefinition)
public static ObjectDefinition updateCustomObjectDefinition(java.lang.String externalReferenceCode, long objectDefinitionId, long accountEntryRestrictedObjectFieldId, long descriptionObjectFieldId, long titleObjectFieldId, boolean accountEntryRestricted, boolean active, boolean enableCategorization, boolean enableComments, boolean enableLocalization, boolean enableObjectEntryHistory, java.util.Map<java.util.Locale,java.lang.String> labelMap, java.lang.String name, java.lang.String panelAppOrder, java.lang.String panelCategoryKey, boolean portlet, java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap, java.lang.String scope) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition updateExternalReferenceCode(long objectDefinitionId, java.lang.String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition updateObjectDefinition(ObjectDefinition objectDefinition)
Important: Inspect ObjectDefinitionLocalServiceImpl 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.
objectDefinition
- the object definitionpublic static ObjectDefinition updateSystemObjectDefinition(java.lang.String externalReferenceCode, long objectDefinitionId, long titleObjectFieldId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinition updateTitleObjectFieldId(long objectDefinitionId, long titleObjectFieldId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static ObjectDefinitionLocalService getService()
public static void setService(ObjectDefinitionLocalService service)