SAP ABAP Interface /IPRO/IF_ACTION (Document Builder Action Interface)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-GTF-DOB (Application Component) Document Builder
     ⤷ /IPRO/INTERFACE (Package) BADI's, Interfaces

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface composition (i COMPRISING i_ref)	/IPRO/IF_DOCB_ELEMENT	Interface to document builder element	20040721
2	Interface composition (i COMPRISING i_ref)	/IPRO/IF_DOCUMENT	Document Builder Document Interface	20031113

Properties

Interface	/IPRO/IF_ACTION
Short Description	Document Builder Action Interface

General Data

Package	/IPRO/INTERFACE	BADI's, Interfaces
Created	20031113	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface /IPRO/IF_ACTION has no forward declaration.

Interfaces

Interface /IPRO/IF_ACTION has no interface.

Friends

Interface /IPRO/IF_ACTION has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ACTION_CANCEL_RELEASE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'cancel_rel'	Cancel release	20090625
2	GC_ACTION_CLOSE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'close'	Close	20040416
3	GC_ACTION_COMPLETE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'complete'	Release	20070410
4	GC_ACTION_COPY	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'copy'	Copy	20040628
5	GC_ACTION_CREATE_VERSION	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'create_ver'	Create a version	20041026
6	GC_ACTION_DEACTIVATE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'deactivate'	Deactivate	20070515
7	GC_ACTION_DELETE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'delete'	Delete	20040628
8	GC_ACTION_DELETE_VERSION	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'delete_ver'	Delete a version	20041026
9	GC_ACTION_DISPLAY	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'display'	Switch to display mode	20040417
10	GC_ACTION_EDIT	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'edit'	Switch to edit mode	20040417
11	GC_ACTION_HOLD	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'hold'	Hold	20040416
12	GC_ACTION_POST	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'post'	Post	20040416
13	GC_ACTION_PROCESS	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'process'	Process	20040416
14	GC_ACTION_REJECT	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'reject'	Reject	20050921
15	GC_ACTION_RELEASE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'release'	Release	20040730
16	GC_ACTION_REVIEW_EDIT	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'review_ed'	Review/Edit a document	20041208
17	GC_ACTION_XI_ARCHIVE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'ARCHIVE'	Archive	20051215
18	GC_ACTION_XI_BUILDFROM	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'BUILDFROM'	XI buildfrom	20050107
19	GC_ACTION_XI_CREATE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'CREATE'	XI create	20050107
20	GC_ACTION_XI_DELETE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'DELETE'	XI delete	20050107
21	GC_ACTION_XI_LOCK	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'LOCK'	Lock Docb document	20060707
22	GC_ACTION_XI_NEW_VERSION	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'NEW_VERSIO'	Actions	20071010
23	GC_ACTION_XI_REJECT	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'REJECT'	XI Reject document submission	20051019
24	GC_ACTION_XI_RELEASE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'RELEASE'	XI release	20050107
25	GC_ACTION_XI_TOKENGRANT	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'TOKENGRANT'	XI token grant	20050520
26	GC_ACTION_XI_TOKENREQ	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'TOKENREQ'	XI token request	20050520
27	GC_ACTION_XI_UNLOCK	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'UNLOCK'	Unlock Docb document	20060707
28	GC_ACTION_XI_UPDATE	Constant	Public	☐	Type reference (TYPE)	/IPRO/ACTION	'UPDATE'	XI update	20050107

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE	Instance method	Public	Method	Close DocB instance	20031113
2	COMPLETE	Instance method	Public	Method	Release a document	20070323
3	CREATE_EXT_VERSION	Instance method	Public	Method	Create a new external version	20070413
4	CREATE_VERSION	Instance method	Public	Method	Create a new version	20070425
5	DEACTIVATE	Instance method	Public	Method	Deactivate the object	20070515
6	DELETE	Instance method	Public	Method	Delete instance	20040628
7	DELETE_VERSION	Instance method	Public	Method	Delete a version	20041026
8	END_EXTERNAL_COLLAB	Instance method	Public	Method	End external collaboration on the document	20070612
9	FINISH_WITH_DEFAULTS	Instance method	Public	Method	Finish the document with default data values	20040201
10	HOLD	Instance method	Public	Method	Hold the document	20031113
11	IS_ACTION_ALLOWED	Instance method	Public	Method	Determine whether a certain action is allowed	20031113
12	POST	Instance method	Public	Method	Post as active document	20031113
13	PROCESS	Instance method	Public	Method	Process DocB business logic	20031113
14	REJECT	Instance method	Public	Method		20050920
15	RELEASE	Instance method	Public	Method	Release a document	20041207
16	SWITCH_MODE	Instance method	Public	Method	Display->Update and Update->Edit	20040417

Events

Interface /IPRO/IF_ACTION has no event.

