com.portal.bas

Interface PComponentAttribute

All Known Implementing Classes:

AbstractSearchModule, AdjustEventPanel, BalanceGroupSearchResultsTable, BrowserPanel, BrowseWin, EventResultsTablePanel, GSMGeneralAttributesPanel, GSMServicePanel, ItemChargesTreeTable, ListOfBalanceMonitorsPanel, ListOfMonitorMembersPanel, LoginWrapper, NUMPanel, PAccountsEntryPanel, PAccountsResults, PAccountsResultsPanel, PAccountTitlePanel, PAcctHierarchyPage, PAcctNoHierarchyPage, PAcctTree, PActiveAccountManager, PAddressPanel, PARAcctAdjustPanel, PARActionAdjustDetailPage, PARActionDetailAppliedToPage, PARActionDetailPage, PARActionRefundDetailPage, PARActionWriteoffDetailPage, PARAllActionsPage, PARAllocatePanel, PARBalancePage, PARBillAdjustPanel, PARConnectionAdjustPanel, PARCreditLimitPanel, PARDebitAllocatePanel, PARDisputesPage, PAREventAdjustPanel, PAREventDisputePanel, PAREventResults, PAREventSettlementPanel, PARItemAdjustPanel, PARItemDetailsPage, PARPaymentDetailPage, PArrayTable, PARUnappliedPage, PARWriteoffPanel, PAvailableServicesPanel, PBackdateSetupPanel, PBestConfigPanel, PBestPricingSavingsPanel, PBillDetailsPage, PBillingCycleAndTaxSetupPage, PBillingPage, PBillsEntryPanel, PBillsResults, PBillUnitDetailsPanel, PBillUnitHierarchyPage, PBillUnitPanel, PBroadbandPanel, PCAConsumerPaymentBillPanel, PCAConsumerPaymentPanel, PCAEmptyProfilePanel, PChangeAccountStatusOptionPanel, PChangeStatusPage, PChangeStatusPage.PIAChangeStatusTextAreaField, PChargeSharingPanel, PCollectionsMembershipPanel, PCollectionsSharingPanel, PComparePage, PContactPage, PContactPanel, PCreditCardPanel, PCreditLimitPage, PCustomerCenterInternals, PCustomizeProductsPanel, PDefaultChoiceStringEnum, PDefaultDevicePanel, PDeferredActionPage, PDeviceAccountsEntryPanel, PDeviceComboBox, PDeviceHistoryBasePage, PDeviceSearchEntryPanelBase, PDeviceSearchEntryPanelDefault, PDeviceSearchResultsPanelBase, PDeviceSearchResultsPanelDefault, PDiscountSharingPanel, PEffectiveMoveDatePanel, PEmailPanel, PendingItemChargesTreeTable, PExistingProductsPanel, PExtendedServicePanel, PFUSADirDebitPanel, PGeneralPage, PGPRSPanel, PGroupMembersPage, PGSMPanel, PHierarchyLabelPage, PHierarchyMoveOptionsPage, PHierarchyMovePage, PHierarchyRemoveAcctPage, PHomePage, PI18NPanel, PIABigIntegerField, PIABinaryStringField, PIABooleanEnumField, PIABooleanEnumRadioField, PIACanonField, PIACAPaymentPanel, PIACAProfilePanel, PIAConstant, PIACurrencyField, PIACustomizablePanel, PIADateField, PIADefaultChoiceEnumField, PIADefaultPaymentTypePanel, PIADigitsTextField, PIAEnumField, PIAExpirationField, PIAExtendedDevicesBase, PIAExtendedServicesBase, PIAGroupTree, PIAIndexedArrayTable, PIAIntegerField, PIAList, PIANotesPanel, PIANumberField, PIAObjectField, PIAPanel, PIAPanelGroup, PIAPasswordField, PIAPaymentField, PIAPaymentOnFileField, PIAPaymentTypePanel, PIAPercentField, PIAPhoneTable, PIAReadOnlyField, PIAScrollPane, PIASearchPanel, PIASearchResultsPanel, PIASpecSpreadSheet, PIASpinnerField, PIASpreadSheet, PIAStringEnum, PIATextAreaField, PIATextField, PInvoicePOPanel, PIPPanel, PMaintenancePage, PMandateStatusPage, PMapInfoPage, PMembershipPanel, PMSExchangeOrgNameField, PMSExchangeOrgPanel, PMSExchangeUserPanel, PNamePanel, PNCDetailPanel, PNCPanel, PNewServicePage, PNewServiceTable, PNonCurrencyResourcePanel, PNonCurrencyTable, PNotesPage, PNotesPanel, PNumberEntryPanel, PNumberHistoryPage, PNumberPanel, PNumberResultsPanel, POwnershipPanel, PPageTemplate, PPayInfoPanel, PPaymentPage, PPaymentSetup, PPaymentWizard, PPlanOptionsPage, PPPVPage, PProductAttributesPanel, PProductDetailsPanel, PProductsViewConfigPanel, PProfileMembershipPanel, PProfileSharingPanel, PPromotionArrayTable, PPromotionPage, PPromotionPanel, PPurchasePanel, PRemoveBillInProgressPanel, PRemoveHierarchyPage, PRemovePaymentSetupPanel, PRolloverReceiverSearchPanel, PRolloverTransferPanel, PRolloverTransferSearchExtendedWizardPanel, PRolloverTransferTablePanel, PSearchButtonPanel, PSearchExtendedWizardPanel, PSelfRegistrationPage, PSepaPanel, PSepaRegisterPanel, PServiceDealProductHistoryPanel, PServiceDefault, PServicePage, PServicesDealsProductsTable, PServiceTable, PSettopEntryPanel, PSettopPanel, PSettopResultsPanel, PSharingPage, PSIMEntryPanel, PSIMHistoryPage, PSIMPanel, PSIMResultsPanel, PSMSPanel, PSponsorGroup, PSponsorGroupMembers, PSponsorMemberSearch, PSponsorOwnerSearch, PSponsorship, PSubscriberPrefsPage, PSubscriptionServicePage, PSummaryPage, PSummaryPanel, PTechDetails, PTelcoDeviceHistoryBase, PTelcoDevicesBase, PTelcoNumberEntryPanel, PTelcoNumberPanel, PTelcoNumberResultsPanel, PTelcoPromotionPage, PTelcoPromotionPanel, PTelcoServicePanel, PTelephonyPanel, PVideoPanel, PVoucherPage, PWAPPanel, ResultsTablePanel, SearchPanel, ServiceSearchResultsTable, SharingAccountEntryPanel, SIMEntryPanel, SIMPanel, SIMResultsPanel

