create_list function

Related topics

Contained in package wwsec_api.

Call this function to create a new group and return a group ID.

function create_list

(

p_name in varchar2,

p_ site_id in number default GLOBAL_GROUP,

p_description, in varchar2 default null,

p_hidden_group in number default NOT_HIDDEN,

p_hidden_members in number default NOT_HIDDEN

)

return number;

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_name

A name for the new group.

Note: p_name must be unique for the site in which it is created and unique among global groups.

Datatype: in varchar2

p_ site_id

The unique identifier for the site in which the group will be created.

Note: This parameter is ignored in Oracle9iAS Portal 9.0.2 and later.

Datatype: in number
Default: GLOBAL_GROUP

p_description

A description of the new group.

Datatype: in varchar2
Default: null

p_hidden_group

Indicates if the new group is hidden from users and groups (except those who are owners of the new group).

Datatype: in number
Default: NOT_HIDDEN

p_hidden_members

Indicates whether the members of the group are hidden from each other (but not from owners).

Note: This parameter is ignored in Oracle9iAS Portal 9.0.2 and later.

Datatype: in number
Default: NOT_HIDDEN

Returns:

This function returns a group ID.

Exceptions:

If the site does not exist, an INVALID_ SITE_EXCEPTION is raised.

If a group with the same name exists, DUPLICATE_GROUP_EXCEPTION is raised.

If the group name is invalid, INVALID_GRP_NAME_EXCEPTION is raised.

If the user who initiates the calling routine has insufficient authority to execute the routine, an ACCESS_DENIED_EXCEPTION is raised.

Example:

l_groupid number;

l_groupid := wwsec_api.create_list

(

p_name => 'DEVELOPER',

p_description => 'This is a group for developers'

);

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_name	A name for the new group. Note: p_name must be unique for the site in which it is created and unique among global groups. Datatype: in varchar2
p_ site_id	The unique identifier for the site in which the group will be created. Note: This parameter is ignored in Oracle9iAS Portal 9.0.2 and later. Datatype: in number Default: GLOBAL_GROUP
p_description	A description of the new group. Datatype: in varchar2 Default: null
p_hidden_group	Indicates if the new group is hidden from users and groups (except those who are owners of the new group). Datatype: in number Default: NOT_HIDDEN
p_hidden_members	Indicates whether the members of the group are hidden from each other (but not from owners). Note: This parameter is ignored in Oracle9iAS Portal 9.0.2 and later. Datatype: in number Default: NOT_HIDDEN
Returns: This function returns a group ID. Exceptions: If the site does not exist, an INVALID_ SITE_EXCEPTION is raised. If a group with the same name exists, DUPLICATE_GROUP_EXCEPTION is raised. If the group name is invalid, INVALID_GRP_NAME_EXCEPTION is raised. If the user who initiates the calling routine has insufficient authority to execute the routine, an ACCESS_DENIED_EXCEPTION is raised. Example: l_groupid number; l_groupid := wwsec_api.create_list ( p_name => 'DEVELOPER', p_description => 'This is a group for developers' );

Related topics
Security API packages	PDK PL/SQL API Reference - Home