Package com.echothree.util.server.control

Class BasePaginatedMultipleEntitiesCommand<BE extends BaseEntity,F extends BaseForm>

java.lang.Object

com.echothree.util.server.control.BaseCommand

com.echothree.util.server.control.BaseSimpleCommand<F>

com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand<BE,F>

All Implemented Interfaces:

GraphQlSecurityCommand<F>, ExecutionErrorAccumulator, ExecutionWarningAccumulator, SecurityMessageAccumulator

Direct Known Subclasses:

GetAllocationPrioritiesCommand, GetAppearancesCommand, GetCancellationKindsCommand, GetCancellationPoliciesCommand, GetCancellationTypesCommand, GetCitiesCommand, GetColorsCommand, GetCompaniesCommand, GetComponentVendorsCommand, GetContactMechanismPurposesCommand, GetContentCatalogItemsCommand, GetContentCatalogsCommand, GetContentCategoriesCommand, GetContentCategoryItemsCommand, GetContentCollectionsCommand, GetContentPageAreasCommand, GetContentPageAreaTypesCommand, GetContentPageLayoutAreasCommand, GetContentPageLayoutsCommand, GetContentPagesCommand, GetContentSectionsCommand, GetContentWebAddressesCommand, GetCountiesCommand, GetCountriesCommand, GetCurrenciesCommand, GetCustomersCommand, GetCustomerTypesCommand, GetDateTimeFormatsCommand, GetDepartmentsCommand, GetDivisionsCommand, GetEmployeesCommand, GetEmployeeTypesCommand, GetEntityAliasesCommand, GetEntityAliasTypesCommand, GetEntityAttributeEntityAttributeGroupsCommand, GetEntityAttributeGroupsCommand, GetEntityAttributesCommand, GetEntityAttributeTypesCommand, GetEntityInstancesCommand, GetEntityTagsCommand, GetEntityTypesCommand, GetEventsCommand, GetEventTypesCommand, GetFilterAdjustmentAmountsCommand, GetFilterAdjustmentFixedAmountsCommand, GetFilterAdjustmentPercentsCommand, GetFilterAdjustmentsCommand, GetFilterAdjustmentSourcesCommand, GetFilterAdjustmentTypesCommand, GetFilterEntranceStepsCommand, GetFilterKindsCommand, GetFiltersCommand, GetFilterStepDestinationsCommand, GetFilterStepElementsCommand, GetFilterStepsCommand, GetFilterTypesCommand, GetFontStylesCommand, GetFontWeightsCommand, GetFreeOnBoardsCommand, GetGeoCodeAliasesCommand, GetGeoCodeAliasTypesCommand, GetGeoCodeCurrenciesCommand, GetGeoCodeDateTimeFormatsCommand, GetGeoCodeLanguagesCommand, GetGeoCodeScopesCommand, GetGeoCodeTimeZonesCommand, GetGeoCodeTypesCommand, GetGlAccountCategoriesCommand, GetGlAccountClassesCommand, GetGlAccountsCommand, GetGlAccountTypesCommand, GetGlResourceTypesCommand, GetInventoryAdjustmentTypesCommand, GetInventoryConditionsCommand, GetInventoryLocationGroupsCommand, GetInventoryTransactionTypesCommand, GetItemAccountingCategoriesCommand, GetItemAliasChecksumTypesCommand, GetItemAliasesCommand, GetItemAliasTypesCommand, GetItemCategoriesCommand, GetItemDeliveryTypesCommand, GetItemDescriptionsCommand, GetItemDescriptionTypesCommand, GetItemDescriptionTypeUsesCommand, GetItemDescriptionTypeUseTypesCommand, GetItemImageTypesCommand, GetItemInventoryTypesCommand, GetItemPricesCommand, GetItemPriceTypesCommand, GetItemPurchasingCategoriesCommand, GetItemsCommand, GetItemTypesCommand, GetItemUnitOfMeasureTypesCommand, GetItemUseTypesCommand, GetItemVolumeTypesCommand, GetItemWeightTypesCommand, GetLanguagesCommand, GetLocationNameElementsCommand, GetLocationsCommand, GetLocationTypesCommand, GetLocationUseTypesCommand, GetLotsCommand, GetMimeTypesCommand, GetMimeTypeUsageTypesCommand, GetNameSuffixesCommand, GetOfferChainTypesCommand, GetOfferCustomerTypesCommand, GetOfferItemPricesCommand, GetOfferItemsCommand, GetOfferNameElementsCommand, GetOffersCommand, GetOfferUsesCommand, GetOrderPrioritiesCommand, GetOrderTimeTypesCommand, GetOrderTypesCommand, GetPartiesCommand, GetPartyAliasesCommand, GetPartyAliasTypesCommand, GetPartyInventoryLevelsCommand, GetPartyRelationshipsCommand, GetPartyTypesCommand, GetPaymentMethodTypesCommand, GetPaymentProcessorsCommand, GetPaymentProcessorTypesCommand, GetPersonalTitlesCommand, GetQueueTypesCommand, GetRecoveryQuestionsCommand, GetRelatedItemsCommand, GetRelatedItemTypesCommand, GetReturnKindsCommand, GetReturnPoliciesCommand, GetReturnTypesCommand, GetRoleTypesCommand, GetSearchCheckSpellingActionTypesCommand, GetSearchDefaultOperatorsCommand, GetSearchKindsCommand, GetSearchResultActionTypesCommand, GetSearchSortDirectionsCommand, GetSearchSortOrdersCommand, GetSearchTypesCommand, GetSearchUseTypesCommand, GetSecurityRoleGroupsCommand, GetSecurityRolesCommand, GetSelectorKindsCommand, GetSelectorTypesCommand, GetSequenceChecksumTypesCommand, GetSequenceEncoderTypesCommand, GetSequencesCommand, GetSequenceTypesCommand, GetSourcesCommand, GetStatesCommand, GetSymbolPositionsCommand, GetTagsCommand, GetTagScopeEntityTypesCommand, GetTagScopesCommand, GetTermsCommand, GetTermTypesCommand, GetTextDecorationsCommand, GetTextTransformationsCommand, GetTimeZonesCommand, GetTransactionEntityRoleTypesCommand, GetTransactionGlAccountCategoriesCommand, GetTransactionGroupsCommand, GetTransactionsCommand, GetTransactionTimeTypesCommand, GetTransactionTypesCommand, GetUnitOfMeasureKindsCommand, GetUnitOfMeasureKindUsesCommand, GetUnitOfMeasureKindUseTypesCommand, GetUnitOfMeasureTypesCommand, GetUseNameElementsCommand, GetUserVisitGroupsCommand, GetUsesCommand, GetUseTypesCommand, GetVendorItemCostsCommand, GetVendorItemsCommand, GetVendorsCommand, GetVendorTypesCommand, GetWarehousesCommand, GetWarehouseTypesCommand, GetWishlistPrioritiesCommand, GetWishlistTypesCommand, GetWorkflowDestinationPartyTypesCommand, GetWorkflowDestinationsCommand, GetWorkflowDestinationSecurityRolesCommand, GetWorkflowDestinationSelectorsCommand, GetWorkflowDestinationStepsCommand, GetWorkflowEntityStatusesCommand, GetWorkflowEntityTypesCommand, GetWorkflowEntrancePartyTypesCommand, GetWorkflowEntrancesCommand, GetWorkflowEntranceSecurityRolesCommand, GetWorkflowEntranceSelectorsCommand, GetWorkflowEntranceStepsCommand, GetWorkflowsCommand, GetWorkflowSelectorKindsCommand, GetWorkflowStepsCommand, GetWorkflowStepTypesCommand, GetZipCodesCommand