public interface PComponentAttribute

PComponentAttribute encapsulates attributes that can be associated with a PFieldComponent. These attributes include DIRTY (changed by the user), REQUIRED (by Portal policy), and ERROR (incorrect value/format for committing to Portal).

These attributes are not mutually exclusive; a component can be in a REQUIRED, DIRTY, and ERROR state at the same time. However, setting a component to CLEAN will clear the DIRTY and ERROR attributes.

Version:

%version: 5 % %date_modified: Mon Mar 12 13:35:48 2001

Author:

kapono

Method Summary

Modifier and Type	Method and Description
void	clear() Clears existing data from the component.
boolean	isCurrencyDisplay() Determines whether the component currently displays currency data.
boolean	isDirty() Determines if this component is currently in a DIRTY state.
boolean	isError() Determines if this component is currently in an ERROR state.
boolean	isInputTracking() Determines if input tracking is enabled.
boolean	isRequired() Determines whether this component is required in its current context.
void	resetToDefault() Resets the component value to the original value, which was established by calling setDefault().
void	revertToPrimary(int primary) Reverts converted currency data back to the primary representation.
void	setClean() Resets the component to the CLEAN state.
void	setCurrencyDisplay(boolean b) Determines if this component currently displays currency data.
void	setDefault() Establishes the current value (or element count, depending on the given component) as the default value.
void	setError(boolean b) Marks this component as containing erroneous data in the current context or unmarks the ERROR state, depending on the parameter.
void	setInputTracking(boolean b) If the inputTracking property is enabled, any changes made by the user to the component are tracked and the component is marked DIRTY.
void	setRequired(boolean b) Marks this component as REQUIRED in its current context.
Object	togglePrimaryToSecondary(int primary, int secondary) Causes the component to use the BEIDManager to convert its data.

Method Detail

setRequired

void setRequired(boolean b)

Marks this component as REQUIRED in its current context. This is currently a visual indicator only. There is no policy to enforce that required fields get filled in.

Parameters:

b - indicates whether this component is required in its current context

isRequired

boolean isRequired()

Determines whether this component is required in its current context. This is currently a visual indicator only. There is no policy that forces required fields to be filled in.

Returns:

True if this field is required; false otherwise.

setError

void setError(boolean b)

Marks this component as containing erroneous data in the current context or unmarks the ERROR state, depending on the parameter.

Parameters:

b - if true, puts the component in an ERROR state

isError

boolean isError()

Determines if this component is currently in an ERROR state.

Returns:

The error state of this component.

setInputTracking

void setInputTracking(boolean b)

If the inputTracking property is enabled, any changes made by the user to the component are tracked and the component is marked DIRTY. If the user modifies the data and returns it to its default or original state, the component is marked CLEAN or not DIRTY.

Parameters:

b - the state of the inputTracking property

isInputTracking

boolean isInputTracking()

Determines if input tracking is enabled.

Returns:

True if input tracking is enabled; false otherwise.

isDirty

boolean isDirty()

Determines if this component is currently in a DIRTY state.

Returns:

True if the user has modified the data represented by this component, false otherwise. It also returns false if input tracking is off.

setDefault

void setDefault()

Establishes the current value (or element count, depending on the given component) as the default value. Any modifications after this method is called will result in a DIRTY component.

setClean

void setClean()

Resets the component to the CLEAN state. If the component was in DIRTY or ERROR state, this method removes those attributes. A required component is still marked REQUIRED after a call to this method.

resetToDefault

void resetToDefault()

Resets the component value to the original value, which was established by calling setDefault(). If no default value exists, the component data is cleared.

clear

void clear()

Clears existing data from the component.

setCurrencyDisplay

void setCurrencyDisplay(boolean b)

Determines if this component currently displays currency data. Widgets that display currency data are capable of automatically toggling their data between a primary and secondary Portal currency type.

Use this API if the application you are building allows the user to switch between multiple currencies. For each widget that displays currency data, set this property to true.

Parameters:

b - if true, indicates that the widget currently displays currency data

Since:

Release 6.2

isCurrencyDisplay

boolean isCurrencyDisplay()

Determines whether the component currently displays currency data.

Returns:

True if the widget currently displays currency data; false otherwise.

Since:

Release 6.2

togglePrimaryToSecondary

Object togglePrimaryToSecondary(int primary,
                                int secondary)
                         throws RemoteException

Causes the component to use the BEIDManager to convert its data.

Typically, this method is not called directly. The encapsulating panel should take care of toggling data for all components it contains to minimize the RMI traffic.

Parameters:

primary - the primary currency ID

secondary - the secondary currency ID

Throws:

RemoteException

Since:

Release 6.2

revertToPrimary

void revertToPrimary(int primary)
              throws RemoteException

Reverts converted currency data back to the primary representation.

Parameters:

primary - the primary currency ID

Throws:

RemoteException

Since:

Release 6.2