Package org.cyclos.model

Class Bean

java.lang.Object

org.cyclos.model.Bean

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractViewProfileData, AcceptedAgreementVO, AccessClientActionParams, AccessClientDataParams, AccessClientsActivationData, AccessClientTypeData, AccessibleSystemImageCategoriesData, AccountBalanceHistoryParams, AccountBalanceHistoryVO, AccountFeeLogData, AccountHistoriesOverviewStatusVO, AccountLimitsOverviewData, AccountPermissionsData, AccountStatusVO, ActionWithConfirmationPassword, ActivateAccessClientDTO, ActivateGiftVoucherDTO, ActivateTotpData, ActivateTrustedDeviceData, ActivateTrustedDeviceDTO, ActiveChannelConfigurationData, ActiveConfigurationData, ActiveProductsData, ActiveUserAccountData, ActivitiesData, AdAddressDataParams, AdCustomFieldActions, AdDataParams, AddBrokerData, AddressConfigurationData, AddressConfigurationDTO, AddressListData, AdWebShopSettingData, AdWebShopSettingDTO, AgreementContentVO, AmountSummaryVO, ApplicationProperty, ApplicationTranslationData, ApplyThemesDTO, ApproveTicketDTO, ArchivedAccountHistoryVO, ArchivedTransferData, ArchivingInfoVO, AssignVoucherDTO, BalanceEntryVO, BannerDataParams, BannersListData, BarcodeParams, BaseAccountLimitDTO, BaseAccountLimitVO, BaseGetVersionedDataParams, BasePaymentOwnerData, BaseTaskData, BaseUserRegistrationResult, BasicChangeGroupData, BasicInitializationData, BasicLicenseVO, BasicNetworkInitialDataDTO, BasicProfileActionsData, BasicTranslationKeyDTO, BasicVoucherData, BrokeringData, BulkActionDataParams, BulkActionSearchUsersData, BulkActionStatusVO, CacheStatsVO, CacheVO, CalculateInstallmentsDTO, CancelVoucherDTO, CaptchaConfigurationDTO, CaptchaInputDTO, CaptchaResponseDTO, ChangeForgottenPasswordData, ChangeForgottenPasswordDTO, ChangeGeneratedPasswordDTO, ChangeGroupDTO, ChangeOperatorGroupDTO, ChangePasswordData, ChangeTransferStatusDTO, ChangeUserStatusData, ChangeUserStatusParams, ChangeVoucherExpirationDateDTO, ChannelConfigurationDataParams, ClusterMemberData, ConfigurationImagesListData, ConnectedUserVO, ContactDataParams, ContactInfoListData, CountryVO, CreateAccessClientParams, CreateDeviceConfirmationParams, CreatePinDTO, CreateVoucherDataParams, CreateVouchersDTO, CredentialInputDTO, CredentialsConfigurationDTO, CurrencyAmountDTO, CurrentCredentialsForPinManage, CustomFieldPossibleValueDataParams, CustomizedTranslation, CustomOperationActionDataParams, CustomScriptConfigurationDTO, CustomWizardBackParams, CustomWizardExecutionData, CustomWizardStepDataParams, CustomWizardTransitionParams, CustomWizardTransitionVO, CustomWizardVerificationCodeParams, DatabaseUpgradeData, DataTranslationData, DataTranslationDTO, DataTranslationPropertyData, DataTranslationTypeData, DataTranslationValueDTO, DatePeriodDTO, DecimalRangeDTO, DeviceConfirmationApprovalData, DeviceConfirmationFeedbackPushNotificationData, DeviceConfirmationVO, DimensionsDTO, DistanceDTO, DocumentDataParams, DynamicFieldValueVO, DynamicOidcClientConfigurationDTO, EmailUnsubscribeData, EntityData, EntityModel, ExternalNFCTagAuthenticateData, ExternalPaymentActionDTO, FileSizeDTO, ForgotPasswordRequestDTO, FormFieldsWizardStepFieldDTO, FormFieldsWizardStepFieldVO, FrontendSettingsDTO, FullSystemImageCategoryListData, FullSystemImagesListData, GeneralReferenceDataParams, GetChangeForgottenPasswordDataParams, GuestInitializationData, HierarchicalDataTranslationType, HomeData, IdentityProviderCallbackResult, ImagesListData, ImportedFileDataParams, ImportProgressVO, InitializeNFCTagData, InitializeNFCTagResult, InitialVoucherUserData, InstallmentActionDTO, InstallmentDTO, InstallmentPreviewVO, IntegerRangeDTO, IpGeolocationResultDTO, JavaRuntimeData, LatLongDTO, LocalesData, LocaleVO, LocalizationData, LoginData, MailingListPreviewData, MaturityTableItemData, MenuEntriesListData, MenuEntryDataParams, MessageData, MessagesStatusVO, MobilePagesListData, NetworkWithInitialDataData, NewConfigurationImageParams, NewMessagePushNotificationData, NewNotificationPushNotificationData, NewTempImageParams, NewThemeImageParams, NewVoucherTemplateImageParams, NotificationSettingsData, NotificationsStatusVO, NumberGenerationDTO, OperatorDataParams, OperatorGroupListData, OrderActionParams, OrderDataParams, OtpRequest, PageResultColumn, ParameterVO, PasswordActionDTO, PasswordData, PasswordRegistrationData, PasswordRegistrationDTO, PaymentAuthorizationLevelData, PaymentPrincipalsConfigurationDTO, PaymentRequestActionDTO, PerformTransactionDTO, PeriodPreselectorOptionData, PersonalizeNFCTagData, PhoneConfigurationData, PhoneDataParams, PhoneListData, PinChannelConfigurationDTO, PinData, PinInputDTO, PredefinedPeriodData, PrepareEasyInvoiceData, PrepareEasyInvoiceParams, PreviewParams, PrincipalVO, PrivacySettingsData, PrivacySettingsDTO, ProcessDynamicDocumentData, ProcessDynamicDocumentDTO, ProcessTicketDTO, ProductLevelData, ProductsCollections, ProfileTransactionActionsData, ProfilingData, PushNotificationEventFilter, QueryParameters, ReceiptPartVO, ReceiptVO, ReceivePaymentData, ReceivePaymentFromUserData, RecordDataParams, RecordTypeCountVO, RecurringPaymentActionDTO, ReferencePeriodStatisticsVO, ReferenceStatisticsParams, ReferenceStatisticsVO, RegionalSettingsDTO, RemoveTotpSecretParams, RunCustomOperationAction, RunCustomOperationDataParams, RunCustomOperationDTO, RunCustomOperationResult, RunExternalRedirectCallbackParams, RunExternalRedirectCallbackParams, RunScriptData, RunScriptParams, ScheduledPaymentActionDTO, ScopeVO, ScriptResult, SearchByDistanceData, SearchData, SecurityQuestionVO, SendInviteMessageData, SendInviteMessageDTO, SendMessageData, SendMessageDTO, SendOtpData, SendOtpParams, SendSMSResult, ServiceWithOperationsVO, SetCustomizedTranslationsDTO, SetPinParams, SetSecurityQuestionData, SetSecurityQuestionDTO, SetupData, SetupDTO, ShoppingCartCheckoutResult, ShoppingCartDTO, SimpleChangeVoucherNotificationSettingsDTO, SimpleChangeVoucherPinDTO, SmsOperationConfigurationDataParams, SmsTextsListData, SmtpConfigurationDTO, StartCustomWizardParams, StartProfilingParams, StaticContentDataParams, StaticContentListData, StaticContentThemeData, SystemInformationData, SystemMonitorExportResult, SystemReportData, ThemeDataParams, ThemesListData, TicketProcessResult, TimeIntervalDTO, TimeZoneVO, TokenActionDTO, TokenDataParams, TokensListData, TotpSecretData, TransactionAuthorizationDTO, TransactionData, TransactionFeedbackUpdateDTO, TransactionPreviewVO, TransferActionDTO, TransferData, TransferFeesPreviewVO, TransferFlowStatusLogVO, TransferTypeDataParams, TranslationCategoryVO, TranslationKeyData, TranslationKeyVO, TranslationsData, TrustedDeviceActivationParams, TrustedDeviceActivationWithoutCodeParams, TrustedDeviceData, UnblockVoucherParams, UserAccountBalanceLimitData, UserAccountData, UserAccountPaymentAmountLimitData, UserAccountVisibilityData, UserAccountVisibilitySettingsData, UserAdDeliveryMethodsListData, UserAddressDataParams, UserAdInterestsListData, UserAgreementsData, UserAuthVO, UserChannelData, UserChannelsData, UserDataParams, UserFavoriteAdsListData, UserFormatConfigurationDTO, UserIdentityProviderListData, UserInitializationData, UserOptionalAgreementsDTO, UserPasswordDTO, UserPasswordsData, UserPinsData, UserPrincipalData, UserProfileFieldActions, UserQuickAccessData, UserRegistrationAccountConfigurationDTO, UserStatusLogVO, UsersWithBalancesOverview, ValidateRegistrationFieldParams, VoucherConfigurationListData, VoucherInfoData, VoucherInfoVO, VouchersSummaryVO, VoucherTransactionData, VoucherTransactionDataParams, VoucherTransactionPreviewVO, VoucherTypeListData

