EmployeePrivAddress

Definition

The business object Employee Address contains the address details of employees.

Use

Information about addresses is stored in the Addresses infotype (0006) of Personnel Administration.

The details given in this infotype can be used to create employee lists, address labels, or forms.

Several addresses/address types can be assigned to an employee.

Structure

Different address types are contained in the business object Address. A subobject exists in the
Addresses infotype (0006) for each address type. The standard system has the following subtypes:

Available Methods

• Approve : Unlock Employee Address [ BAPI_ADDRESSEMP_APPROVE ]
  
• Change : Change Employee Address [ BAPI_ADDRESSEMP_CHANGE ]
  
• Create : Create Employee Address [ BAPI_ADDRESSEMP_CREATE ]
  
• Createsuccessor : Create Next Employee Address Record [ BAPI_ADDRESSEMPCREATESUCCESSOR ]
  
• Delete : Delete Employee Address [ BAPI_ADDRESSEMP_DELETE ]
  
• Delimit : Delimit Employee Address Validity Period [ BAPI_ADDRESSEMP_DELIMIT ]
  
• Getdetail : Read Employee Address [ BAPI_ADDRESSEMP_GETDETAIL ]
  
• Getdetailedlist : Read Instances with Data [ BAPI_ADDRESSEMPGETDETAILEDLIST ]
  
• Getlist : Read Instances [ BAPI_ADDRESSEMP_GETLIST ]
  
• Request : Create Locked Employee Address Record [ BAPI_ADDRESSEMP_REQUEST ]
  
• Simulatecreation : Simulation: Create Employee Address [ BAPIADDRESSEMPSIMULATECREATION ]
  

Approve

You can use this method to unlock an Addresses record (0006).

It enables you to implement the "double verification principle" inconjunction with the REQUEST method. According to this principle, atleast two users must take part in writing an active record to the
database. One user creates a locked record using the REQUEST method.The other user unlocks or 'activates' this record using the APPROVE method.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

For more information on the REQUEST method, read the documentation on the function module BAPI_ADDRESSEMP_REQUEST.

Change

You can use this method to change an Addresses record (0006).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Create

You can use this method to create an Addresses record (0006).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Createsuccessor

You can use this method to create a subsequent Addresses record (0006).

Example:

An employee lives in street 'A' and city 'A'. This data is stored in the Addressess infotype (0006) for the validity period from 01/01/1990 - 12/31/1999.

The employee moves on 01/01/1997. The new address is street 'B' in city 'A'.

You can use the CREATESUCCESSOR method to create a subsequent Addresses record (0006). The subsequent record contains the data of the previous record, only the Street/house number
field has to be changed.

The previous record is delimited on 12/31/1996.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Delete

You can use this method to delete an Addresses record (0006).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Delimit

You can use this method to chronologically delimit a data record for the Adresses infotype (0006).

Notes

Messages are returned in the RETURN parameter. The return codes and their meanings can be found in this parameter documentation.

The key fields used by the methods are described under the parameters.

This method can only be used if the ENQUEUE method of the EMPLOYEE business object has been called up first. You can find more information about the ENQUEUE method in the documentation of the
BAPI_EMPLOYEE_ENQUEUE function module.

Getdetail

You can use this method to read an Addresses record (0006).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

Getdetailedlist

Using this method, you can read the data records of the Addresses infotype (0006) which fall into the given time period.

Notes

Messages are returned in the RETURN parameter. You will find the return codes and their meanings in the parameter documentation.

The key fields used in the method are described in the parameter.

Getlist

You can use this method to read the keys (instances) of Addresses records (0006) which are within the specified time interval.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

Request

You can use this method to create a locked Addresses record (0006).

It enables you to implement the "double verification principle" inconjunction with the APPROVE method. According to this principle, atleast two users must take part in writing an active record to the
database. One user creates a locked record using the REQUEST method.The other user unlocks or 'activates' this record using the APPROVE method.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

For more information on the APPROVE method, read the documentation on the function module BAPI_ADDRESSEMP_APPROVE.

Simulatecreation

You can use this method to simulate creation of an Addresses record (Infotype 0006).

During the simulation all necessary consistency checks are performed, but the record is not written to the database.

Notes

Messages are transferred to the RETURN parameter. The relevant
parameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.