GET Methods
Definition
Methods for selecting appointment attributes.
Use
The GET methods are listed with a description of each one:
GET_GUID
Returns the appointment GUID. It identifies the appointment for its entire lifetime.
Return Parameters
-
GUID
Worldwide unique appointment ID.
GET_APPLICATION_DATA
Gets the data that can be set by the application itself and which is not directly related to the actual appointment.
Export Parameters
-
APPLICATION_DATA
Information (60 characters) that is not interpreted by address management. Originally intended for storing other application information for the exit function. You can, however, also use it for other purposes.
-
APPLICATION_GUID
GUID that you can assign yourself and which refers to your object(s). Using the SELECT_BY_APPLICATION_GUID method, you can instantiate all appointments that have the same application GUID.
GET_APPOINTMENT_CLASS
Returns the appointment class (full appointment or small appointment). The appointment class must be instantiated with one of the two possible classes.
Return Parameters
-
CLASS
Two values are currently possible:
-
C_FULL_APPOINTMENT: This is the normal case.
-
C_SMALL_APPOINTMENT: Only in exceptional cases.
-
GET_BUSY_VALUE
Returns whether the time period for the appointment is reserved or not. This value is used in the free/busy analysis (search for free times).
Return Parameters
-
BUSY_VALUE
Three different values are possible:
-
0: Time period is not reserved.
-
1: Time period is reserved for the time being ("tentative").
-
2: Time period is reserved.
-
GET_CLASSIFICATION
Returns the access classification that the appointment has. Using this classification, you can then assign access authorizations in individual appointment calendars.
Return Parameters
-
CLASSIFICATION
Three different values are possible:
-
1: Public appointment
-
2: Private appointment
-
3: Secret appointment
-
GET_DATE
Returns the time period in which the appointment is to take place. The time is specified in the time zone that was entered when the appointment was created or that was calculated from the time stamps.
Export Parameters
-
DATE_FROM
Date on which the appointment starts in the specified time zone.
-
TIME_FROM
Time at which the appointment starts in the specified time zone.
-
DATE_TO
Date on which the appointment ends in the specified time zone.
-
TIME_TO
Time at which the appointment ends in the specified time zone.
-
TIMEZONE
Time zone for the above parameters. This is usually the same time zone as the place where the appointment takes place.
GET_LOCATION
Returns the place or the room where the appointment takes place.
Return Parameters
-
LOCATION
Place where the appointment takes place.
GET_PARTICIPANTS
Returns the participants of an appointment.
Export Parameters
PARTICIPANTS
Table of participants. The participant structure consists of the following fields:
-
PARTICIPANT: If the participant is an SAP user, their SAP logon name. If it is a shared distribution list, the distribution list name. If the participant is a business object, this field is empty.
-
SC_DISTIND: Indicator for a shared distribution list (value C). Otherwise, empty.
-
LOGSYS: If the participant is a business object, its logical system.
-
OBJTYPE: If the participant is a business object, its type.
-
OBJKEY: If the participant is a business object, its key.
-
STATUS: Status of the participant. The following values are permitted:
-
1: The participant has accepted the appointment.
-
2: The participant has tentatively accepted the appointment.
-
3: The participant has declined the appointment.
-
4: The participant has not yet responded.
-
ROLE: Role of the participant. The following values are permitted:
-
1: The attendance of the participant is required.
-
2: The attendance of the participant is optional.
-
3: There are no appointment participants (just interested parties who are to be kept informed about this appointment).
-
SEND_MAIL: An invitation is sent to the participant. The following values are permitted:
-
0: No invitation is sent.
-
Otherwise: An invitation is sent.
-
EXTERN_FB: URI under which the participant's additional appointments are found. This is important for the appointment calendar and the free/busy analysis.
-
ADDRNUMBER: Company address number under which the participant is found in address management (Business Address Services). This is particularly important for sending the invitation. If no company address number is specified, the addresses of SAP users or participants of the object type ADDRESS are used. Otherwise no invitation is sent.
-
PERSNUMBER: Company address number under which the participant is found in address management (Business Address Services). This is particularly important for sending the invitation. If no company address number is specified, the addresses of SAP users or participants of the object type ADDRESS are used. Otherwise no invitation is sent.
-
COMM_MODE: Communication method to be used for sending. If no method is specified, the default entered in address management (Business Address Services) is used.
-
CONSNUMBER: Sequence number of the address in the communication method specified for sending. If no number is specified, the default entered in address management (Business Address Services) is used.
-
TXT_PARTIC: Name of the participant as it appears on the interface.
GET_PERIOD_INSTANCES
Returns the individual instances of a periodic appointment. The individual instances are references to the class CL_APPOINTMENT_PERIOD_INSTANCE, a sub-class of the class CL_APPOINTMENTS.
Note that the individual instances of a periodic appointment do not have their own GUIDs but the GUID of the periodic appointment. They are only differentiated by their "Internal ID" or the appointment times.
Return Parameters
-
INSTANCES
Table of references to objects of the class CL_APPOINTMENT_PERIOD_INSTANCE, the individual instances of the periodic appointment.
GET_PRIORITY
Returns the priority of an appointment.
Return Parameters
-
PRIORITY
Three different values are possible:
-
1: Very high priority
-
2: Medium priority (default)
-
3: Low priority
-
GET_RELATED_OBJECTS
When creating an appointment, you can relate it to your own business object. This method returns the application objects related to the appointment.
Export Parameters
-
RELATED_OBJECTS
Table of business objects.
GET_RULE
Only for periodic appointments. Returns the rule with which the periodic appointment was created. A rule is an instance of the class CL_APPOINTMENT_RULE.
Return Parameters
-
RULE
Rule with which this appointment was created.
Exceptions
-
RULE_NOT_FOUND
Internal error: The rule does not exist in the database (any longer).
-
APPOINTMENT_NO_RULE
This appointment does not have a rule, meaning that it is not a periodic appointment.
GET_STATUS
Returns the status of an appointment. Note that this is a different status to the status of the individual participants of the appointment.
Return Parameters
-
STATUS
Three different values are possible:
-
1: Confirmed
-
2: Planned
-
3: Canceled
-
GET_SUB_CLASS
Returns the class of the current appointment, provided that this is a subclass of the class CL_APPOINTMENT, for example CL_APPOINTMENT_PERIOD_INSTANCE.
Return Parameters
-
SUBCLASS
Name of the subclass.
GET_TEXT
Returns the appointment description.
Export Parameters
-
TEXT
Appointment description.
GET_TEXT_AUTHORITY
The appointment organizer can permit all other participants of the appointment to change the appointment description, for example, to determine the agenda for the appointment. This method returns whether this authorization was assigned for the current appointment.
The authorization check is only carried out in the appointment calendars of the participants. The appointment description can, however, always be changed from this class interface.
Return Parameters
-
AUTHORITY
Authorization to change the appointment description. The following two values are possible:
-
1: All participants can change the description.
-
2: Only the organizer can change the description.
-
GET_TIME_STAMPS
Returns the time period in which the appointment is to take place. The time stamp of the appointment, therefore a specification of the time period in UTC, is used.
Export Parameters
-
TIME_STAMP_FROM
Time stamp of the start of the appointment.
-
TIME_STAMP_TO
Time stamp of the end of the appointment.
-
TIMEZONE
Time zone for the above parameters. This is usually the same time zone as the place where the appointment takes place.
GET_TITLE
Returns the title of an appointment.
Return Parameters
-
TITLE
Appointment title.
GET_TYPE
Returns the appointment type. The appointment type is important, particularly for the exit function for the application to which this appointment (and this appointment type) belongs.
Return Parameters
-
TYPE
Appointment type. This is maintained in the table SCAPPTTYPE.
GET_URL_TO_APPOINTMENT
Internal use only.
GET_VIEW_ATTRIBUTES
Returns attributes for displaying the appointment in the appointment calendar. These attributes do not influence the appointment itself.
Export Parameters
-
SHOW_LOCAL
Irrespective of the time zone in which the appointment calendar is currently displayed, the appointment is always displayed at the time that was specified in the appointment. For more information, see the application documentation for the appointment calendar.
-
SHOW_ON_TOP
The appointment is always to be displayed above the time intervals in the calendar and is therefore independent of the times.
Such an appointment is also referred to as an all-day appointment, although the appointment has times. For more information, see the application documentation for the appointment calendar.