com.sap.cloud.sdk.s4hana.serialization

Class ObjectNumber

java.lang.Object

com.sap.cloud.sdk.s4hana.serialization.StringBasedErpType<ObjectNumber>

com.sap.cloud.sdk.s4hana.serialization.ObjectNumber

All Implemented Interfaces:

ErpType<ObjectNumber>, StringRepresentableKey, Serializable, Comparable<ObjectNumber>

public class ObjectNumber
extends StringBasedErpType<ObjectNumber>

Representation of an object number (OBJNR).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectNumber.ObjectNumberType An enum representing the source, from which the ObjectNumber was created.

Nested classes/interfaces inherited from class com.sap.cloud.sdk.s4hana.serialization.StringBasedErpType

StringBasedErpType.CharCasing, StringBasedErpType.FillCharStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectNumber	EMPTY An empty, uninitialized ObjectNumber.

Constructor Summary

Constructors

Constructor and Description
ObjectNumber(ControllingArea controllingArea, CostCenter costCenter) Constructs an object number for a controlling area and cost center.
ObjectNumber(ControllingArea controllingArea, ProfitCenter profitCenter) Constructs an object number for a profit center.
ObjectNumber(InternalOrder internalOrder) Constructs an object number for an internal order.
ObjectNumber(String value) Constructs an object number based on the given String.

Method Summary

Modifier and Type	Method and Description
Optional<ControllingArea>	getControllingArea() Getter wrapping the contained ControllingArea into an Optional.
Optional<CostCenter>	getCostCenter() Getter wrapping the contained CostCenter into an Optional.
StringBasedErpType.FillCharStrategy	getFillCharStrategy()
Optional<InternalOrder>	getInternalOrder() Getter wrapping the contained InternalOrder into an Optional.
int	getMaxLength()
ObjectNumber.ObjectNumberType	getObjectNumberType()
Optional<ProfitCenter>	getProfitCenter() Getter wrapping the contained ProfitCenter into an Optional.
Class<ObjectNumber>	getType()
ErpTypeConverter<ObjectNumber>	getTypeConverter()
static ObjectNumber	of(String value) Transforms the given String to an ObjectNumber instance.
static Set<ObjectNumber>	toObjectNumbers(Collection<String> values) Transforms the given collection of Strings into a set of ObjectNumbers by using an ObjectNumberConverter.
static Set<String>	toStrings(Collection<? extends ObjectNumber> values) Transforms the given collection of ObjectNumbers into a set of Strings by using an ObjectNumberConverter.

Methods inherited from class com.sap.cloud.sdk.s4hana.serialization.StringBasedErpType

canEqual, compareTo, equals, getFillChar, getKeyAsString, getValue, hashCode, isDefault, isEmpty, toString, toString, transformToString, transformToType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final ObjectNumber EMPTY

An empty, uninitialized ObjectNumber.

Constructor Detail

ObjectNumber

public ObjectNumber(String value)
             throws IllegalArgumentException

Constructs an object number based on the given String.

Parameters:

value - The String to create the ObjectNumber for.

Throws:

IllegalArgumentException - If the given String cannot be converted to an ObjectNumber.

ObjectNumber

public ObjectNumber(ControllingArea controllingArea,
                    CostCenter costCenter)
             throws IllegalArgumentException

Constructs an object number for a controlling area and cost center.

Parameters:

controllingArea - The ControllingArea the CostCenter is assigned to.

costCenter - The CostCenter to create the ObjectNumber for.

Throws:

IllegalArgumentException - If the given ControllingArea and CostCenter cannot be converted to an ObjectNumber.

ObjectNumber

public ObjectNumber(ControllingArea controllingArea,
                    ProfitCenter profitCenter)
             throws IllegalArgumentException

Constructs an object number for a profit center.

Parameters:

controllingArea - The ControllingArea the ProfitCenter is assigned to.

profitCenter - The ProfitCenter to create the ObjectNumber for.

Throws:

IllegalArgumentException - If the given ControllingArea and ProfitCenter cannot be converted to an ObjectNumber.

ObjectNumber

public ObjectNumber(InternalOrder internalOrder)
             throws IllegalArgumentException

Constructs an object number for an internal order.

Parameters:

internalOrder - The InternalOrder to create the ObjectNumber for.

Throws:

IllegalArgumentException - If the given InternalOrder cannot be converted to an ObjectNumber.

Method Detail

of

@Nullable
public static ObjectNumber of(@Nullable
                                        String value)
                                 throws IllegalArgumentException

Transforms the given String to an ObjectNumber instance. This is null-safe, so if value is null, this method also returns null.

Parameters:

value - The String to transform.

Returns:

An ObjectNumber based on the given String, or null, if the String is null.

Throws:

IllegalArgumentException - If the given String cannot be converted to an ObjectNumber.

getControllingArea

public Optional<ControllingArea> getControllingArea()

Getter wrapping the contained ControllingArea into an Optional.

Returns:

An Optional containing the ControllingArea.

getCostCenter

public Optional<CostCenter> getCostCenter()

Getter wrapping the contained CostCenter into an Optional.

Returns:

An Optional containing the CostCenter.

getInternalOrder

public Optional<InternalOrder> getInternalOrder()

Getter wrapping the contained InternalOrder into an Optional.

Returns:

An Optional containing the InternalOrder.

getProfitCenter

public Optional<ProfitCenter> getProfitCenter()

Getter wrapping the contained ProfitCenter into an Optional.

Returns:

An Optional containing the ProfitCenter.

getTypeConverter

@Nonnull
public ErpTypeConverter<ObjectNumber> getTypeConverter()

getType

@Nonnull
public Class<ObjectNumber> getType()

Specified by:

getType in class StringBasedErpType<ObjectNumber>

Returns:

The class of the string-based ERP type.

getMaxLength

public final int getMaxLength()

Specified by:

getMaxLength in class StringBasedErpType<ObjectNumber>

Returns:

The maximum length of the string-based ERP type.

getFillCharStrategy

@Nonnull
public final StringBasedErpType.FillCharStrategy getFillCharStrategy()

Specified by:

getFillCharStrategy in class StringBasedErpType<ObjectNumber>

Returns:

The strategy of how the type should handle fill characters.

toObjectNumbers

public static Set<ObjectNumber> toObjectNumbers(Collection<String> values)

Transforms the given collection of Strings into a set of ObjectNumbers by using an ObjectNumberConverter.

Parameters:

values - The String values to transform.

Returns:

A Set containing the created ObjectNumbers

toStrings

public static Set<String> toStrings(Collection<? extends ObjectNumber> values)

Transforms the given collection of ObjectNumbers into a set of Strings by using an ObjectNumberConverter.

Parameters:

values - The ObjectNumbers to transform.

Returns:

A Set containing the created Strings.

getObjectNumberType

public ObjectNumber.ObjectNumberType getObjectNumberType()