public abstract class BasePaginatedMultipleEntitiesCommand<BE extends BaseEntity,F extends BaseForm>
extends BaseSimpleCommand<F>
implements GraphQlSecurityCommand<F>

Field Summary

Fields inherited from class com.echothree.util.server.control.BaseSimpleCommand

form, mimeTypeControl

Fields inherited from class com.echothree.util.server.control.BaseCommand

commandControl, componentControl, coreControl, entityTypeControl, eventControl, securityRoleLogic, session, userControl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasePaginatedMultipleEntitiesCommand(CommandSecurityDefinition commandSecurityDefinition, List<FieldDefinition> formFieldDefinitions, boolean allowLimits)

Method Summary

Modifier and Type	Method	Description
protected BaseResult	execute()
protected abstract Collection<BE>	getEntities()
Collection<BE>	getEntitiesForGraphQl(UserVisitPK userVisitPK, F form)
protected abstract BaseResult	getResult(Collection<BE> entities)
protected abstract Long	getTotalEntities()
Long	getTotalEntitiesForGraphQl(UserVisitPK userVisitPK, F form)
protected abstract void	handleForm()
SecurityResult	security(UserVisitPK userVisitPK, F form)

Methods inherited from class com.echothree.util.server.control.BaseSimpleCommand

canQueryByGraphQl, getForm, getFormFieldDefinitions, run, runAsync, setupPreferredClobMimeType, setupSession, setupValidator, validate, validate

