com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readcontrollingarea

Class ControllingArea

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.Entity<ControllingArea>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readcontrollingarea.ControllingArea

public class ControllingArea
extends Entity<ControllingArea>

API Controlling Area

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControllingArea.ControllingAreaBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static EntityField<ControllingArea,String>	CHART_OF_ACCOUNTS Use with available fluent helpers to apply the ChartOfAccounts field to query operations.
static EntityField<ControllingArea,String>	CONTROLLING_AREA Use with available fluent helpers to apply the ControllingArea field to query operations.
static EntityField<ControllingArea,String>	CONTROLLING_AREA_CURRENCY Use with available fluent helpers to apply the ControllingAreaCurrency field to query operations.
static EntityField<ControllingArea,String>	CONTROLLING_AREA_CURRENCY_ROLE Use with available fluent helpers to apply the ControllingAreaCurrencyRole field to query operations.
static EntityField<ControllingArea,String>	CONTROLLING_AREA_NAME Use with available fluent helpers to apply the ControllingAreaName field to query operations.
static EntityField<ControllingArea,String>	COST_CENTER_STANDARD_HIERARCHY Use with available fluent helpers to apply the CostCenterStandardHierarchy field to query operations.
static EntityField<ControllingArea,String>	FINANCIAL_MANAGEMENT_AREA Use with available fluent helpers to apply the FinancialManagementArea field to query operations.
static EntityField<ControllingArea,String>	FISCAL_YEAR_VARIANT Use with available fluent helpers to apply the FiscalYearVariant field to query operations.
static EntityField<ControllingArea,String>	PROFIT_CENTER_ACCOUNTING_CURRENCY Use with available fluent helpers to apply the ProfitCenterAccountingCurrency field to query operations.
static EntityField<ControllingArea,String>	PROFIT_CENTER_STANDARD_HIERARCHY Use with available fluent helpers to apply the ProfitCenterStandardHierarchy field to query operations.

Constructor Summary

Constructors

Constructor and Description
ControllingArea()
ControllingArea(String controllingArea, String fiscalYearVariant, String controllingAreaName, String controllingAreaCurrency, String chartOfAccounts, String costCenterStandardHierarchy, String profitCenterStandardHierarchy, String financialManagementArea, String controllingAreaCurrencyRole, String profitCenterAccountingCurrency, ErpConfigContext erpConfigContext)

Method Summary

Methods

Modifier and Type	Method and Description
static ControllingArea.ControllingAreaBuilder	builder()
boolean	equals(Object o)
static <T> EntityField<ControllingArea,T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getChartOfAccounts() Constraints: Not nullable, Maximum length: 4
String	getControllingArea() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getControllingAreaCurrency() Constraints: Not nullable, Maximum length: 5
String	getControllingAreaCurrencyRole() Constraints: Not nullable, Maximum length: 2
String	getControllingAreaName() Constraints: Not nullable, Maximum length: 25
String	getCostCenterStandardHierarchy() Constraints: Not nullable, Maximum length: 12
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getFinancialManagementArea() Constraints: Not nullable, Maximum length: 4
String	getFiscalYearVariant() Constraints: Not nullable, Maximum length: 2
String	getProfitCenterAccountingCurrency() Constraints: Not nullable, Maximum length: 5
String	getProfitCenterStandardHierarchy() Constraints: Not nullable, Maximum length: 12
Class<ControllingArea>	getType()
int	hashCode()
void	setChartOfAccounts(String chartOfAccounts) Constraints: Not nullable, Maximum length: 4
void	setControllingArea(String controllingArea) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setControllingAreaCurrency(String controllingAreaCurrency) Constraints: Not nullable, Maximum length: 5
void	setControllingAreaCurrencyRole(String controllingAreaCurrencyRole) Constraints: Not nullable, Maximum length: 2
void	setControllingAreaName(String controllingAreaName) Constraints: Not nullable, Maximum length: 25
void	setCostCenterStandardHierarchy(String costCenterStandardHierarchy) Constraints: Not nullable, Maximum length: 12
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setFinancialManagementArea(String financialManagementArea) Constraints: Not nullable, Maximum length: 4
void	setFiscalYearVariant(String fiscalYearVariant) Constraints: Not nullable, Maximum length: 2
void	setProfitCenterAccountingCurrency(String profitCenterAccountingCurrency) Constraints: Not nullable, Maximum length: 5
void	setProfitCenterStandardHierarchy(String profitCenterStandardHierarchy) Constraints: Not nullable, Maximum length: 12
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.Entity

getField, getField, getFieldNames, hasField, hasField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONTROLLING_AREA

public static final EntityField<ControllingArea,String> CONTROLLING_AREA

Use with available fluent helpers to apply the ControllingArea field to query operations.

FISCAL_YEAR_VARIANT

public static final EntityField<ControllingArea,String> FISCAL_YEAR_VARIANT

Use with available fluent helpers to apply the FiscalYearVariant field to query operations.

