ClassName

atg.userdirectory.droplet.UserListDroplet

Component

atg/userdirectory/droplet/UserList

The UserListDroplet servlet bean lets you search for all users assigned to a particular organization. An optional input parameter can be used to exclude a user from the search. Based on the search results, additional content is rendered by the open parameters you specify.

Be sure to set the userDirectory property to relevant the User Directory component.

Input Parameters

organizationId
This required parameter specifies the organization containing the users you want to locate.

excludedId
This optional parameter holds a user ID string that should be removed from the result set.

Output Parameter

users
This parameter contains in a java.util.Collection the users who are part of the specified organization.

Open Parameters

empty
This parameter is rendered when no items are returned from the query.

error
This parameter renders when an invalid organization ID or no Organizational ID is provided.

output
This parameter renders when items are returned from the query.

Example

This example demonstrates how UserListDroplet locates all users assigned to the org212 organization, skipping user 80314. Descriptive text is provided when no items are returned or an error occurs. When users are found for the organization, they are displayed in a list.

<dsp:droplet name="/atg/userdirectory/droplet/UserList">
   <dsp:param name="organizationId" value="org212"/>
   <dsp:param name="excludedId" value="80314"/>

   <dsp:oparam name="empty">
      That organization doesn't have any users assigned to it.
   </dsp:oparam>

   <dsp:oparam name="error">
      Error: try your search again. Make sure you are using a valid organizational
      ID.
   </dsp:oparam>

   <dsp:oparam name="output">
      <dsp:droplet name="/atg/dynamo/droplet/ForEach">
         <dsp:param name="array" param="users"/>

         <dsp:oparam name="output">
            The following users are part of the organization:
            <dsp:valueof param="element.lastName"/>,
            <dsp:valueof param="element.firstName"/>
         </dsp:oparam>
      </dsp:droplet>

</dsp:droplet>
 
loading table of contents...