public abstract class Bean
extends Object
implements Serializable

This is the base class for all generated model beans in Cyclos. All properties are enumerable without reflection (as reflection is not supported under GWT).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Bean()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Adds a global property change listener
void	addPropertyChangeListener(Property<?,?> property, PropertyChangeListener listener)	Adds a specific property change listener
Set<String>	attributeNames()	Returns the names of contextual attributes
void	backup()	Marks this bean to backup the current values, so, if they are replaced, the original values can be restored
protected PropertyChangeSupport	changes()	Returns the PropertyChangeSupport for events on property changes
abstract String	className()
void	clearAttributes()	Removes all attributes
void	copyPropertiesTo(Bean destination)	Copies all the properties from this bean into the given destination bean
void	copyPropertiesTo(Bean destination, List<Property<?,?>> propertiesToSkip)	Copies all the properties from this bean into the given destination bean skipping the given properties
void	copyPropertiesTo(Bean destination, Property<?,?>... propertiesToSkip)
BeanDataAccessor	dataAccessor()
protected List<Property<?,?>>	doGetProperties()
protected void	firePropertyChange(Property<?,?> property, Object oldValue, Object newValue)	Fires a property change event
<T> T	get(Property<T,? extends Bean> property)	Returns the value of the given property
Object	getAttribute(String name)	Gets a contextual attribute, or null if none is found
void	initDataAccessor(BeanDataAccessor dataAccessor)
List<Property<?,?>>	properties()	Returns a list with all properties
<P extends Property<T,DTO>,T,DTO extends Bean> P	property(String name)	Returns a property descriptor by name
Map<String,Property<?,?>>	propertyMap()	Returns a map with all properties.
boolean	removeAttribute(String name)	Removes the attribute with the given name
void	removePropertyChangeListener(PropertyChangeListener listener)	Removes a global property change listener
void	removePropertyChangeListener(Property<?,?> property, PropertyChangeListener listener)	Removes a specific property change listener
void	restore()	Restores the currently backed up values
<T> T	set(Property<T,?> property, T value)	Sets the value for the given property
<T> T	set(Property<T,?> property, T value, boolean notifyListeners)	Sets the value for the given property, optionally notifying listeners
void	setAttribute(String name, Object value)	Sets a contextual attribute
<T> T	setWithPropagationId(Property<T,?> property, T value, Object propagationId)	Sets the value for the given property, notifying listeners with a custom propagation id
Map<String,Object>	values()	Returns all bean values in a Map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Bean

