1 PACKAGE UMX_REGISTER_USER_PVT AUTHID CURRENT_USER as
2 /* $Header: UMXIBURS.pls 120.2 2005/09/01 03:34:25 kching noship $ */
3 -- Start of Comments
4 -- Package name : UMX_REGISTER_USER_PVT
5 -- Purpose :
6 -- This package contains specification individual user registration
7
8 --G_CREATED_BY_MODULE VARCHAR2(3) := 'UMX';
9 --
10 -- Function
11 -- create_person_party
12 --
13 -- Description
14 -- This method is a subscriber to the event oracle.apps.fnd.umx.createpersonp
15 -- TCA apis are used to populate into hz tables
16 -- based on the page from where this is invoked, a B2B or B2C party is created
17 -- IN
18 -- the signature follows Workflow business events standards
19 -- p_subscription_guid - Run/Cancel/Timeout
20 -- IN/OUT
21 -- p_event - WF_EVENT_T which holds the data that needs to passed from/to
22 -- subscriber of the event
23 --
24
25
26 function create_person_party(p_subscription_guid in raw,
27 p_event in out NOCOPY WF_EVENT_T
28 ) return varchar2;
29
30 --
31 -- Procedure
32 -- check_approval_defined
33 -- Description
34 -- check if ame approval has been defined for this registration service.
35 -- IN
36 -- itemtype - A valid item type from (WF_ITEM_TYPES table).
37 -- itemkey - A string generated from the application object's primary key.
38 -- actid - The function activity(instance id).
39 -- command - Run/Cancel/Timeout
40 -- OUT
41 -- resultout - result of the process based on which the next step is followed
42
43 --Procedure RegisterIndividualUser(p_event in out NOCOPY WF_EVENT_T);
44
45 --
46 -- Procedure
47 -- check_approval_defined
48 -- Description
49 -- check if ame approval has been defined for this registration service.
50 -- IN
51 -- itemtype - A valid item type from (WF_ITEM_TYPES table).
52 -- itemkey - A string generated from the application object's primary key.
53 -- actid - The function activity(instance id).
54 -- command - Run/Cancel/Timeout
55 -- OUT
56 -- resultout - result of the process based on which the next step is followed
57
58 --Procedure RegisterBusinessUser(p_event in out NOCOPY WF_EVENT_T);
59
60
61 G_CREATED_BY_MODULE VARCHAR2(3) := 'UMX';
62
63 --
64 -- Procedure
65 -- Get_Party_Email_Address
66 -- Description
67 -- This API will ...
68 -- Get the email address from the person party.
69 -- If email is missing, then ...
70 -- Get the email address from the party relationship.
71 -- If email is still missing, then return null
72 --
73 -- IN
74 -- p_person_party_id - The party ID of the person defined in hz_parties table
75 -- OUT
76 -- x_email_address - Email address of the person
77
78 Procedure Get_Party_Email_Address (p_person_party_id in hz_parties.party_id%type,
79 x_email_address out NOCOPY hz_parties.email_address%type);
80
81
82 FUNCTION GET_PERSON_EMAIL_ADDRESS(p_person_party_id in hz_parties.party_id%type) return varchar2;
83
84 --
85 -- Function
86 -- Register_Individual_User
87 --
88 -- Description
89 -- This method is a subscriber to the event oracle.apps.fnd.umx.individualuser.create
90 -- TCA apis are used to populate into hz tables
91 -- This method creates a business User
92 -- IN
93 -- the signature follows Workflow business events standards
94 -- p_subscription_guid - Run/Cancel/Timeout
95 -- IN/OUT
96 -- p_event - WF_EVENT_T which holds the data that needs to passed from/to
97 -- subscriber of the event
98 --
99
100
101
102
103 function Register_Individual_user(p_subscription_guid in raw,
104 p_event in out NOCOPY WF_EVENT_T)
105 return varchar2;
106
107 function Register_Business_user(p_subscription_guid in raw,
108 p_event in out NOCOPY WF_EVENT_T)
109 return varchar2;
110
111 --
112 -- Function
113 -- userExists
114 -- Description
115 -- This API is a wrapper for fnd_user_pkg.userExists that
116 -- will return 'Y' if username is being used and
117 -- 'N' if username is not being used.
118 -- IN
119 -- p_user_name - User name
120 -- OUT
121 -- 'Y' - User name is being used.
122 -- 'N' - User name is not being used.
123 function userExists (p_user_name in fnd_user.user_name%type) return varchar2;
124
125 --
126 -- Procedure
127 -- TestUserName
128 -- Description
129 -- This API is a wrapper to fnd_user_pkg.TestUserName.
130 -- "This api test whether a username exists in FND and/or in OID."
131 -- IN
132 -- p_user_name - User name to be tested.
133 -- OUT
134 -- x_return_status - The following statuses are defined in fnd_user_pkg:
135 -- USER_OK_CREATE : User does not exist in either FND or OID
136 -- USER_INVALID_NAME : User name is not valid
137 -- USER_EXISTS_IN_FND : User exists in FND
138 -- USER_SYNCHED : User exists in OID and next time when this user gets created
139 -- in FND, the two will be synched together.
140 -- USER_EXISTS_NO_LINK_ALLOWED: User exists in OID and no synching allowed.
141 -- x_message_app_name - The application short name of the message in the fnd
142 -- message stack that contents the detail message.
143 -- x_message_name - The message name of the message in the FND message stack that
144 -- contents the detail message.
145 -- x_message_text - The detail message in the FND message stack.
146 ----------------------------------------------------------------------------
147 Procedure TestUserName (p_user_name in fnd_user.user_name%type,
148 x_return_status out nocopy pls_integer,
149 x_message_app_name out nocopy fnd_application.application_short_name%type,
150 x_message_name out nocopy fnd_new_messages.message_name%type,
151 x_message_text out nocopy fnd_new_messages.message_text%type);
152
153 end UMX_REGISTER_USER_PVT;
[Home] [Help]