Fonction SAP BAPI_CMS_RIG_GETDETAIL_MULTI - OMS : Rights - Get details

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
DATA_REQUESTED BAPICMS_STR_RIG_REQD_DATA u 8 X Rights required data
PROCESSEXTENSION BAPI_CMS_STR_CENTRAL-PROCESSEXTENSION C 1 X Flag: Execute Customer Extensions (BAdIs) in BAPI

Paramètre Reférence Long. Facultatif Description
ASSET_DATA BAPICMS_STR_RIG_OMS_AST_GET 654 X GET: Structure for rights asset details
BUSINESS_PARTNERS BAPICMS_STR_RIG_OMS_BP_GET 188 X Business Partner Link (Get data)
CALCULATION_CONSOLIDATED BAPICMS_STR_RIG_CALC_GET 257 X Consolidated calculations results asset
CLAIM_DATA BAPICMS_STR_CLM_DETAILS_GET 867 X GET: Structure for claim details
DOCUMENTS BAPICMS_STR_RIG_OMS_DOC_GET 238 X Document Service Link (Get data)
EXTENSIONIN BAPIPAREX 990 X Ref. structure for BAPI parameter ExtensionIn/ExtensionOut
EXTENSIONOUT BAPIPAREX 990 X Ref. structure for BAPI parameter ExtensionIn/ExtensionOut
INSURED_PERSON_DATA BAPICMS_STR_INS_PSN_DATA_GET 362 X GET: Structure for life insurance person details
LIFE_INSURANCE_DATA BAPICMS_STR_LIF_INS_DATA_GET 982 X GET: Structure for life insurance details
NOTES BAPICMS_STR_RIG_NOTES_GET 190 X Notes created on Movables
OBJECT_INSURANCE_DATA BAPICMS_STR_RIG_OMS_INS_GET 416 X Insurance Data - GET
OBJECT_INSURANCE_DOCUMENTS BAPICMS_STR_RIG_INS_DOC_GET 254 X Insurance Document Service Link (Get data)
OBJECT_INSURANCE_PARTNERS BAPICMS_STR_RIG_OMS_INS_BP_GET 194 X Business Partner Link (Get data) for Insurance
PATENT_DATA BAPICMS_STR_PAT_DETAILS_GET 866 X GET: Structure for patent details
RETURN BAPIRET2 548 X Return Parameter
RIGHTS_IDENTIFIER BAPICMS_STR_RIG_IDENTIFIER_GET 32 GET: Rights identifier primary key
RIGHTS_KEYS BAPICMS_STR_RIG_KEYS_GET 164 X GET: Rights primary key & semantic key
SYSTEM_STATUS BAPICMS_STR_RIG_SYS_STAT_GET 61 X System status
USER_STATUS BAPICMS_STR_RIG_USR_STAT_GET 61 X User status
VALUES_DATA BAPICMS_STR_RIG_OMS_VAL_GET 148 X Value service link (Get data)