public Bean()

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(Property<?,?> property,
                                      PropertyChangeListener listener)

Adds a specific property change listener

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a global property change listener

attributeNames

public Set<String> attributeNames()

Returns the names of contextual attributes

backup

public void backup()

Marks this bean to backup the current values, so, if they are replaced, the original values can be restored

className

public abstract String className()

clearAttributes

public void clearAttributes()

Removes all attributes

copyPropertiesTo

public void copyPropertiesTo(Bean destination)

Copies all the properties from this bean into the given destination bean

copyPropertiesTo

public void copyPropertiesTo(Bean destination,
                             List<Property<?,?>> propertiesToSkip)

Copies all the properties from this bean into the given destination bean skipping the given properties

copyPropertiesTo

public void copyPropertiesTo(Bean destination,
                             Property<?,?>... propertiesToSkip)

dataAccessor

public BeanDataAccessor dataAccessor()

get

public final <T> T get(Property<T,? extends Bean> property)

Returns the value of the given property

Throws:

IllegalArgumentException - When the property is invalid

getAttribute

public Object getAttribute(String name)

Gets a contextual attribute, or null if none is found

initDataAccessor

public void initDataAccessor(BeanDataAccessor dataAccessor)

properties

public final List<Property<?,?>> properties()

Returns a list with all properties

property

public <P extends Property<T,DTO>,T,DTO extends Bean> P property(String name)

Returns a property descriptor by name

propertyMap

public Map<String,Property<?,?>> propertyMap()

Returns a map with all properties. If the bean doesn't have any property then an empty map is returned.

removeAttribute

public boolean removeAttribute(String name)

Removes the attribute with the given name

removePropertyChangeListener

public void removePropertyChangeListener(Property<?,?> property,
                                         PropertyChangeListener listener)

Removes a specific property change listener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a global property change listener

restore

public void restore()

Restores the currently backed up values

set

public final <T> T set(Property<T,?> property,
                       T value)

Sets the value for the given property

set

public final <T> T set(Property<T,?> property,
                       T value,
                       boolean notifyListeners)

Sets the value for the given property, optionally notifying listeners

setAttribute

public void setAttribute(String name,
                         Object value)

Sets a contextual attribute

setWithPropagationId

public final <T> T setWithPropagationId(Property<T,?> property,
                                        T value,
                                        Object propagationId)

Sets the value for the given property, notifying listeners with a custom propagation id

values

public Map<String,Object> values()

Returns all bean values in a Map. Null values are not included.

changes

protected PropertyChangeSupport changes()

Returns the PropertyChangeSupport for events on property changes

doGetProperties

protected List<Property<?,?>> doGetProperties()

firePropertyChange

protected void firePropertyChange(Property<?,?> property,
                                  Object oldValue,
                                  Object newValue)

Fires a property change event