SAP ABAP Class CL_CFX_NOTIFICATION_TEMPLATE (Manages a Notification Template)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_NOTIFICATION (Package) Manages Notifications

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ACO_COMMON	Common Interface for Authorization Check	20060310
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFS_AUTH_NEEDER	Interface for cFolders Authorization	20060426

Properties

Class	CL_CFX_NOTIFICATION_TEMPLATE
Short Description	Manages a Notification Template
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CFX_NOTIFICATION	Manages Notifications
Created	20060110	SAP
Last change	20141109
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)
2	CFXN1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ACO_COMMON	☐	☐	Common Interface for Authorization Check	20060310
2	IF_CFS_AUTH_NEEDER	☐	☐	Interface for cFolders Authorization	20060426

Friends

Class CL_CFX_NOTIFICATION_TEMPLATE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MP_AUTHORITY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CFX_AUTHORITY		Collaboration: Authorization	20060310
2	MP_AUTHORIZATION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ACO_AUTHORIZATION		Information About Authorization Subject	20070209
3	M_CHANGED_BY	Instance attribute	Public	☐	Type reference (TYPE)	CFX_CHANGED_BY		Changed by	20060119
4	M_CHANGED_ON	Instance attribute	Public	☐	Type reference (TYPE)	CFX_CHANGED_ON		Changed on	20060119
5	M_CREATED_BY	Instance attribute	Public	☐	Type reference (TYPE)	CFX_CREATED_BY		Created By	20060116
6	M_CREATED_ON	Instance attribute	Public	☐	Type reference (TYPE)	CFX_CREATED_ON		Created on	20060116
7	M_ID	Instance attribute	Public	☐	Type reference (TYPE)	CFX_NTF_TMPL_ID		ID of Notifcation Template	20060113
8	M_NAME	Instance attribute	Public	☐	Type reference (TYPE)	CFX_NTF_TMPL_NAME		Name field for Notification Templates	20060116
9	M_NOTE	Instance attribute	Public	☐	Type reference (TYPE)	CFX_COMMENT		Commentary Text for Notification Template	20060116
10	M_PRIORITY	Instance attribute	Public	☐	Type reference (TYPE)	CFX_PRIORITY		Priority of Notification Template	20060116
11	M_SUBJECT	Instance attribute	Public	☐	Type reference (TYPE)	CFX_SUBJECT		Subject of Notification Template	20060116
12	M_USED	Instance attribute	Public	☐	Type reference (TYPE)	I	0	Used How Many Times?	20060622
13	M_USED_FOR	Instance attribute	Public	☐	Type reference (TYPE)	STRING		Used for	20060622
14	SC_NOT_USED	Constant	Public	☐	Type reference (TYPE)	STRING	' '	Template is not being used	20060110
15	SC_PRIORITY_HIGH	Constant	Public	☐	Type reference (TYPE)	I	1	Priority 1	20060110
16	SC_PRIORITY_NORMAL	Constant	Public	☐	Type reference (TYPE)	I	2	Priority 2	20060110
17	SC_USED	Constant	Public	☐	Type reference (TYPE)	STRING	'X'	Template is being used	20060110
18	S_HANDLE	Static Attribute	Private	☐	Type reference (TYPE)	ACO_PERSISTENCY_HANDLE		Handle for Reference to Instance of Persistence Class	20060426

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DUPLICATE_NAME	Static method	Private	Method	Checks for duplicate names	20060116
2	CONSTRUCTOR	Instance method	Public	Constructor		20060116
3	CREATE	Static method	Public	Method	Create a Notification Template	20060113
4	CREATE_ATTRIBUTES	Instance method	Private	Method	Create Attributes	20060116
5	DECREMENT_USED_COUNT	Instance method	Public	Method	Decrements the USED count of the template by 1	20060419
6	DELETE	Instance method	Public	Method	Delete Notification Templates	20060118
7	GET_ALL_ATTRIBUTES	Instance method	Public	Method	Returns all attributes	20060306
8	GET_ID	Instance method	Public	Method	Return the ID of the Notification Template	20060113
9	GET_NAME_FOR_ID	Static method	Public	Method	Returns the name for the given id	20060519
10	GET_TEMPLATE_FOR_ID	Static method	Public	Method	Gets the Template for the given Id	20060419
11	HAS_ADMIN_AUTH	Instance method	Public	Method	Checks Whether User Has Administration Authorization	20060519
12	HAS_CHANGE_AUTH	Instance method	Public	Method	Checks Whether User Has Change Authorization	20060428
13	INCREMENT_USED_COUNT	Instance method	Public	Method	Increments the USED count of the template by 1	20060419
14	INITIALIZE	Static method	Public	Method	Instantiate a Notification Template	20060119
15	INITIALIZE_ATTRIBUTES	Instance method	Private	Method	Initialize Attribute	20060119
16	IS_RESTRICTED	Instance method	Public	Method	Checks Whether The Template Usage is Restricted	20060522
17	IS_USED	Instance method	Public	Method	Checks Whether The Template is Being Used	20060629
18	RELEASE_USE	Instance method	Public	Method	Releases the Template For Usage of all Applications	20060522
19	RESTRICT_USE	Instance method	Public	Method	Restricts The Template For Specific Use	20060522
20	SELECT_NOTIFICATION_TEMPLATES	Static method	Public	Method	Find all Notification Templates	20060110
21	UPDATE	Static method	Public	Method	Update a Notification Template	20060313
22	UPDATE_ATTRIBUTES	Instance method	Private	Method	Update Attributes	20060313