Methods inherited from class com.echothree.util.server.control.BaseCommand

addExecutionError, addExecutionError, addExecutionWarning, addExecutionWarning, addSecurityMessage, addSecurityMessage, canSpecifyParty, checkCommandSecurityDefinition, checkOptionalSecurityRoles, getBaseResultAfterErrors, getCheckIdentityVerifiedTime, getCommandName, getCommandSecurityDefinition, getCompanyParty, getComponentVendorName, getExecutionErrors, getExecutionWarnings, getInsufficientSecurityResult, getLog, getLogCommand, getParty, getPartyPK, getPartyType, getPartyTypeName, getPreferredCurrency, getPreferredCurrency, getPreferredDateTimeFormat, getPreferredDateTimeFormat, getPreferredLanguage, getPreferredLanguage, getPreferredTimeZone, getPreferredTimeZone, getSecurityMessages, getSession, getUpdateLastCommandTime, getUserControl, getUserSession, getUserVisit, getUserVisitForUpdate, getUserVisitPK, hasExecutionErrors, hasExecutionWarnings, hasSecurityMessages, initSession, removeFilteredTransferProperty, removeOption, run, runAsync, security, selfOnly, sendEvent, sendEvent, sendEvent, setCheckIdentityVerifiedTime, setLogCommand, setUpdateLastCommandTime, setUserVisitPK, teardownSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.echothree.util.server.control.GraphQlSecurityCommand

hasSecurityMessages

Constructor Details

BasePaginatedMultipleEntitiesCommand

protected BasePaginatedMultipleEntitiesCommand(CommandSecurityDefinition commandSecurityDefinition,
 List<FieldDefinition> formFieldDefinitions,
 boolean allowLimits)

Method Details

handleForm

protected abstract void handleForm()

getTotalEntities

protected abstract Long getTotalEntities()

getEntities

protected abstract Collection<BE> getEntities()

getResult

protected abstract BaseResult getResult(Collection<BE> entities)

getTotalEntitiesForGraphQl

public Long getTotalEntitiesForGraphQl(UserVisitPK userVisitPK,
 F form)

getEntitiesForGraphQl

public Collection<BE> getEntitiesForGraphQl(UserVisitPK userVisitPK,
 F form)

security

public SecurityResult security(UserVisitPK userVisitPK,
 F form)

Specified by:

security in interface GraphQlSecurityCommand<BE extends BaseEntity>

execute

protected BaseResult execute()

Specified by:

execute in class BaseCommand