Class ContractMarketingHeader
- All Implemented Interfaces:
VdmEntitySet
Original entity name from the Odata EDM: ContractMarketingHeader_Type
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classHelper class to allow for fluent creation of ContractMarketingHeader instances. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ComplexProperty.Collection<ContractMarketingHeader,SAP__Message> Use with available request builders to apply the SAP__Messages complex property to query operations.static final SimpleProperty<ContractMarketingHeader>Selector for all available fields of ContractMarketingHeader.static final SimpleProperty.String<ContractMarketingHeader>static final SimpleProperty.String<ContractMarketingHeader>static final SimpleProperty.Date<ContractMarketingHeader>static final SimpleProperty.Date<ContractMarketingHeader>static final SimpleProperty.String<ContractMarketingHeader>static final SimpleProperty.String<ContractMarketingHeader>static final SimpleProperty.String<ContractMarketingHeader>static final SimpleProperty.DateTime<ContractMarketingHeader>static final SimpleProperty.String<ContractMarketingHeader>Use with available request builders to apply the _PRAContrMarketingDetTP navigation property to query operations.static final SimpleProperty.String<ContractMarketingHeader>static final SimpleProperty.String<ContractMarketingHeader>Fields inherited from class com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject
changedOriginalFields, ODATA_TYPE_ANNOTATIONS, ODATA_VERSION_ANNOTATIONS -
Constructor Summary
ConstructorsConstructorDescriptionContractMarketingHeader(String pRAContract, String measurementPoint, String well, String wellCompletion, String pRAMaterial, LocalDate effectiveFromDate, LocalDate effectiveToDate, String contractMarketingCostControl, String createdByUser, OffsetDateTime pRACreationDateTime, String originTransaction, Collection<SAP__Message> _Messages, List<ContractMarketingDetail> to_PRAContrMarketingDetTP) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddPRAContrMarketingDetTP(ContractMarketingDetail... entity) Adds elements to the list of associated ContractMarketingDetail entities.builder()protected booleanbooleanprotected voidConstraints: Not nullableConstraints: Not nullable, Maximum length: 12Constraints: Not nullable, Maximum length: 12protected String(Key Field) Constraints: Not nullable(Key Field) Constraints: Not nullableprotected Stringprotected ODataEntityKeygetKey()(Key Field) Constraints: Not nullable, Maximum length: 20Constraints: Not nullable, Maximum length: 32(Key Field) Constraints: Not nullable, Maximum length: 10io.vavr.control.Option<List<ContractMarketingDetail>>Retrieval of associated ContractMarketingDetail entities (one to many).Constraints: Nullable(Key Field) Constraints: Not nullable, Maximum length: 18getType()getWell()(Key Field) Constraints: Not nullable, Maximum length: 15(Key Field) Constraints: Not nullable, Maximum length: 5inthashCode()voidset_Messages(Collection<SAP__Message> _Messages) Constraints: Not nullablevoidsetContractMarketingCostControl(String contractMarketingCostControl) Constraints: Not nullable, Maximum length: 12voidsetCreatedByUser(String createdByUser) Constraints: Not nullable, Maximum length: 12voidsetEffectiveFromDate(LocalDate effectiveFromDate) (Key Field) Constraints: Not nullablevoidsetEffectiveToDate(LocalDate effectiveToDate) (Key Field) Constraints: Not nullablevoidsetMeasurementPoint(String measurementPoint) (Key Field) Constraints: Not nullable, Maximum length: 20voidsetOriginTransaction(String originTransaction) Constraints: Not nullable, Maximum length: 32voidsetPRAContract(String pRAContract) (Key Field) Constraints: Not nullable, Maximum length: 10voidOverwrites the list of associated ContractMarketingDetail entities for the loaded navigation property _PRAContrMarketingDetTP.voidsetPRACreationDateTime(OffsetDateTime pRACreationDateTime) Constraints: NullablevoidsetPRAMaterial(String pRAMaterial) (Key Field) Constraints: Not nullable, Maximum length: 18void(Key Field) Constraints: Not nullable, Maximum length: 15voidsetWellCompletion(String wellCompletion) (Key Field) Constraints: Not nullable, Maximum length: 5toString()updateContractMarketingHeader(String pRAContract, String measurementPoint, String well, String wellCompletion, String pRAMaterial, LocalDate effectiveFromDate, LocalDate effectiveToDate, String contractMarketingCostControl, Collection<D_PRAContrMktgCostDetUpdtP> _PRAContrMarketingDetTP) Action that can be applied to a collection of entities of this class.Methods inherited from class com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity
all, attachToService, getDestinationForFetch, getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setServicePathForFetch, setVersionIdentifierMethods inherited from class com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject
getAnnotationProperties, getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
-
Field Details
-
ALL_FIELDS
Selector for all available fields of ContractMarketingHeader. -
PRA_CONTRACT
-
MEASUREMENT_POINT
-
WELL
-
WELL_COMPLETION
-
PRA_MATERIAL
-
EFFECTIVE_FROM_DATE
-
EFFECTIVE_TO_DATE
-
CONTRACT_MARKETING_COST_CONTROL
-
CREATED_BY_USER
-
PRA_CREATION_DATE_TIME
-
ORIGIN_TRANSACTION
-
_MESSAGES
Use with available request builders to apply the SAP__Messages complex property to query operations. -
TO__P_R_A_CONTR_MARKETING_DET_TP
public static final NavigationProperty.Collection<ContractMarketingHeader,ContractMarketingDetail> TO__P_R_A_CONTR_MARKETING_DET_TPUse with available request builders to apply the _PRAContrMarketingDetTP navigation property to query operations.
-
-
Constructor Details
-
ContractMarketingHeader
public ContractMarketingHeader() -
ContractMarketingHeader
public ContractMarketingHeader(@Nullable String pRAContract, @Nullable String measurementPoint, @Nullable String well, @Nullable String wellCompletion, @Nullable String pRAMaterial, @Nullable LocalDate effectiveFromDate, @Nullable LocalDate effectiveToDate, @Nullable String contractMarketingCostControl, @Nullable String createdByUser, @Nullable OffsetDateTime pRACreationDateTime, @Nullable String originTransaction, @Nullable Collection<SAP__Message> _Messages, List<ContractMarketingDetail> to_PRAContrMarketingDetTP)
-
-
Method Details
-
getType
- Specified by:
getTypein classVdmObject<ContractMarketingHeader>
-
setPRAContract
(Key Field) Constraints: Not nullable, Maximum length: 10Original property name from the Odata EDM: PRAContract
- Parameters:
pRAContract- Contract Number
-
setMeasurementPoint
(Key Field) Constraints: Not nullable, Maximum length: 20Original property name from the Odata EDM: MeasurementPoint
- Parameters:
measurementPoint- Measurement point number
-
setWell
(Key Field) Constraints: Not nullable, Maximum length: 15Original property name from the Odata EDM: Well
- Parameters:
well- Well ID number
-
setWellCompletion
(Key Field) Constraints: Not nullable, Maximum length: 5Original property name from the Odata EDM: WellCompletion
- Parameters:
wellCompletion- Well Completion Number
-
setPRAMaterial
(Key Field) Constraints: Not nullable, Maximum length: 18Original property name from the Odata EDM: PRAMaterial
- Parameters:
pRAMaterial- Material Number
-
setEffectiveFromDate
(Key Field) Constraints: Not nullableOriginal property name from the Odata EDM: EffectiveFromDate
- Parameters:
effectiveFromDate- Effective from date
-
setEffectiveToDate
(Key Field) Constraints: Not nullableOriginal property name from the Odata EDM: EffectiveToDate
- Parameters:
effectiveToDate- Effective To Date
-
setContractMarketingCostControl
Constraints: Not nullable, Maximum length: 12Original property name from the Odata EDM: ContractMarketingCostControl
- Parameters:
contractMarketingCostControl- Contract Marketing Cost Control
-
setCreatedByUser
Constraints: Not nullable, Maximum length: 12Original property name from the Odata EDM: CreatedByUser
- Parameters:
createdByUser- Name of Person Responsible for Creating the Object
-
setPRACreationDateTime
Constraints: NullableOriginal property name from the Odata EDM: PRACreationDateTime
- Parameters:
pRACreationDateTime- UTC Time Stamp in Short Form (YYYYMMDDhhmmss)
-
setOriginTransaction
Constraints: Not nullable, Maximum length: 32Original property name from the Odata EDM: OriginTransaction
- Parameters:
originTransaction- Source Transaction ID
-
set_Messages
Constraints: Not nullableOriginal property name from the Odata EDM: SAP__Messages
- Parameters:
_Messages- The _Messages to set.
-
getEntityCollection
- Specified by:
getEntityCollectionin classVdmEntity<ContractMarketingHeader>
-
getKey
- Overrides:
getKeyin classVdmObject<ContractMarketingHeader>
-
toMapOfFields
- Overrides:
toMapOfFieldsin classVdmObject<ContractMarketingHeader>
-
fromMap
- Overrides:
fromMapin classVdmObject<ContractMarketingHeader>
-
getDefaultServicePath
- Overrides:
getDefaultServicePathin classVdmEntity<ContractMarketingHeader>
-
getPRAContrMarketingDetTPIfPresent
@Nonnull public io.vavr.control.Option<List<ContractMarketingDetail>> getPRAContrMarketingDetTPIfPresent()Retrieval of associated ContractMarketingDetail entities (one to many). This corresponds to the OData navigation property _PRAContrMarketingDetTP.If the navigation property for an entity ContractMarketingHeader has not been resolved yet, this method will not query further information. Instead its
Optionresult state will beempty.- Returns:
- If the information for navigation property _PRAContrMarketingDetTP is already loaded, the result
will contain the ContractMarketingDetail entities. If not, an
Optionwith result stateemptyis returned.
-
setPRAContrMarketingDetTP
Overwrites the list of associated ContractMarketingDetail entities for the loaded navigation property _PRAContrMarketingDetTP.If the navigation property _PRAContrMarketingDetTP of a queried ContractMarketingHeader 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.
- Parameters:
value- List of ContractMarketingDetail entities.
-
addPRAContrMarketingDetTP
Adds elements to the list of associated ContractMarketingDetail entities. This corresponds to the OData navigation property _PRAContrMarketingDetTP.If the navigation property _PRAContrMarketingDetTP of a queried ContractMarketingHeader 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.
- Parameters:
entity- Array of ContractMarketingDetail entities.
-
updateContractMarketingHeader
@Nonnull public static BoundAction.CollectionToCollection<ContractMarketingHeader,UpdateWithPRAKeysResult_Type> updateContractMarketingHeader(@Nonnull String pRAContract, @Nonnull String measurementPoint, @Nonnull String well, @Nonnull String wellCompletion, @Nonnull String pRAMaterial, @Nullable LocalDate effectiveFromDate, @Nullable LocalDate effectiveToDate, @Nonnull String contractMarketingCostControl, @Nonnull Collection<D_PRAContrMktgCostDetUpdtP> _PRAContrMarketingDetTP) Action that can be applied to a collection of entities of this class.- Parameters:
pRAMaterial- Constraints: Not nullable, Maximum length: 40Original parameter name from the Odata EDM: PRAMaterial
pRAContract- Constraints: Not nullable, Maximum length: 10Original parameter name from the Odata EDM: PRAContract
_PRAContrMarketingDetTP- Constraints: Not nullableOriginal parameter name from the Odata EDM: _PRAContrMarketingDetTP
effectiveToDate- Constraints: NullableOriginal parameter name from the Odata EDM: EffectiveToDate
well- Constraints: Not nullable, Maximum length: 15Original parameter name from the Odata EDM: Well
contractMarketingCostControl- Constraints: Not nullable, Maximum length: 12Original parameter name from the Odata EDM: ContractMarketingCostControl
effectiveFromDate- Constraints: NullableOriginal parameter name from the Odata EDM: EffectiveFromDate
measurementPoint- Constraints: Not nullable, Maximum length: 20Original parameter name from the Odata EDM: MeasurementPoint
wellCompletion- Constraints: Not nullable, Maximum length: 5Original parameter name from the Odata EDM: WellCompletion
- Returns:
- Action object prepared with the given parameters to be applied to a collection of entities of this class.
To execute it use the
service.forEntity(entity).applyAction(thisAction)API.
-
builder
-
getPRAContract
(Key Field) Constraints: Not nullable, Maximum length: 10Original property name from the Odata EDM: PRAContract
- Returns:
- Contract Number
-
getMeasurementPoint
(Key Field) Constraints: Not nullable, Maximum length: 20Original property name from the Odata EDM: MeasurementPoint
- Returns:
- Measurement point number
-
getWell
(Key Field) Constraints: Not nullable, Maximum length: 15Original property name from the Odata EDM: Well
- Returns:
- Well ID number
-
getWellCompletion
(Key Field) Constraints: Not nullable, Maximum length: 5Original property name from the Odata EDM: WellCompletion
- Returns:
- Well Completion Number
-
getPRAMaterial
(Key Field) Constraints: Not nullable, Maximum length: 18Original property name from the Odata EDM: PRAMaterial
- Returns:
- Material Number
-
getEffectiveFromDate
(Key Field) Constraints: Not nullableOriginal property name from the Odata EDM: EffectiveFromDate
- Returns:
- Effective from date
-
getEffectiveToDate
(Key Field) Constraints: Not nullableOriginal property name from the Odata EDM: EffectiveToDate
- Returns:
- Effective To Date
-
getContractMarketingCostControl
Constraints: Not nullable, Maximum length: 12Original property name from the Odata EDM: ContractMarketingCostControl
- Returns:
- Contract Marketing Cost Control
-
getCreatedByUser
Constraints: Not nullable, Maximum length: 12Original property name from the Odata EDM: CreatedByUser
- Returns:
- Name of Person Responsible for Creating the Object
-
getPRACreationDateTime
Constraints: NullableOriginal property name from the Odata EDM: PRACreationDateTime
- Returns:
- UTC Time Stamp in Short Form (YYYYMMDDhhmmss)
-
getOriginTransaction
Constraints: Not nullable, Maximum length: 32Original property name from the Odata EDM: OriginTransaction
- Returns:
- Source Transaction ID
-
get_Messages
Constraints: Not nullableOriginal property name from the Odata EDM: SAP__Messages
- Returns:
- The _Messages contained in this
VdmEntity.
-
toString
- Overrides:
toStringin classVdmObject<ContractMarketingHeader>
-
equals
- Overrides:
equalsin classVdmEntity<ContractMarketingHeader>
-
canEqual
- Overrides:
canEqualin classVdmEntity<ContractMarketingHeader>
-
hashCode
public int hashCode()- Overrides:
hashCodein classVdmEntity<ContractMarketingHeader>
-
getOdataType
- Specified by:
getOdataTypein classVdmObject<ContractMarketingHeader>
-