Package com.liferay.object.model
Interface ObjectActionModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<ObjectAction>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<ObjectAction>
,com.liferay.portal.kernel.model.ExternalReferenceCodeModel
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.StagedAuditedModel
,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
ObjectAction
- All Known Implementing Classes:
ObjectActionWrapper
@ProviderType
public interface ObjectActionModel
extends com.liferay.portal.kernel.model.BaseModel<ObjectAction>, com.liferay.portal.kernel.model.ExternalReferenceCodeModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
The base model interface for the ObjectAction service. Represents a row in the "ObjectAction" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.object.model.impl.ObjectActionModelImpl
exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.object.model.impl.ObjectActionImpl
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the active of this object action.String[]
long
Returns the company ID of this object action.Returns the condition expression of this object action.Returns the create date of this object action.Returns the description of this object action.Returns the error message of this object action.getErrorMessage
(String languageId) Returns the localized error message of this object action in the language.getErrorMessage
(String languageId, boolean useDefault) Returns the localized error message of this object action in the language, optionally using the default language if no localization exists for the requested language.getErrorMessage
(Locale locale) Returns the localized error message of this object action in the language.getErrorMessage
(Locale locale, boolean useDefault) Returns the localized error message of this object action in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized error messages of this object action.Returns the external reference code of this object action.getLabel()
Returns the label of this object action.Returns the localized label of this object action in the language.Returns the localized label of this object action in the language, optionally using the default language if no localization exists for the requested language.Returns the localized label of this object action in the language.Returns the localized label of this object action in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized labels of this object action.Returns the modified date of this object action.long
Returns the mvcc version of this object action.getName()
Returns the name of this object action.Returns the object action executor key of this object action.long
Returns the object action ID of this object action.Returns the object action trigger key of this object action.long
Returns the object definition ID of this object action.Returns the parameters of this object action.long
Returns the primary key of this object action.int
Returns the status of this object action.boolean
Returns the system of this object action.long
Returns the user ID of this object action.Returns the user name of this object action.Returns the user uuid of this object action.getUuid()
Returns the uuid of this object action.boolean
isActive()
Returnstrue
if this object action is active.boolean
isSystem()
Returnstrue
if this object action is system.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setActive
(boolean active) Sets whether this object action is active.void
setCompanyId
(long companyId) Sets the company ID of this object action.void
setConditionExpression
(String conditionExpression) Sets the condition expression of this object action.void
setCreateDate
(Date createDate) Sets the create date of this object action.void
setDescription
(String description) Sets the description of this object action.void
setErrorMessage
(String errorMessage) Sets the error message of this object action.void
setErrorMessage
(String errorMessage, Locale locale) Sets the localized error message of this object action in the language.void
setErrorMessage
(String errorMessage, Locale locale, Locale defaultLocale) Sets the localized error message of this object action in the language, and sets the default locale.void
setErrorMessageCurrentLanguageId
(String languageId) void
setErrorMessageMap
(Map<Locale, String> errorMessageMap) Sets the localized error messages of this object action from the map of locales and localized error messages.void
setErrorMessageMap
(Map<Locale, String> errorMessageMap, Locale defaultLocale) Sets the localized error messages of this object action from the map of locales and localized error messages, and sets the default locale.void
setExternalReferenceCode
(String externalReferenceCode) Sets the external reference code of this object action.void
Sets the label of this object action.void
Sets the localized label of this object action in the language.void
Sets the localized label of this object action in the language, and sets the default locale.void
setLabelCurrentLanguageId
(String languageId) void
setLabelMap
(Map<Locale, String> labelMap) Sets the localized labels of this object action from the map of locales and localized labels.void
setLabelMap
(Map<Locale, String> labelMap, Locale defaultLocale) Sets the localized labels of this object action from the map of locales and localized labels, and sets the default locale.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this object action.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this object action.void
Sets the name of this object action.void
setObjectActionExecutorKey
(String objectActionExecutorKey) Sets the object action executor key of this object action.void
setObjectActionId
(long objectActionId) Sets the object action ID of this object action.void
setObjectActionTriggerKey
(String objectActionTriggerKey) Sets the object action trigger key of this object action.void
setObjectDefinitionId
(long objectDefinitionId) Sets the object definition ID of this object action.void
setParameters
(String parameters) Sets the parameters of this object action.void
setPrimaryKey
(long primaryKey) Sets the primary key of this object action.void
setStatus
(int status) Sets the status of this object action.void
setSystem
(boolean system) Sets whether this object action is system.void
setUserId
(long userId) Sets the user ID of this object action.void
setUserName
(String userName) Sets the user name of this object action.void
setUserUuid
(String userUuid) Sets the user uuid of this object action.void
Sets the uuid of this object action.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this object action.- Returns:
- the primary key of this object action
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this object action.- Parameters:
primaryKey
- the primary key of this object action
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this object action.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this object action
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this object action.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this object action
-
getUuid
Returns the uuid of this object action.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this object action
-
setUuid
Sets the uuid of this object action.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this object action
-
getExternalReferenceCode
Returns the external reference code of this object action.- Specified by:
getExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Returns:
- the external reference code of this object action
-
setExternalReferenceCode
Sets the external reference code of this object action.- Specified by:
setExternalReferenceCode
in interfacecom.liferay.portal.kernel.model.ExternalReferenceCodeModel
- Parameters:
externalReferenceCode
- the external reference code of this object action
-
getObjectActionId
long getObjectActionId()Returns the object action ID of this object action.- Returns:
- the object action ID of this object action
-
setObjectActionId
void setObjectActionId(long objectActionId) Sets the object action ID of this object action.- Parameters:
objectActionId
- the object action ID of this object action
-
getCompanyId
long getCompanyId()Returns the company ID of this object action.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the company ID of this object action
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this object action.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
companyId
- the company ID of this object action
-
getUserId
long getUserId()Returns the user ID of this object action.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this object action
-
setUserId
void setUserId(long userId) Sets the user ID of this object action.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this object action
-
getUserUuid
String getUserUuid()Returns the user uuid of this object action.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this object action
-
setUserUuid
Sets the user uuid of this object action.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this object action
-
getUserName
Returns the user name of this object action.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this object action
-
setUserName
Sets the user name of this object action.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this object action
-
getCreateDate
Date getCreateDate()Returns the create date of this object action.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this object action
-
setCreateDate
Sets the create date of this object action.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
createDate
- the create date of this object action
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this object action.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this object action
-
setModifiedDate
Sets the modified date of this object action.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this object action
-
getObjectDefinitionId
long getObjectDefinitionId()Returns the object definition ID of this object action.- Returns:
- the object definition ID of this object action
-
setObjectDefinitionId
void setObjectDefinitionId(long objectDefinitionId) Sets the object definition ID of this object action.- Parameters:
objectDefinitionId
- the object definition ID of this object action
-
getActive
boolean getActive()Returns the active of this object action.- Returns:
- the active of this object action
-
isActive
boolean isActive()Returnstrue
if this object action is active.- Returns:
true
if this object action is active;false
otherwise
-
setActive
void setActive(boolean active) Sets whether this object action is active.- Parameters:
active
- the active of this object action
-
getConditionExpression
Returns the condition expression of this object action.- Returns:
- the condition expression of this object action
-
setConditionExpression
Sets the condition expression of this object action.- Parameters:
conditionExpression
- the condition expression of this object action
-
getDescription
Returns the description of this object action.- Returns:
- the description of this object action
-
setDescription
Sets the description of this object action.- Parameters:
description
- the description of this object action
-
getErrorMessage
String getErrorMessage()Returns the error message of this object action.- Returns:
- the error message of this object action
-
getErrorMessage
Returns the localized error message of this object action in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale
- the locale of the language- Returns:
- the localized error message of this object action
-
getErrorMessage
Returns the localized error message of this object action in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized error message of this object action. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getErrorMessage
Returns the localized error message of this object action in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the language- Returns:
- the localized error message of this object action
-
getErrorMessage
Returns the localized error message of this object action in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized error message of this object action
-
getErrorMessageCurrentLanguageId
-
getErrorMessageCurrentValue
-
getErrorMessageMap
Returns a map of the locales and localized error messages of this object action.- Returns:
- the locales and localized error messages of this object action
-
setErrorMessage
Sets the error message of this object action.- Parameters:
errorMessage
- the error message of this object action
-
setErrorMessage
Sets the localized error message of this object action in the language.- Parameters:
errorMessage
- the localized error message of this object actionlocale
- the locale of the language
-
setErrorMessage
Sets the localized error message of this object action in the language, and sets the default locale.- Parameters:
errorMessage
- the localized error message of this object actionlocale
- the locale of the languagedefaultLocale
- the default locale
-
setErrorMessageCurrentLanguageId
-
setErrorMessageMap
Sets the localized error messages of this object action from the map of locales and localized error messages.- Parameters:
errorMessageMap
- the locales and localized error messages of this object action
-
setErrorMessageMap
Sets the localized error messages of this object action from the map of locales and localized error messages, and sets the default locale.- Parameters:
errorMessageMap
- the locales and localized error messages of this object actiondefaultLocale
- the default locale
-
getLabel
String getLabel()Returns the label of this object action.- Returns:
- the label of this object action
-
getLabel
Returns the localized label of this object action in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale
- the locale of the language- Returns:
- the localized label of this object action
-
getLabel
Returns the localized label of this object action in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized label of this object action. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getLabel
Returns the localized label of this object action in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the language- Returns:
- the localized label of this object action
-
getLabel
Returns the localized label of this object action in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized label of this object action
-
getLabelCurrentLanguageId
-
getLabelCurrentValue
-
getLabelMap
Returns a map of the locales and localized labels of this object action.- Returns:
- the locales and localized labels of this object action
-
setLabel
Sets the label of this object action.- Parameters:
label
- the label of this object action
-
setLabel
Sets the localized label of this object action in the language.- Parameters:
label
- the localized label of this object actionlocale
- the locale of the language
-
setLabel
Sets the localized label of this object action in the language, and sets the default locale.- Parameters:
label
- the localized label of this object actionlocale
- the locale of the languagedefaultLocale
- the default locale
-
setLabelCurrentLanguageId
-
setLabelMap
Sets the localized labels of this object action from the map of locales and localized labels.- Parameters:
labelMap
- the locales and localized labels of this object action
-
setLabelMap
Sets the localized labels of this object action from the map of locales and localized labels, and sets the default locale.- Parameters:
labelMap
- the locales and localized labels of this object actiondefaultLocale
- the default locale
-
getName
Returns the name of this object action.- Returns:
- the name of this object action
-
setName
Sets the name of this object action.- Parameters:
name
- the name of this object action
-
getObjectActionExecutorKey
Returns the object action executor key of this object action.- Returns:
- the object action executor key of this object action
-
setObjectActionExecutorKey
Sets the object action executor key of this object action.- Parameters:
objectActionExecutorKey
- the object action executor key of this object action
-
getObjectActionTriggerKey
Returns the object action trigger key of this object action.- Returns:
- the object action trigger key of this object action
-
setObjectActionTriggerKey
Sets the object action trigger key of this object action.- Parameters:
objectActionTriggerKey
- the object action trigger key of this object action
-
getParameters
Returns the parameters of this object action.- Returns:
- the parameters of this object action
-
setParameters
Sets the parameters of this object action.- Parameters:
parameters
- the parameters of this object action
-
getSystem
boolean getSystem()Returns the system of this object action.- Returns:
- the system of this object action
-
isSystem
boolean isSystem()Returnstrue
if this object action is system.- Returns:
true
if this object action is system;false
otherwise
-
setSystem
void setSystem(boolean system) Sets whether this object action is system.- Parameters:
system
- the system of this object action
-
getStatus
int getStatus()Returns the status of this object action.- Returns:
- the status of this object action
-
setStatus
void setStatus(int status) Sets the status of this object action.- Parameters:
status
- the status of this object action
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
ObjectAction cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<ObjectAction>
-
toXmlString
-