Directory.Search

Searches a directory for specified entries.

Parameters

Directory.id (Required)

Specifies the identifier of the directory to search.

Directory.queryCount

Specifies the number of directory items to retrieve.

Directory.Query[n].field

Specifies which field in the row is searched in the directory.

Valid search fields in the GroupWise Address Book are:

  • Directory.Item.department

  • Directory.Item.firstName

  • Directory.Item.lastName

  • Directory.Item.name

Valid search fields in a Personal Address Book are:

  • Directory.Item.cellPhone

  • Directory.Item.city

  • Directory.Item.country

  • Directory.Item.department

  • Directory.Item.displayName

  • Directory.Item.email

  • Directory.Item.fax

  • Directory.Item.firstName

  • Directory.Item.greeting

  • Directory.Item.homePhone

  • Directory.Item.instMessID

  • Directory.Item.lastName

  • Directory.Item.mailStop

  • Directory.Item.name

  • Directory.Item.orgName

  • Directory.Item.owner

  • Directory.Item.pager

  • Directory.Item.phone

  • Directory.Item.state

  • Directory.Item.street

  • Directory.Item.title

  • Directory.Item.zip

Directory.Query[n].filter

Specifies the filter type that is used in the search. Valid filter types are

  • Directory.Query.Filter.begin

  • Directory.Query.Filter.equal

  • Directory.Query.Filter.notBegin

  • Directory.Query.Filter.nEqual

Directory.Query[n].operator

Specifies an operation that will be used in the search. Valid operations are

  • Directory.Query.Operator.and

  • Directory.Query.Operator.end

  • Directory.Query.Operator.not

  • Directory.Query.Operator.or

Directory.Query[n].value

Specifies a unique value to search for in this row.

Directory.Query.itemType

Specifies the item type to be searched. Valid types are

  • Directory.Item.Type.all

  • Directory.Item.Type.group

  • Directory.Item.Type.organization

  • Directory.Item.Type.person

  • Directory.Item.Type.resource

Directory.queryFirst

Specifies the first name to use for the query. This parameter exists for backward compatibility only.

Directory.queryLast

Specifies the last name to use for the query. This parameter exists for backward compatibility only.

Directory.queryType

Specifies whether to query from the beginning of the list or from the current position. Valid values are

  • AddressBook.queryFirst(Default)

  • AddressBook.queryNext

User.context (Required)

Specifies the context identifier for this user’s session.

Return Values

Return Value

Description

Directory.count

Number of directories retrieved.

Directory.hasMore

There are more matches than were returned.

Directory[n].id

Identifier for the nth directory.

Directory[n].isEmpty

1 indicates that the nth directory is empty.

Directory[n].isReadOnly

1 indicates that the nth directory has read-only access.

Directory.Item[n].cellPhone

Cellular phone number of the nth item.

Directory.Item[n].city

City of the nth item.

Directory.Item[n].comments

Comments for the nth item.

Directory.Item.count

Number of items returned from the search.

Directory.Item[n].country

Country of the nth item.

Directory.Item[n].department

Department of the nth item.

Directory.Item[n].displayName

Display name of the nth item.

Directory.Item[n].email

Email address of the nth item.

Directory.Item[n].emailDisplay

Displayable version of the email address of the nth item.

Directory.Item[n].fax

Fax number of the nth item.

Directory.Item[n].firstName

First name of the nth item.

Directory.Item[n].greeting

Greeting of the nth item.

Directory.Item[n].homePhone

Home phone number of the nth item.

Directory.Item[n].id

Identifier of the nth item.

Directory.Item[n].instMessID

Instant message ID of the nth item.

Directory.Item[n].lastName

Last name of the nth item.

Directory.Item[n].mailStop

Mail stop of the nth item.

Directory.Item[n].name

Full name of the nth item.

Directory.Item[n].orgName

Organization name of the nth item.

Directory.Item[n].owner

Owner of the nth item.

Directory.Item[n].pager

Pager number of the nth item.

Directory.Item[n].phone

Telephone number of the nth item.

Directory.Item[n].state

State of the nth item.

Directory.Item[n].street

Address of the nth item.

Directory.Item[n].title

Title of the nth item.

Directory.Item[n].type

Item type of the nth item:

  • 4 Organization
  • 5 Resource
  • 6 Person (default)

Directory.Item[n].zip

Postal code of the nth item.

Directory[n].name

Name of the nth directory.

Directory.queryCount

Number of directory items to retrieve.

Directory.queryFirst

First name.

Directory.queryLast

Last name.

Directory.queryString

Query string used to perform the latest search.

Directory.queryTypeFiler

Directory.Query.itemType value used to perform the latest search.

Directory[n].type
  • 1 GroupWise Address Book
  • 7 Frequent Contacts (PAB)
  • 10 Personal Address Book

Remarks

A search is composed of several parameters. A valid search has the following parameters:

  • Directory.queryCount—Defined one time for each search.

  • Directory.id—Defined one time for each search.

  • Directory.Query.itemType—Defined one time for each search.

You must also provide a query string that can have 1 or more rows. A query row has the following parameters:

  • Directory.Query[n].field

  • Directory.Query[n].filter

  • Directory.Query[n].value

  • Directory.Query[n].operator

Example

<FORM method=post action=/servlet/webacc>
   <INPUT type="hidden" name="User.context" value="xyz">
   <INPUT type="hidden" name="action" value="Directory.Search">
   <INPUT type="hidden" name=" Directory.queryCount" value="25">
   <INPUT type="hidden" name="Directory.id" value="PAB">
   <INPUT type="hidden" name="Directory.Query.itemType" value="
      Directory.Item.Type.person">
   <INPUT type="input" name="Directory.Query.1.field"
      value="Directory.Item.firstName">
   <INPUT type="input" name="Directory.Query.1.filter"
      value="Directory.Query.Filter.betin">
   <INPUT type="input" name="Directory.Query.1.value" value="John">
   <INPUT type="input" name="Directory.Query.1.operator"
      value="Directory.Query.Operation.and">
   <INPUT type="submit" name="submit" value="Search">
</FORM>