CONTROLLING_AREA_NAME

public static final EntityField<ControllingArea,String> CONTROLLING_AREA_NAME

Use with available fluent helpers to apply the ControllingAreaName field to query operations.

CONTROLLING_AREA_CURRENCY

public static final EntityField<ControllingArea,String> CONTROLLING_AREA_CURRENCY

Use with available fluent helpers to apply the ControllingAreaCurrency field to query operations.

CHART_OF_ACCOUNTS

public static final EntityField<ControllingArea,String> CHART_OF_ACCOUNTS

Use with available fluent helpers to apply the ChartOfAccounts field to query operations.

COST_CENTER_STANDARD_HIERARCHY

public static final EntityField<ControllingArea,String> COST_CENTER_STANDARD_HIERARCHY

Use with available fluent helpers to apply the CostCenterStandardHierarchy field to query operations.

PROFIT_CENTER_STANDARD_HIERARCHY

public static final EntityField<ControllingArea,String> PROFIT_CENTER_STANDARD_HIERARCHY

Use with available fluent helpers to apply the ProfitCenterStandardHierarchy field to query operations.

FINANCIAL_MANAGEMENT_AREA

public static final EntityField<ControllingArea,String> FINANCIAL_MANAGEMENT_AREA

Use with available fluent helpers to apply the FinancialManagementArea field to query operations.

CONTROLLING_AREA_CURRENCY_ROLE

public static final EntityField<ControllingArea,String> CONTROLLING_AREA_CURRENCY_ROLE

Use with available fluent helpers to apply the ControllingAreaCurrencyRole field to query operations.

PROFIT_CENTER_ACCOUNTING_CURRENCY

public static final EntityField<ControllingArea,String> PROFIT_CENTER_ACCOUNTING_CURRENCY

Use with available fluent helpers to apply the ProfitCenterAccountingCurrency field to query operations.

Constructor Detail

ControllingArea

@Generated(value="lombok")
public ControllingArea()

ControllingArea