Events

Class CL_CFX_NOTIFICATION_TEMPLATE has no event.

Types

Class CL_CFX_NOTIFICATION_TEMPLATE has no local type.

Method Signatures

Method CHECK_DUPLICATE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	CFX_NTF_TMPL_NAME		Name field for Notification Templates	20060116
2	Returning	R_EXISTS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060116

Method CHECK_DUPLICATE_NAME on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	CFX_NTF_TMPL_ID		ID for notification Templates	20060116

Method CONSTRUCTOR on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name	20060113
2	Importing	I_NOTE	Value transfer	☐	Type reference (TYPE)	STRING		Note	20060113
3	Importing	I_PRIORITY	Value transfer	☐	Type reference (TYPE)	STRING		Priority	20060113
4	Importing	I_SUBJECT	Value transfer	☐	Type reference (TYPE)	STRING		Subject	20060113
5	Returning	RP_NTF_TEMPLATE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_NOTIFICATION_TEMPLATE		Notification Template	20060113

Method CREATE on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method CREATE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CREATED_BY	Call by reference	☐	Type reference (TYPE)	CFX_CREATED_BY		Created By	20060116
2	Importing	I_CREATED_ON	Call by reference	☐	Type reference (TYPE)	CFX_CREATED_ON		Created on	20060116
3	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	CFX_NTF_TMPL_ID		ID for Notification Templates	20060116
4	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	CFX_NTF_TMPL_NAME		Name field for Notification Templates	20060116
5	Importing	I_NOTE	Call by reference	☐	Type reference (TYPE)	CFX_COMMENT		Commentary Text for Notifications	20060116
6	Importing	I_PRIORITY	Call by reference	☐	Type reference (TYPE)	CFX_PRIORITY		Priority	20060116
7	Importing	I_SUBJECT	Call by reference	☐	Type reference (TYPE)	CFX_SUBJECT		Subject of a Notification	20060116

Method CREATE_ATTRIBUTES on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method DECREMENT_USED_COUNT Signature

Method DECREMENT_USED_COUNT on class CL_CFX_NOTIFICATION_TEMPLATE has no parameter.
Method DECREMENT_USED_COUNT on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method DELETE Signature

Method DELETE on class CL_CFX_NOTIFICATION_TEMPLATE has no parameter.
Method DELETE on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method GET_ALL_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TMPL_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	CFX_TS_NTF_TMPL		Structure for Notification Templates	20060306

Method GET_ALL_ATTRIBUTES on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method GET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ID	Value transfer	☐	Type reference (TYPE)	CFX_NTF_TMPL_ID		ID of the Notification Template	20060113

