SAP ABAP Class IF_GRFN_API_DOCUMENT (Interface for document API)
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | IF_GRFN_API_BASIS | Basis interface for the GRC API | 20080317 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_GRFN_API_DOCUMENT | API for document entity | 20080313 |
Properties
| Class | IF_GRFN_API_DOCUMENT | |
| Short Description | Interface for document API | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20080313 | SAP |
| Last change | 20141106 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class IF_GRFN_API_DOCUMENT has no forward declaration.
Interfaces
Class IF_GRFN_API_DOCUMENT has no interface implemented.
Friends
Class IF_GRFN_API_DOCUMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DOC_CLASS |
Constant | Public | See coding | Constants for document class | 20080521 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE |
Static method | Public | Method | Creates a document and returns the instance | 20080313 |
| 2 | DELETE |
Instance method | Public | Method | Deletes a document | 20080313 |
| 3 | DOWNLOAD |
Instance method | Public | Method | Download the documents content | 20080314 |
| 4 | FREEZE |
Static method | Public | Method | Freeze all existing documents for session TF | 20121213 |
| 5 | QUERY |
Static method | Public | Method | Querys the existing documents | 20080313 |
| 6 | RETRIEVE |
Instance method | Public | Method | Retrieves the data of a document | 20080313 |
| 7 | UPDATE |
Instance method | Public | Method | Updates a document | 20080313 |
Events
Class IF_GRFN_API_DOCUMENT has no event.
Types
Class IF_GRFN_API_DOCUMENT has no local type.
Method Signatures
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20080313 | ||
| 2 | Importing |
IS_DOCUMENT_CONTENT_NEW | Call by reference | Type reference (TYPE) | GRFN_S_API_DOCUMENT_CONTENT | Content for the uploaded document for DMS | 20080313 | ||
| 3 | Importing |
IS_DOCUMENT_DATA_NEW | Call by reference | Type reference (TYPE) | GRFN_S_API_DOCUMENT_DATA | The list of the documents | 20080313 | ||
| 4 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081208 | ||
| 5 |  Returning |
RV_DOCUMENT_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | GRC ID of the individual object | 20080313 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_GRFN_EXCEPTION |
Generic GRC API exception | 20080313 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20080313 |
Method DOWNLOAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081208 | ||
| 2 | Importing |
IV_VERSION_NR | Call by reference | Type reference (TYPE) | GRFN_DOCUMENT_VERSION_TEXT_UI | Version | 20080401 | ||
| 3 | Returning |
RS_DOCUMENT_CONTENT | Value transfer | Type reference (TYPE) | GRFN_S_API_DOCUMENT_CONTENT | Content for the uploaded document for DMS | 20080325 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20080314 |
Method FREEZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20121213 | ||
| 2 | Importing |
IV_FLUSH | Call by reference | Type reference (TYPE) | AS4FLAG | Force immediate save and buffer release | 20121213 | ||
| 3 | Importing |
IV_OBJECT_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20121213 | ||
| 4 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20121213 | ||
| 5 | Importing |
IV_SEGMENT | Call by reference | Type reference (TYPE) | GRFN_DOCUMENT_SEGMENT | Document Segment | 20121213 | ||
| 6 | Importing |
IV_SKIP_AUTH | Call by reference | Type reference (TYPE) | AS4FLAG | Flag (X or Blank) | 20130301 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20121213 |
Method QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20080313 | ||
| 2 | Importing |
IV_FROZEN | Value transfer | Type reference (TYPE) | AS4FLAG | Flag (X or Blank) | 20121213 | ||
| 3 | Importing |
IV_OBJECT_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20080313 | ||
| 4 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081208 | ||
| 5 | Importing |
IV_SEGMENT | Call by reference | Type reference (TYPE) | GRFN_DOCUMENT_SEGMENT | Document Segment | 20081202 | ||
| 6 | Returning |
RT_DOCUMENT_LIST | Value transfer | Type reference (TYPE) | GRFN_T_API_DOCUMENT_LIST | The list of the documents | 20080313 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20080313 |
Method RETRIEVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_DOCUMENT_DATA | Value transfer | Type reference (TYPE) | GRFN_S_API_DOCUMENT_DATA | The list of the documents | 20080314 | ||
| 2 | Exporting |
ET_DOCUMENT_VERSION | Call by reference | Type reference (TYPE) | GRFN_T_API_DOCUMENT_VERSION | The list of the document versions | 20080314 | ||
| 3 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20080313 |
Method UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_DOCUMENT_CONTENT_CHANGED | Call by reference | Type reference (TYPE) | GRFN_S_API_DOCUMENT_CONTENT | Content for the uploaded document for DMS | 20080313 | ||
| 2 | Importing |
IS_DOCUMENT_DATA_CHANGED | Call by reference | Type reference (TYPE) | GRFN_S_API_DOCUMENT_DATA | The list of the documents | 20080313 | ||
| 3 | Importing |
IV_NEW_VERSION | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20080313 | ||
| 4 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20080313 |
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in |