@ConstructorProperties(value={"controllingArea","fiscalYearVariant","controllingAreaName","controllingAreaCurrency","chartOfAccounts","costCenterStandardHierarchy","profitCenterStandardHierarchy","financialManagementArea","controllingAreaCurrencyRole","profitCenterAccountingCurrency","erpConfigContext"})
@Generated(value="lombok")
public ControllingArea(@Nullable
                                                         String controllingArea,
                                                         @Nullable
                                                         String fiscalYearVariant,
                                                         @Nullable
                                                         String controllingAreaName,
                                                         @Nullable
                                                         String controllingAreaCurrency,
                                                         @Nullable
                                                         String chartOfAccounts,
                                                         @Nullable
                                                         String costCenterStandardHierarchy,
                                                         @Nullable
                                                         String profitCenterStandardHierarchy,
                                                         @Nullable
                                                         String financialManagementArea,
                                                         @Nullable
                                                         String controllingAreaCurrencyRole,
                                                         @Nullable
                                                         String profitCenterAccountingCurrency,
                                                         ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<ControllingArea> getType()

Specified by:

getType in class Entity<ControllingArea>

Returns:

The class of this entity.

field

public static <T> EntityField<ControllingArea,T> field(String fieldName,
                                       Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

builder

@Generated(value="lombok")
public static ControllingArea.ControllingAreaBuilder builder()

getControllingArea

@Nullable
@Generated(value="lombok")
public String getControllingArea()

(Key Field) Constraints: Not nullable, Maximum length: 4

Returns:

Controlling Area

getFiscalYearVariant

@Nullable
@Generated(value="lombok")
public String getFiscalYearVariant()

Constraints: Not nullable, Maximum length: 2

Returns:

Fiscal Year Variant

getControllingAreaName

@Nullable
@Generated(value="lombok")
public String getControllingAreaName()

Constraints: Not nullable, Maximum length: 25

Returns:

Name of the controlling area

getControllingAreaCurrency

@Nullable
@Generated(value="lombok")
public String getControllingAreaCurrency()

Constraints: Not nullable, Maximum length: 5

Returns:

Currency key for amounts in the system.

getChartOfAccounts

@Nullable
@Generated(value="lombok")
public String getChartOfAccounts()

Constraints: Not nullable, Maximum length: 4

Returns:

Key that uniquely identifies a chart of accounts.

getCostCenterStandardHierarchy

@Nullable
@Generated(value="lombok")
public String getCostCenterStandardHierarchy()

Constraints: Not nullable, Maximum length: 12

Returns:

Indicated hierarchy of cost center groups in which all cost centers in a controlling area are gathered together. See standard hierarchy.

getProfitCenterStandardHierarchy

@Nullable
@Generated(value="lombok")
public String getProfitCenterStandardHierarchy()

Constraints: Not nullable, Maximum length: 12

The structural elements in the standard hierarchy are the profit center area and the summarization area. The profit center area is an end point in the tree structure which is not at the top and can have profit centers assigned to it when you maintain the standard hierarchy. The summarization area is used to summarize the data on the profit centers beneath it, although it does not itself contain any profit centers. By definition, the system always regards the profit center hierarchy which was entered when the controlling area was created as the standard hierarchy.

Returns:

The standard hierarchy is a tree structure which displays the organization of all the profit centers in one controlling area.

getFinancialManagementArea

@Nullable
@Generated(value="lombok")
public String getFinancialManagementArea()

Constraints: Not nullable, Maximum length: 4

An FM area is an organizational unit which plans, controls and monitors funds and commitment budgets.

Returns:

Key identifying an FM area.

getControllingAreaCurrencyRole

@Nullable
@Generated(value="lombok")
public String getControllingAreaCurrencyRole()

Constraints: Not nullable, Maximum length: 2

Returns:

Currency type defined for a controlling area.

getProfitCenterAccountingCurrency

@Nullable
@Generated(value="lombok")
public String getProfitCenterAccountingCurrency()

Constraints: Not nullable, Maximum length: 5

If you chose the group currency or controlling area currency as the currency type, leave the field "Report currency" blank. The system will determine the currency automatically when the transaction data is posted. When transaction data is posted to Profit Center Accounting, the system also posts the data using the currency specified in the fields "Currency type"/"Report currency". Note The standard reports for Profit Center Accounting display the selected values in this currency.

Returns:

If you chose the special profit center currency as the currency type for a controlling area, you need to specify that currency in this field.

getErpConfigContext

@Generated(value="lombok")
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setControllingArea

@Generated(value="lombok")
public void setControllingArea(@Nullable
                                     String controllingArea)

(Key Field) Constraints: Not nullable, Maximum length: 4

Parameters:

controllingArea -

setFiscalYearVariant

@Generated(value="lombok")
public void setFiscalYearVariant(@Nullable
                                       String fiscalYearVariant)

Constraints: Not nullable, Maximum length: 2

Parameters:

fiscalYearVariant -

setControllingAreaName

@Generated(value="lombok")
public void setControllingAreaName(@Nullable
                                         String controllingAreaName)

Constraints: Not nullable, Maximum length: 25

Parameters:

controllingAreaName -

setControllingAreaCurrency

@Generated(value="lombok")
public void setControllingAreaCurrency(@Nullable
                                             String controllingAreaCurrency)

Constraints: Not nullable, Maximum length: 5

Parameters:

controllingAreaCurrency -

setChartOfAccounts

@Generated(value="lombok")
public void setChartOfAccounts(@Nullable
                                     String chartOfAccounts)

Constraints: Not nullable, Maximum length: 4

Parameters:

chartOfAccounts -

setCostCenterStandardHierarchy

@Generated(value="lombok")
public void setCostCenterStandardHierarchy(@Nullable
                                                 String costCenterStandardHierarchy)

Constraints: Not nullable, Maximum length: 12

Parameters:

costCenterStandardHierarchy -

setProfitCenterStandardHierarchy

@Generated(value="lombok")
public void setProfitCenterStandardHierarchy(@Nullable
                                                   String profitCenterStandardHierarchy)

Constraints: Not nullable, Maximum length: 12

The structural elements in the standard hierarchy are the profit center area and the summarization area. The profit center area is an end point in the tree structure which is not at the top and can have profit centers assigned to it when you maintain the standard hierarchy. The summarization area is used to summarize the data on the profit centers beneath it, although it does not itself contain any profit centers. By definition, the system always regards the profit center hierarchy which was entered when the controlling area was created as the standard hierarchy.

Parameters:

profitCenterStandardHierarchy -

setFinancialManagementArea

@Generated(value="lombok")
public void setFinancialManagementArea(@Nullable
                                             String financialManagementArea)

Constraints: Not nullable, Maximum length: 4

An FM area is an organizational unit which plans, controls and monitors funds and commitment budgets.

Parameters:

financialManagementArea -

setControllingAreaCurrencyRole

@Generated(value="lombok")
public void setControllingAreaCurrencyRole(@Nullable
                                                 String controllingAreaCurrencyRole)

Constraints: Not nullable, Maximum length: 2

Parameters:

controllingAreaCurrencyRole -

setProfitCenterAccountingCurrency

@Generated(value="lombok")
public void setProfitCenterAccountingCurrency(@Nullable
                                                    String profitCenterAccountingCurrency)

Constraints: Not nullable, Maximum length: 5

If you chose the group currency or controlling area currency as the currency type, leave the field "Report currency" blank. The system will determine the currency automatically when the transaction data is posted. When transaction data is posted to Profit Center Accounting, the system also posts the data using the currency specified in the fields "Currency type"/"Report currency". Note The standard reports for Profit Center Accounting display the selected values in this currency.

Parameters:

profitCenterAccountingCurrency -

setErpConfigContext

@Generated(value="lombok")
public void setErpConfigContext(ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class Entity<ControllingArea>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Entity<ControllingArea>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Entity<ControllingArea>