Types

Interface /IPRO/IF_ACTION has no local type.

Method Signatures

Method CLOSE Signature

Method CLOSE on Interface /IPRO/IF_ACTION has no parameter.
Method CLOSE on Interface /IPRO/IF_ACTION has no exception.

Method COMPLETE Signature

Method COMPLETE on Interface /IPRO/IF_ACTION has no parameter.

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_FOREIGN_LOCK	☐	Foreign lock does not allow the action	20070323
2	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20070323
3	/IPRO/CX_ACTION_NOAUTH	☐	No Authorization for Action	20070323
4	/IPRO/CX_ACTION_STATUS	☐	Status of the document does not allow the action	20070323

Method CREATE_EXT_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRO_NEW_VERSION	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCUMENT			20070413

Method CREATE_EXT_VERSION on Interface /IPRO/IF_ACTION has no exception.

Method CREATE_VERSION Signature

Method CREATE_VERSION on Interface /IPRO/IF_ACTION has no parameter.

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20070425

Method DEACTIVATE Signature

Method DEACTIVATE on Interface /IPRO/IF_ACTION has no parameter.

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20070515

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_PROXY_ACTOR	Call by reference	☐	Type reference (TYPE)	SEU_BOOL	SPACE	Boolean	20050209

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_FOREIGN_LOCK	☐	Foreign lock does not allow the action	20040628
2	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20040628
3	/IPRO/CX_ACTION_NOAUTH	☐	No Authorization for Action	20040628
4	/IPRO/CX_ACTION_STATUS	☐	Status of the document does not allow the action	20040628

Method DELETE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_VERSION	Call by reference	☑	Type reference (TYPE)	/IPRO/VERSNO		Version Number	20041026

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_FOREIGN_LOCK	☐	Foreign lock does not allow the action	20041026
2	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20041026
3	/IPRO/CX_ACTION_STATUS	☐	Status of the document does not allow the action	20041026

Method END_EXTERNAL_COLLAB Signature

Method END_EXTERNAL_COLLAB on Interface /IPRO/IF_ACTION has no parameter.
Method END_EXTERNAL_COLLAB on Interface /IPRO/IF_ACTION has no exception.

Method FINISH_WITH_DEFAULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_FILLINS_ONLY	Call by reference	☐	Type reference (TYPE)	SEU_BOOL	SPACE	SPACE = Dialog, X = Fillins	20100809

Method FINISH_WITH_DEFAULTS on Interface /IPRO/IF_ACTION has no exception.

Method HOLD Signature

Method HOLD on Interface /IPRO/IF_ACTION has no parameter.

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20040416

Method IS_ACTION_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ACTION	Call by reference	☐	Type reference (TYPE)	/IPRO/ACTION		Actions of the /IPRO/IF_ACTION interface	20040417
2	Returning	PRV_ALLOWED	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Allowed	20040417

Method IS_ACTION_ALLOWED on Interface /IPRO/IF_ACTION has no exception.

Method POST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_NO_DIALOG	Call by reference	☑	Type reference (TYPE)	XFELD		Are we in dialog mode	20080830

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20040416

Method PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRV_VALID	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Valid?	20040417

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20040416

Method REJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_PROXY	Call by reference	☐	Type reference (TYPE)	SEU_BOOL	SPACE	Boolean	20050920

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_FOREIGN_LOCK	☐	Foreign lock does not allow the action	20050920
2	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20050920
3	/IPRO/CX_ACTION_NOAUTH	☐	No Authorization for Action	20050920
4	/IPRO/CX_ACTION_STATUS	☐	Status of the document does not allow the action	20050920

Method RELEASE Signature

Method RELEASE on Interface /IPRO/IF_ACTION has no parameter.

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_FOREIGN_LOCK	☐	Foreign lock does not allow the action	20041207
2	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20041207
3	/IPRO/CX_ACTION_NOAUTH	☐	No Authorization for Action	20041207
4	/IPRO/CX_ACTION_STATUS	☐	Status of the document does not allow the action	20041207

Method SWITCH_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_GET_TOKEN	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20080626
2	Importing	PIV_MODE	Call by reference	☐	Type reference (TYPE)	/IPRO/MODE	'U'	U(Update) or Space(Display)	20040417
3	Importing	PIV_PROXY	Call by reference	☐	Type reference (TYPE)	SEU_BOOL	SPACE	space(gui user) , else (proxy user)	20050921

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_FOREIGN_LOCK	☐	Foreign lock does not allow the action	20040417
2	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20040417
3	/IPRO/CX_ACTION_NOAUTH	☐	No Authorization for Action	20040417
4	/IPRO/CX_ACTION_STATUS	☐	Status of the document does not allow the action	20040417

History

Last changed by/on	SAP	20110908
SAP Release Created in	10A