Method GET_ID on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method GET_NAME_FOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	STRING			20060519
2	Returning	R_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20060519

Method GET_NAME_FOR_ID on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method GET_TEMPLATE_FOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NTF_TMPL_ID	Call by reference	☐	Type reference (TYPE)	CFX_NTF_TMPL_ID		ID for Notification Templates	20060419
2	Returning	RP_NTF_TEMPLATE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_NOTIFICATION_TEMPLATE		Manages a Notification Template	20060419

Method GET_TEMPLATE_FOR_ID on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method HAS_ADMIN_AUTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HAS_ADMIN_AUTH	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060519

Method HAS_ADMIN_AUTH on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method HAS_CHANGE_AUTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_RAISE_EXCEPTIONS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Should Exceptions Be Raised Immediately?	20060428
2	Returning	R_HAS_CHANGE_AUTH	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		User Has Change Authorization	20060428

Method HAS_CHANGE_AUTH on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method INCREMENT_USED_COUNT Signature

Method INCREMENT_USED_COUNT on class CL_CFX_NOTIFICATION_TEMPLATE has no parameter.
Method INCREMENT_USED_COUNT on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_COMMON	Call by reference	☑	Object reference (TYPE REF TO)	IF_ACO_COMMON		Common Interface for Authorization Check	20060425
2	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	STRING		Identification	20060119
3	Returning	RP_NTF_TEMPLATE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_NOTIFICATION_TEMPLATE		Notification Template	20060119

Method INITIALIZE on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method INITIALIZE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_NTF_TEMPLATE_NOT_FOUND	Value transfer	☐	Type reference (TYPE)	CFX_BOOLEAN		Boolean Type	20060119

Method INITIALIZE_ATTRIBUTES on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method IS_RESTRICTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_RESTRICTED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060522

Method IS_RESTRICTED on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method IS_USED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_USED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060629

Method IS_USED on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method RELEASE_USE Signature

Method RELEASE_USE on class CL_CFX_NOTIFICATION_TEMPLATE has no parameter.
Method RELEASE_USE on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method RESTRICT_USE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OPTION	Call by reference	☐	Type reference (TYPE)	STRING			20060522

Method RESTRICT_USE on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method SELECT_NOTIFICATION_TEMPLATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NTF_TEMPLATES	Call by reference	☐	Type reference (TYPE)	CFX_TT_NTF_TMPL		Table of Notification Templates	20060110
2	Importing	I_USED_FOR	Call by reference	☑	Type reference (TYPE)	STRING			20060522

Method SELECT_NOTIFICATION_TEMPLATES on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Value transfer	☐	Type reference (TYPE)	CFX_NTF_TMPL_ID		ID for Notification Templates	20060313
2	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20060313
3	Importing	I_NOTE	Value transfer	☐	Type reference (TYPE)	STRING			20060313
4	Importing	I_PRIORITY	Value transfer	☐	Type reference (TYPE)	STRING			20060313
5	Importing	I_SUBJECT	Value transfer	☐	Type reference (TYPE)	STRING			20060313
6	Returning	RP_NTF_TEMPLATE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_NOTIFICATION_TEMPLATE		Manages a Notification Template	20060313

Method UPDATE on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

Method UPDATE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANGED_BY	Call by reference	☐	Type reference (TYPE)	CFX_CHANGED_BY		Changed by	20060313
2	Importing	I_CHANGED_ON	Call by reference	☐	Type reference (TYPE)	CFX_CHANGED_ON		Changed on	20060313
3	Importing	I_NOTE	Call by reference	☐	Type reference (TYPE)	CFX_COMMENT		Commentary Text for Notifications	20060313
4	Importing	I_PRIORITY	Call by reference	☐	Type reference (TYPE)	CFX_PRIORITY		Priority of a Notification	20060313
5	Importing	I_SUBJECT	Call by reference	☐	Type reference (TYPE)	CFX_SUBJECT		Subject of a Notification	20060313

Method UPDATE_ATTRIBUTES on class CL_CFX_NOTIFICATION_TEMPLATE has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	450