public class Characteristic extends VdmEntity<Characteristic>
Original entity name from the Odata EDM: CharacteristicType
Modifier and Type | Class and Description |
---|---|
static class |
Characteristic.CharacteristicBuilder
Helper class to allow for fluent creation of Characteristic instances.
|
Modifier and Type | Field and Description |
---|---|
static CharacteristicSelectable |
ALL_FIELDS
Selector for all available fields of Characteristic.
|
static CharacteristicField<String> |
CHANGE_NUMBER
Use with available fluent helpers to apply the ChangeNumber field to query operations.
|
static CharacteristicField<String> |
CHARACTERISTIC
Use with available fluent helpers to apply the Characteristic field to query operations.
|
static CharacteristicField<String> |
CHARC_DATA_TYPE
Use with available fluent helpers to apply the CharcDataType field to query operations.
|
static CharacteristicField<String> |
CHARC_INTERNAL_ID
Use with available fluent helpers to apply the CharcInternalID field to query operations.
|
static CharacteristicField<String> |
CLASS_CLASSFCTN_AUTH_GRP
Use with available fluent helpers to apply the ClassClassfctnAuthGrp field to query operations.
|
static CharacteristicField<String> |
CLASS_INTERNAL_ID
Use with available fluent helpers to apply the ClassInternalID field to query operations.
|
static CharacteristicField<String> |
CLASS_MAINT_AUTH_GRP
Use with available fluent helpers to apply the ClassMaintAuthGrp field to query operations.
|
static CharacteristicField<String> |
CLASS_TYPE
Use with available fluent helpers to apply the ClassType field to query operations.
|
static CharacteristicField<String> |
FUNCTIONAL_LOCATION
Use with available fluent helpers to apply the FunctionalLocation field to query operations.
|
static CharacteristicField<String> |
FUNCTIONAL_LOCATION_LABEL_NAME
Use with available fluent helpers to apply the FunctionalLocationLabelName field to query operations.
|
static CharacteristicField<LocalDateTime> |
KEY_DATE
Use with available fluent helpers to apply the KeyDate field to query operations.
|
static CharacteristicOneToOneLink<FunctionalLocationClass> |
TO_CLASS
Use with available fluent helpers to apply the to_Class navigation property to query operations.
|
static CharacteristicLink<Value> |
TO_VALUE
Use with available fluent helpers to apply the to_Value navigation property to query operations.
|
changedOriginalFields
Constructor and Description |
---|
Characteristic() |
Characteristic(String functionalLocation,
String classInternalID,
String charcInternalID,
String functionalLocationLabelName,
String characteristic,
String charcDataType,
LocalDateTime keyDate,
String changeNumber,
String classType,
String classMaintAuthGrp,
String classClassfctnAuthGrp,
FunctionalLocationClass toClass,
List<Value> toValue) |
Modifier and Type | Method and Description |
---|---|
void |
addValue(Value... entity)
Adds elements to the list of associated Value entities.
|
void |
attachToService(String servicePath,
HttpDestinationProperties destination)
Sets the service path and destination for the fetch commands of this entity.
|
static Characteristic.CharacteristicBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
FunctionalLocationClass |
fetchClassObjects()
Fetches the FunctionalLocationClass entity (one to one) associated with this entity.
|
List<Value> |
fetchValue()
Fetches the Value entities (one to many) associated with this entity.
|
static <T> CharacteristicField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
static <T,DomainT> |
field(String fieldName,
TypeConverter<T,DomainT> typeConverter)
Use with available fluent helpers to apply an extension field to query operations.
|
protected void |
fromMap(Map<String,Object> inputValues) |
String |
getChangeNumber()
Constraints: Not nullable, Maximum length: 12
|
String |
getCharacteristic()
Constraints: Not nullable, Maximum length: 30
|
String |
getCharcDataType()
Constraints: Not nullable, Maximum length: 4
|
String |
getCharcInternalID()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
String |
getClassClassfctnAuthGrp()
Constraints: Not nullable, Maximum length: 3
|
String |
getClassInternalID()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
String |
getClassMaintAuthGrp()
Constraints: Not nullable, Maximum length: 3
|
io.vavr.control.Option<FunctionalLocationClass> |
getClassObjectsIfPresent()
Retrieval of associated FunctionalLocationClass entity (one to one).
|
FunctionalLocationClass |
getClassObjectsOrFetch()
Retrieval of associated FunctionalLocationClass entity (one to one).
|
String |
getClassType()
Constraints: Not nullable, Maximum length: 3
|
protected String |
getDefaultServicePath()
Used by fluent helpers and navigation property methods to construct OData queries.
|
HttpDestinationProperties |
getDestinationForFetch()
Convienence field for reusing the same destination with multiple queries (e.g.
|
protected String |
getEntityCollection()
Used by fluent helpers and navigation property methods to construct OData queries.
|
String |
getFunctionalLocation()
(Key Field) Constraints: Not nullable, Maximum length: 90
|
String |
getFunctionalLocationLabelName()
Constraints: Not nullable, Maximum length: 40
|
protected Map<String,Object> |
getKey() |
LocalDateTime |
getKeyDate()
Constraints: Not nullable, Precision: 0
|
Class<Characteristic> |
getType() |
io.vavr.control.Option<List<Value>> |
getValueIfPresent()
Retrieval of associated Value entities (one to many).
|
List<Value> |
getValueOrFetch()
Retrieval of associated Value entities (one to many).
|
int |
hashCode() |
void |
setChangeNumber(String changeNumber)
Constraints: Not nullable, Maximum length: 12
|
void |
setCharacteristic(String characteristic)
Constraints: Not nullable, Maximum length: 30
|
void |
setCharcDataType(String charcDataType)
Constraints: Not nullable, Maximum length: 4
|
void |
setCharcInternalID(String charcInternalID)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
void |
setClassClassfctnAuthGrp(String classClassfctnAuthGrp)
Constraints: Not nullable, Maximum length: 3
|
void |
setClassInternalID(String classInternalID)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
void |
setClassMaintAuthGrp(String classMaintAuthGrp)
Constraints: Not nullable, Maximum length: 3
|
void |
setClassObjects(FunctionalLocationClass value)
Overwrites the associated FunctionalLocationClass entity for the loaded navigation property
to_Class.
|
void |
setClassType(String classType)
Constraints: Not nullable, Maximum length: 3
|
void |
setFunctionalLocation(String functionalLocation)
(Key Field) Constraints: Not nullable, Maximum length: 90
|
void |
setFunctionalLocationLabelName(String functionalLocationLabelName)
Constraints: Not nullable, Maximum length: 40
|
void |
setKeyDate(LocalDateTime keyDate)
Constraints: Not nullable, Precision: 0
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
void |
setValue(List<Value> value)
Overwrites the list of associated Value entities for the loaded navigation property to_Value.
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final CharacteristicSelectable ALL_FIELDS
public static final CharacteristicField<String> FUNCTIONAL_LOCATION
public static final CharacteristicField<String> CLASS_INTERNAL_ID
public static final CharacteristicField<String> CHARC_INTERNAL_ID
public static final CharacteristicField<String> FUNCTIONAL_LOCATION_LABEL_NAME
public static final CharacteristicField<String> CHARACTERISTIC
public static final CharacteristicField<String> CHARC_DATA_TYPE
public static final CharacteristicField<LocalDateTime> KEY_DATE
public static final CharacteristicField<String> CHANGE_NUMBER
public static final CharacteristicField<String> CLASS_TYPE
public static final CharacteristicField<String> CLASS_MAINT_AUTH_GRP
public static final CharacteristicField<String> CLASS_CLASSFCTN_AUTH_GRP
public static final CharacteristicOneToOneLink<FunctionalLocationClass> TO_CLASS
public static final CharacteristicLink<Value> TO_VALUE
public Characteristic()
public Characteristic(@Nullable String functionalLocation, @Nullable String classInternalID, @Nullable String charcInternalID, @Nullable String functionalLocationLabelName, @Nullable String characteristic, @Nullable String charcDataType, @Nullable LocalDateTime keyDate, @Nullable String changeNumber, @Nullable String classType, @Nullable String classMaintAuthGrp, @Nullable String classClassfctnAuthGrp, @Nullable FunctionalLocationClass toClass, List<Value> toValue)
@Nonnull public Class<Characteristic> getType()
getType
in class VdmObject<Characteristic>
public void setFunctionalLocation(@Nullable String functionalLocation)
Original property name from the Odata EDM: FunctionalLocation
functionalLocation
- Key of Object to be Classifiedpublic void setClassInternalID(@Nullable String classInternalID)
Original property name from the Odata EDM: ClassInternalID
classInternalID
- Internal Class Numberpublic void setCharcInternalID(@Nullable String charcInternalID)
Original property name from the Odata EDM: CharcInternalID
charcInternalID
- Characteristic Internal IDpublic void setFunctionalLocationLabelName(@Nullable String functionalLocationLabelName)
Original property name from the Odata EDM: FunctionalLocationLabelName
The functional location label can be changed where necessary. The system then automatically creates a labeling history and prevents historical labels from being reused without this first being checked. The labeling history also enables the interpretation of historical location labels in non-changeable documents outside the SAP System.You can assign one primary and several alternative labels to a functional location.
functionalLocationLabelName
- The label is used to identify a functional location from a user's point of view.public void setCharacteristic(@Nullable String characteristic)
Original property name from the Odata EDM: Characteristic
characteristic
- Name that uniquely identifies a characteristic.public void setCharcDataType(@Nullable String charcDataType)
Original property name from the Odata EDM: CharcDataType
The data type defines whether a characteristic value is a character string, a number, a date, or a time.
charcDataType
- Data type of a characteristic's values.public void setKeyDate(@Nullable LocalDateTime keyDate)
Original property name from the Odata EDM: KeyDate
keyDate
- The keyDate to set.public void setChangeNumber(@Nullable String changeNumber)
Original property name from the Odata EDM: ChangeNumber
If you make a change with reference to a change number, or create an object with a change number, the following functions are at your disposal:The system determines the validity conditionsThe conditions that the change is effective under can be defined in the change master record as follows:Changes with a date validity (valid-from date)Changes with parameter effectivity (for example: serial no. effectivity)Log of the changes madeDocumentation of the changesAssignment of a revision level to a change state of a material or documentRelease of changes for the different areas in the company
changeNumber
- Number used to uniquely identify a change master record.public void setClassType(@Nullable String classType)
Original property name from the Odata EDM: ClassType
classType
- Uniquely identifies the class typepublic void setClassMaintAuthGrp(@Nullable String classMaintAuthGrp)
Original property name from the Odata EDM: ClassMaintAuthGrp
This authorization must be defined in the user master record. The authorization object is BGRKP.
classMaintAuthGrp
- Authorization key that determines whether a user is allowed to maintain this class.public void setClassClassfctnAuthGrp(@Nullable String classClassfctnAuthGrp)
Original property name from the Odata EDM: ClassClassfctnAuthGrp
This authorization must be defined in the user master record. The authorization object is BGRKL.
classClassfctnAuthGrp
- Authorization key: determines whether a user is allowed to assign objects to this class.protected String getEntityCollection()
VdmEntity
getEntityCollection
in class VdmEntity<Characteristic>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<Characteristic>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<Characteristic>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<Characteristic>
@Nonnull public static <T> CharacteristicField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.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.@Nonnull public static <T,DomainT> CharacteristicField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public HttpDestinationProperties getDestinationForFetch()
VdmEntity
getDestinationForFetch
in class VdmEntity<Characteristic>
protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.
setServicePathForFetch
in class VdmEntity<Characteristic>
public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
VdmEntity
Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.
attachToService
in class VdmEntity<Characteristic>
servicePath
- Optional parameter. New service path to apply to this entity and any associated entities that were
previously fetched. If a null value is provided and the service path has never been set, then the
service path will be set to the default defined in the corresponding service interface.destination
- New destination to apply to this entity and any associated entities that were previously fetched.protected String getDefaultServicePath()
VdmEntity
getDefaultServicePath
in class VdmEntity<Characteristic>
protocol://hostname:port
and the OData resource name (entity set, $metadata
, etc.)@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<Characteristic>
@Nullable public FunctionalLocationClass fetchClassObjects() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
null
if an entity is not
associated.com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and
therefore has no ERP configuration context assigned. An entity is managed if it has been either
retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or
UPDATE call.@Nullable public FunctionalLocationClass getClassObjectsOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_Class of a queried Characteristic is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and
therefore has no ERP configuration context assigned. An entity is managed if it has been either
retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or
UPDATE call.@Nonnull public io.vavr.control.Option<FunctionalLocationClass> getClassObjectsIfPresent()
If the navigation property for an entity Characteristic has not been resolved yet, this method will not
query further information. Instead its Option
result state will be empty
.
Option
with result state
empty
is returned.public void setClassObjects(FunctionalLocationClass value)
value
- New FunctionalLocationClass entity.@Nonnull public List<Value> fetchValue() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and
therefore has no ERP configuration context assigned. An entity is managed if it has been either
retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or
UPDATE call.@Nonnull public List<Value> getValueOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_Value of a queried Characteristic is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and
therefore has no ERP configuration context assigned. An entity is managed if it has been either
retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or
UPDATE call.@Nonnull public io.vavr.control.Option<List<Value>> getValueIfPresent()
If the navigation property for an entity Characteristic has not been resolved yet, this method will not
query further information. Instead its Option
result state will be empty
.
Option
with result state empty
is returned.public void setValue(@Nonnull List<Value> value)
If the navigation property to_Value of a queried Characteristic is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
value
- List of Value entities.public void addValue(Value... entity)
If the navigation property to_Value of a queried Characteristic is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
entity
- Array of Value entities.@Nonnull public static Characteristic.CharacteristicBuilder builder()
@Nullable public String getFunctionalLocation()
Original property name from the Odata EDM: FunctionalLocation
@Nullable public String getClassInternalID()
Original property name from the Odata EDM: ClassInternalID
@Nullable public String getCharcInternalID()
Original property name from the Odata EDM: CharcInternalID
@Nullable public String getFunctionalLocationLabelName()
Original property name from the Odata EDM: FunctionalLocationLabelName
The functional location label can be changed where necessary. The system then automatically creates a labeling history and prevents historical labels from being reused without this first being checked. The labeling history also enables the interpretation of historical location labels in non-changeable documents outside the SAP System.You can assign one primary and several alternative labels to a functional location.
@Nullable public String getCharacteristic()
Original property name from the Odata EDM: Characteristic
@Nullable public String getCharcDataType()
Original property name from the Odata EDM: CharcDataType
The data type defines whether a characteristic value is a character string, a number, a date, or a time.
@Nullable public LocalDateTime getKeyDate()
Original property name from the Odata EDM: KeyDate
@Nullable public String getChangeNumber()
Original property name from the Odata EDM: ChangeNumber
If you make a change with reference to a change number, or create an object with a change number, the following functions are at your disposal:The system determines the validity conditionsThe conditions that the change is effective under can be defined in the change master record as follows:Changes with a date validity (valid-from date)Changes with parameter effectivity (for example: serial no. effectivity)Log of the changes madeDocumentation of the changesAssignment of a revision level to a change state of a material or documentRelease of changes for the different areas in the company
@Nullable public String getClassType()
Original property name from the Odata EDM: ClassType
@Nullable public String getClassMaintAuthGrp()
Original property name from the Odata EDM: ClassMaintAuthGrp
This authorization must be defined in the user master record. The authorization object is BGRKP.
@Nullable public String getClassClassfctnAuthGrp()
Original property name from the Odata EDM: ClassClassfctnAuthGrp
This authorization must be defined in the user master record. The authorization object is BGRKL.
@Nonnull public String toString()
toString
in class VdmObject<Characteristic>
public boolean equals(@Nullable Object o)
equals
in class VdmObject<Characteristic>
protected boolean canEqual(@Nullable Object other)
canEqual
in class VdmObject<Characteristic>
public int hashCode()
hashCode
in class VdmObject<Characteristic>
Copyright © 2020 SAP SE. All rights reserved.