Functionality
You can use this method to transfer details of collateral objects thatbelong to one of the following object categories :

  • Patents

  • Claims

  • Insurance objects

  • Use this method to determine the following data for one or more of thecollateral objects belonging to one of the object categories listedearlier. These include :
    • Basic details of collateral objects such as claims, patents, life
    • insurance and life insurance as a person
      • Details of values, parts and insurances

      • Business partners assigned to the rights

      • Documents attached to the rights

      • Calculated values for the rights

      • Notes

      • Note : This method transfers all the basic data. To transferspecific details of the Rights such as insurance, business partners ordocuments, you must check the relevant flags for the same.
        This method is mostly used by correspondence and other modules where atable of rights identifications are given and all the details arerequired to be transferred.
        The rights GUID must be passed as parameter to uniquely collateralobjects (rights) in the system. Based on this key, the details of thecollateral objects (rights) are returned from the records.

        Description
        The parameter controls the scope of the data to be read for the right(patent, claim or an insurance object).
        For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

        Default
        By default, only the basic values of the collateral object (right) aretransfered. To read the other specific details, you must check theflags for the relevant structures.

        Description
        Check this flag to specify if the details entered by the Customers in aBusiness Add-In of this method, must be transfered.
        You will find information on the meaning of the parameter in thedocumentation for the data element Execute Extension(s)(BAdI).

        Value range
        X = Yes: In general the planned customer extensions should be executed.

        Description
        This parameter contains the asset specific data for the rights. Youneed to transfer values atleast the following fields :

        • Object category

        • Category name

        • Right type

        • Right type name

        • Right identification

        • For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

          Description
          This parameter contains the data of the business partners assigned tothe rights. Atleast the following fields must be transfered :

          • Object category

          • Right type

          • Right identification

          • Business partner identification

          • Business partner function

          • These details are transfered only if you have checked the flag FLG_BUPAwhile determining the scope of the import parameters.
            For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

            Description
            This parameter contains the consolidated calculated values of thecollateral object (right) and its parts. These values are transferedonly if you have checked the flag FLG_CALC while determining the scopeof the import parameters.

            Description
            This parameter contains the details of the claims. Atleast the followingvalues must be transfered :

            • Object category

            • Category name

            • Claim type

            • Claim type text

            • Claim identification

            • For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

              Description
              The parameter contains the data for the documents attached to therights. Atleast the following fields must be transfered :

              • Object category

              • Right type

              • Right identification

              • Document identification

              • Document type

              • These details are transfered only if you have checked the flagFLG_DOCUMENT while determining the scope of the import parameters.
                For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

                Description
                This parameter is an import parameter. It enables you to defineadditional filter criteria to determine the scope of the details.
                The table extension provided is called BAPI_TE_FMBH.
                For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

                Description
                This is an export parameter. It is provided to allow additional detailvalues to be returned by the BAPI.
                The table extension provided is called BAPI_TE_FMBH.
                For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary

                Description
                This parameter contains the details of the insured persons in theinsurance objects.
                For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

                Description
                The parameter contains the basic details of the insurance objects.Atleast the following fields must be transfered :

                • Object category

                • Category name

                • Insurance type

                • Insurance type text

                • Insurance identification

                • For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

                  Description
                  This parameter contains the details of the notes attached to the rights.These details are transfered only if you have checked the flag FLG_NOTESwhile determining the scope of the import parameters.

                  Description
                  This parameter contains the insurance data for the rights. These detailsare transfered only if you have checked the flag FLG_INS whiledetermining the scope of the import parameters. Atleast the followingvalues must be transfered :

                  • Object category

                  • Right type

                  • Right identifcation

                  • Insurance category

                  • Insurance type

                  • Insurance identification

                  • For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

                    Description
                    This parameter contains the insurance data of the rights. These detailsare transfered only if you have checked the flag FLG_INS whiledetermining the scope of the import parameters. Atleast the followingvalues must be transfered :

                    • Object category

                    • Right type

                    • Right identifcation

                    • Insurance category

                    • Insurance type

                    • Insurance identification

                    • For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

                      Description
                      This parameter contains the data relating to the insurance businesspartners of the rights. These details are transfered only if you havechecked the flag FLG_INS while determining the scope of the importparameters. Atleast the following fields must be transfered :

                      • Object category

                      • Right type

                      • Right identification

                      • Insurance category

                      • Insurance type

                      • Insurance identification

                      • Business partner identification

                      • Business partner function

                      • For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

                        Description
                        The parameter controls the scope of the data to be read for thecollateral object - patent.
                        You need to transfer values for atleast the following fields :

                        • Object category

                        • Category name

                        • Patent type

                        • Patent type text

                        • Patent identification

                        • For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.

                          Description
                          This table contains the return messages (including the error messagesfor plausibility checks ) from the method call.

                          Description
                          This parameter implements the primary key, the GUID (internal technicalkey) for the collateral object (right).

                          Description
                          This parameter implements the following fields :

                          • GUID (internal technical key) for Rights - Primary key

                          • Object category

                          • Object category name

                          • Right type

                          • Rights type name

                          • Rights ID
                          • Description
                            This parameter contains the details on the system statuses of therights. These values are transfered only if you have checked the flagFLG_SYSTEM_STATUS while determining the scope for the import parameters.

                            Value range
                            The following system statuses are possible for rights :

                            • Created

                            • Active

                            • Inactive

                            • Legally active

                            • Calculation relevant

                            • Only the following combinations of system statuses are allowed:
                              Created + Calculation relevant
                              Active + Calculation relevant
                              Inactive + Calculation relevant
                              Legally active + Calculation relevant
                              If you want to set the system status to Calculation relevant,then in the Implementation Guide (IMG) Customizing, you must explicityset the status to a combination of a system status with calculationrelevant.
                              Note :Plausibility checks are defined to validate the input databefore a system status is set for a collateral object (right).

                              Default
                              By default, all new rights assume the status Created.

                              Description
                              This parameter contains the values of the user statuses of the rights.Atleast the following values must be transferred :

                              • Object category

                              • Right type

                              • Rights ID

                              • User status

                              • User status text

                              • The details of the user statuses are transfered only if you have checkedthe flag FLG_USER_STATUS while determiing the scope of the importparameters.

                                Description
                                This parameter contains the data specific to the values of the rights.These details are transfered only if you have checked the flag FLG_VALwhile determining the scope of the import parameters.
                                For more information on the individual parameter fields, see the dataelement documentation in the ABAP Dictionary.