SAP ABAP Class IF_SCPL_DIRECTIONS (A director's interface to Screenplay to give directions)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_SCPL_SCREENPLAY | Screenplay main implementation | 20111209 |
Properties
| Class | IF_SCPL_DIRECTIONS | |
| Short Description | A director's interface to Screenplay to give directions | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20111209 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class IF_SCPL_DIRECTIONS has no interface implemented.
Friends
Class IF_SCPL_DIRECTIONS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MO_SCREENPLAY |
Instance attribute | Public | Object reference (TYPE REF TO) | IF_SCPL_LOOKUP | An interface to Screenplay to fetch information | 20111209 | ||
| 2 | MT_ACTING_ACTORS |
Instance attribute | Public | Type reference (TYPE) | SCPL_ACTING_ACTORS | Actors in Action: Dialogs, Makeups and Texts (Data/Content) | 20111210 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ACTORS_OF_DIALOG |
Instance method | Public | Method | returns a list of actors that are involved in given dialog | 20111209 |
| 2 | ALLOW_EXTRAS |
Instance method | Public | Method | allow extras occupying the location | 20111210 |
| 3 | AND_ACTION |
Instance method | Public | Method | lets the actors act - so take closeups of each of them | 20111209 |
| 4 | CLOSEUP_OF_ACTOR |
Instance method | Public | Method | returns the makeup of the given actor | 20111210 |
| 5 | CUT |
Instance method | Public | Method | shot is in the can, prepare for next | 20111209 |
| 6 | INTRODUCE_ACTOR |
Instance method | Public | Method | introduces the given actor to the current location | 20111209 |
| 7 | IS_ACTING |
Instance method | Public | Method | returns ABAP_TRUE if the given actor is acting currently | 20111210 |
| 8 | SELECT_LOCATION |
Instance method | Public | Method | set the current location | 20111209 |
Events
Class IF_SCPL_DIRECTIONS has no event.
Types
Class IF_SCPL_DIRECTIONS has no local type.
Method Signatures
Method ACTORS_OF_DIALOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_DIALOG_ACTORS | Call by reference | Type reference (TYPE) | SCPL_DIALOG_ACTORS | List of actors in dialog within Screeplay | 20111209 | ||
| 2 |  Importing |
IV_DIALOG | Call by reference | Type reference (TYPE) | SCPL_DIALOG | Dialog within Screenplay | 20111209 | ||
| 3 | Importing |
IV_SCENE | Call by reference | Type reference (TYPE) | SCPL_SCENE | Scene Name (Unique Identifier, case-sensitive) | 20111210 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SCPL_ERROR |
Exception class for Screenplay interfaces | 20111209 |
Method ALLOW_EXTRAS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ALLOW | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | TRUE: Extras are allowed on location | 20111210 |
Method ALLOW_EXTRAS on class IF_SCPL_DIRECTIONS has no exception.
Method AND_ACTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SCENE | Call by reference | Type reference (TYPE) | SCPL_SCENE | Scene Name (Unique Identifier, case-sensitive) | 20111210 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SCPL_ERROR |
Exception class for Screenplay interfaces | 20111209 |
Method CLOSEUP_OF_ACTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_MAKEUP | Call by reference | Type reference (TYPE) | DATA | Makeup of the given actor | 20111210 | ||
| 2 | Exporting |
EV_STYLE | Call by reference | Type reference (TYPE) | SCPL_MAKEUP_STYLE | Style of Makeup (Type or Class Name) | 20111210 | ||
| 3 | Importing |
IV_ACTOR | Call by reference | Type reference (TYPE) | SCPL_ACTOR | Name of an Actor (Unique Identifier, case-sensitive) | 20111210 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SCPL_ERROR |
Exception class for Screenplay interfaces | 20111210 |
Method CUT Signature
Method CUT on class IF_SCPL_DIRECTIONS has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SCPL_ERROR |
Exception class for Screenplay interfaces | 20111209 |
Method INTRODUCE_ACTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTOR | Call by reference | Type reference (TYPE) | SCPL_ACTOR | An actor's name in Screenplay | 20111209 | ||
| 2 | Importing |
IV_TEXT | Call by reference | Type reference (TYPE) | DATA | the actor's text (content/data) | 20111209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SCPL_ERROR |
Exception class for Screenplay interfaces | 20111209 |
Method IS_ACTING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTOR | Call by reference | Type reference (TYPE) | SCPL_ACTOR | Name of an Actor (Unique Identifier, case-sensitive) | 20111210 | ||
| 2 |  Returning |
RV_IS_ACTING | Value transfer | Type reference (TYPE) | ABAP_BOOL | TRUE if actor is among the acting actors | 20111210 |
Method IS_ACTING on class IF_SCPL_DIRECTIONS has no exception.
Method SELECT_LOCATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_LOCATION | Call by reference | Type reference (TYPE) | SCPL_LOCATION_ID | Unique ID of a location in Screenplay | 20111209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SCPL_ERROR |
Exception class for Screenplay interfaces | 20111209 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
