public class ModelRoot extends ModelObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String | PROP_ACTIVE_CUSTOMER
Constant for the active customer property name.
|
static java.lang.String | PROP_ACTIVE_OPERATOR
Constant for the active operator property name.
|
static java.lang.String | PROP_ACTIVE_RETURNS_CONTAINER
Constant for the active RMA property name.
|
static java.lang.String | PROP_ACTIVE_SALES_CONTAINER
Constant for the active order property name.
|
static java.lang.String | PROP_ACTIVE_STORE
Constant for the active store property name.
|
static java.lang.String | PROP_ACTIVE_TICKLER
Constant for the active tickler property name.
|
static java.lang.String | PROP_AVAILABLE_MARKETING_PROMOTIONS
Constant for the marketing promotions property name.
|
static java.lang.String | PROP_AVAILABLE_SERVICE_REPS
Constant for the available service representatives property name.
|
static java.lang.String | PROP_AVAILABLE_SERVICE_TEAMS
Constant for the available service teams property name.
|
static java.lang.String | PROP_AVAILABLE_STORES
Constant for the available stores property name.
|
static java.lang.String | PROP_BUSINESS_CHANNELS
Constant for the business channels property name.
|
static java.lang.String | PROP_COUNTRIES
Constant for the countries property name.
|
static java.lang.String | PROP_OPEN_STORES
Constant for the open stores property name.
|
static java.lang.String | PROP_OPEN_TICKLERS
Constant for the open ticklers property name.
|
static java.lang.String | PROP_RESPONSIBLE_TICKLERS
Constant for the responsible ticklers property name.
|
static java.lang.String | PROP_SEARCH_RESULTS
Constant for the search results property name.
|
Constructor and Description |
---|
ModelRoot()
Constructor for ModelRoot.
|
Modifier and Type | Method and Description |
---|---|
void | addLanguage(java.lang.String langId, java.lang.String langDesc)
Adds a language to the language list.
|
void | clearLanguages()
Returns a language description given a language ID.
|
Customer | getActiveCustomer()
This method is a convenience method for retrieving the current setting of the "activeCustomer" property.
|
Operator | getActiveOperator()
This method is a convenience method for retrieving the current setting of the "activeOperator" property.
|
Return | getActiveReturnsContainer()
This method is a convenience method for retrieving the current setting of the "activeReturnsContainer" property.
|
SalesContainer | getActiveSalesContainer()
This method is a convenience method for retrieving the current setting of the "activeSalesContainer" property.
|
Store | getActiveStore()
This method is a convenience method for retrieving the current setting of the "activeStore" property.
|
Tickler | getActiveTickler()
This method is a convenience method for retrieving the current setting of the "activeTickler" property.
|
ModelObjectList | getAvailableMarketingPromotions()
This method is a convenience method for retrieving the current setting of the "availableMarketingPromotions" property.
|
ModelObjectList | getAvailableServiceReps()
This method is a convenience method for retrieving the current setting of the "availableServiceReps" property.
|
ModelObjectList | getAvailableServiceTeams()
This method is a convenience method for retrieving the current setting of the "availableServiceTeams" property.
|
ModelObjectList | getAvailableStores()
This method is a convenience method for retrieving the current setting of the "availableStores" property.
|
ModelObjectList | getBusinessChannels()
This method is a convenience method for getting the "businessChannels" property.
|
ModelObjectList | getCountries()
This method is a convenience method for retrieving the current setting of the "countries" property.
|
java.lang.String | getLanguage(java.lang.String langId)
Returns a language description given a language ID.
|
ModelObjectList | getOpenStores()
This method is a convenience method for retrieving the current setting of the "openStores" property.
|
ModelObjectList | getOpenTicklers()
This method is a convenience method for retrieving the current setting of the "openTicklers" property.
|
ModelObjectList | getResponsibleTicklers()
This method is a convenience method for retrieving the current setting of the "responsible ticklers" property.
|
GenericGet | getSearchResults()
This method is a convenience method for retrieving the current setting of the "searchResults" property.
|
java.lang.String[] | getSupportedAssociationTypes()
This method is a convenience method for retrieving the supported association types.
|
void | setActiveCustomer(Customer customer)
This method is a convenience method for setting the "customer" property.
|
void | setActiveOperator(Operator activeOperator)
This method is a convenience method for setting the "activeOperator" property.
|
void | setActiveReturnsContainer(Return activeRMA)
This method is a convenience method for setting the "activeReturnsContainer" property.
|
void | setActiveSalesContainer(SalesContainer activeSale)
This method is a convenience method for setting the "activeSalesContainer" property.
|
void | setActiveStore(Store activeStore)
This method is a convenience method for setting the "activeStore" property.
|
void | setActiveTickler(Tickler activeTickler)
This method is a convenience method for setting the "activeTickler" property.
|
void | setBusinessChannels(BusinessChannel[] businessChannels)
This method is a convenience method for Setting the "businessChannels" property.
|
void | setCountries(ModelObjectList countries)
This method is a convenience method for setting the "countries" property.
|
void | setSearchResults(GenericGet searchResults)
This method is a convenience method for setting the "searchResults" property.
|
public static final java.lang.String PROP_AVAILABLE_STORES
The value is "availableStores".
The data stored under the "availableStores" property is a ModelObjectList that contains a list of Store objects that represent all of the available stores.
public static final java.lang.String PROP_OPEN_STORES
The value is "openStores".
The data stored under the "openStores" property is a ModelObjectList that contains a list of Store objects that represent all of the stores that are currently open.
public static final java.lang.String PROP_ACTIVE_OPERATOR
The value is "activeOperator".
The data stored under the "activeOperator" property is an Operator that represents the current operator.
public static final java.lang.String PROP_ACTIVE_STORE
The value is "activeStore".
The data stored under the "activeStore" property is a Store that represents the current store.
public static final java.lang.String PROP_ACTIVE_CUSTOMER
The value is "activeCustomer".
The data stored under the "activeCustomer" property is a Customer that represent the active customer.
public static final java.lang.String PROP_ACTIVE_SALES_CONTAINER
The value is "activeSalesContainer".
The data stored under the "activeSalesContainer" property is an SalesContainer that represents the active sale.
public static final java.lang.String PROP_ACTIVE_RETURNS_CONTAINER
The value is "activeReturnsContainer".
The data stored under the "activeReturnsContainer" property is an Return that represents the active sale.
public static final java.lang.String PROP_SEARCH_RESULTS
The value is "searchResults".
The data stored under the "searchResults" property is a GenericGet object that contains the results of the last action that did a search.
public static final java.lang.String PROP_RESPONSIBLE_TICKLERS
The value is "responsibleTicklers".
The data stored under the "responsibleTicklers" property is a ModelObjectList that contains a list of Tickler objects that represent all of the responsible ticklers.
public static final java.lang.String PROP_OPEN_TICKLERS
The value is "openTicklers".
The data stored under the "openTicklers" property is a ModelObjectList that contains a list of Tickler objects that represent all of the ticklers that are currently open.
public static final java.lang.String PROP_ACTIVE_TICKLER
The value is "activeTickler".
The data stored under the "activeTickler" property is a Tickler that represents the current tickler.
public static final java.lang.String PROP_AVAILABLE_MARKETING_PROMOTIONS
The value is "availableMarketingPromotions".
The data stored under the "availableMarketingPromotions" property is a MarketingPromotions that represents the current Marketing Promotions that are associated with a customer editor.
public static final java.lang.String PROP_COUNTRIES
The value is "countries".
The data stored under the "countries" property is a ModelObjectList that contains a list of Country objects that represent all of the available stores.
public static final java.lang.String PROP_BUSINESS_CHANNELS
The value is "businessChannels".
The data stored under the "businessChannels" property is an array of BusinessChannel objects that specifies all of the available Business Channels defined on the server.
public static final java.lang.String PROP_AVAILABLE_SERVICE_REPS
The value is "availableServiceReps".
The data stored under the "availableServiceReps" property is a ModelObjectList that contains a list of TicklerAssignee objects that represent all of the available service representatives.
public static final java.lang.String PROP_AVAILABLE_SERVICE_TEAMS
The value is "availableServiceTeams".
The data stored under the "availableServiceTeams" property is a ModelObjectList that contains a list of TicklerAssignee objects that represent all of the available service teams.
public ModelRoot()
This method initializes the following properties with an empty ModelObjectList.
public Operator getActiveOperator()
public void setActiveOperator(Operator activeOperator)
public Store getActiveStore()
public void setActiveStore(Store activeStore)
public ModelObjectList getAvailableStores()
public ModelObjectList getAvailableMarketingPromotions()
public ModelObjectList getCountries()
public void setCountries(ModelObjectList countries)
public ModelObjectList getOpenStores()
public Customer getActiveCustomer()
public void setActiveCustomer(Customer customer)
public SalesContainer getActiveSalesContainer()
public void setActiveSalesContainer(SalesContainer activeSale)
public Return getActiveReturnsContainer()
public void setActiveReturnsContainer(Return activeRMA)
public GenericGet getSearchResults()
public void setSearchResults(GenericGet searchResults)
public Tickler getActiveTickler()
public void setActiveTickler(Tickler activeTickler)
public ModelObjectList getResponsibleTicklers()
public ModelObjectList getOpenTicklers()
public void addLanguage(java.lang.String langId, java.lang.String langDesc)
public java.lang.String getLanguage(java.lang.String langId)
public void clearLanguages()
public void setBusinessChannels(BusinessChannel[] businessChannels)
The single parameter is an array of BusinessChannel objects.
public ModelObjectList getBusinessChannels()
The return value is an array of BusinessChannel objects.
public ModelObjectList getAvailableServiceReps()
public ModelObjectList getAvailableServiceTeams()
public java.lang.String[] getSupportedAssociationTypes()