org.openliberty.wsc
Enum PersonalProfileService.DataQueryOption

java.lang.Object
  java.lang.Enum<PersonalProfileService.DataQueryOption>
      org.openliberty.wsc.PersonalProfileService.DataQueryOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PersonalProfileService.DataQueryOption>

Enclosing class:

PersonalProfileService

public static enum PersonalProfileService.DataQueryOption
extends java.lang.Enum<PersonalProfileService.DataQueryOption>

This enumeration models Table 3. Data Availability Discovery Option Keywords from section 2.1.1 of the liberty-idsis-pp-v1.1 specification document.

The keywords that express data availability extract selected components from the profile as if an XPATH expression were applied. An implementation is not required to use XPATH if the results are equivalent. Presence of the keyword implies that the corresponding data can be obtained, if queried. However, the data may not be available due to permissions or race conditions between data removal and updates to the discovery service.

Author:

asa

Enum Constant Summary

ADDRESS
Has some address card data

COMMON_NAME
Has some common name data

DEMOGRAPHICS
Has some demographics data

DOMOCILE
Has some address card data corresponding to the domicile

EMERGENCY
Has some emergency contact data

EMPLOYMENT
Has some employment identity data

FACADE
Has some facade data

HOME
Has some address card data corresponding to the home address

INFORMAL_NAME
Has informal name

KEYS
Has either or both keys

LEGAL_IDENTITY
Has some legal identity data

MOBILE
Has some messaging contact data for mobile contact

PERSONAL
Has some messaging contact data corresponding to personal contact

PP
Has some ID-SIS-PP data

VACATION
Has some messaging contact or address data for vacation contact

WORK
Has some address card or messaging contact data corresponding to the office address

Field Summary

private java.lang.String[]	equivalentXPaths
private java.lang.String	keyword
private java.lang.String	meaning

Method Summary

PersonalProfileService.DataQueryOption	dataAvailabilityOptionForKeyword(java.lang.String keyword) returns a DataQueryOption matching the supplied keyword
java.lang.String[]	equivalentXPaths() XPath equivalents that may be used for creating queries
java.lang.String	keyword() The keyword uri for this DataQueryOption.
java.lang.String	meaning() The english meaning of this DataQueryOption
static PersonalProfileService.DataQueryOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PersonalProfileService.DataQueryOption[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PP

public static final PersonalProfileService.DataQueryOption PP

Has some ID-SIS-PP data

DOMOCILE

public static final PersonalProfileService.DataQueryOption DOMOCILE

Has some address card data corresponding to the domicile

HOME

public static final PersonalProfileService.DataQueryOption HOME

Has some address card data corresponding to the home address

WORK

public static final PersonalProfileService.DataQueryOption WORK

Has some address card or messaging contact data corresponding to the office address

PERSONAL

public static final PersonalProfileService.DataQueryOption PERSONAL

Has some messaging contact data corresponding to personal contact

MOBILE

public static final PersonalProfileService.DataQueryOption MOBILE

Has some messaging contact data for mobile contact

VACATION

public static final PersonalProfileService.DataQueryOption VACATION

Has some messaging contact or address data for vacation contact

ADDRESS

public static final PersonalProfileService.DataQueryOption ADDRESS

Has some address card data

COMMON_NAME

public static final PersonalProfileService.DataQueryOption COMMON_NAME

Has some common name data

INFORMAL_NAME

public static final PersonalProfileService.DataQueryOption INFORMAL_NAME

Has informal name

LEGAL_IDENTITY

public static final PersonalProfileService.DataQueryOption LEGAL_IDENTITY

Has some legal identity data

EMPLOYMENT

public static final PersonalProfileService.DataQueryOption EMPLOYMENT

Has some employment identity data

FACADE

public static final PersonalProfileService.DataQueryOption FACADE

Has some facade data

KEYS

public static final PersonalProfileService.DataQueryOption KEYS

Has either or both keys

DEMOGRAPHICS

public static final PersonalProfileService.DataQueryOption DEMOGRAPHICS

Has some demographics data

EMERGENCY

public static final PersonalProfileService.DataQueryOption EMERGENCY

Has some emergency contact data

Field Detail

keyword

private java.lang.String keyword

equivalentXPaths

private java.lang.String[] equivalentXPaths

meaning

private java.lang.String meaning

Method Detail

values

public static final PersonalProfileService.DataQueryOption[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(PersonalProfileService.DataQueryOption c : PersonalProfileService.DataQueryOption.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static PersonalProfileService.DataQueryOption valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

keyword

public java.lang.String keyword()

The keyword uri for this DataQueryOption.

Returns:

equivalentXPaths

public java.lang.String[] equivalentXPaths()

XPath equivalents that may be used for creating queries

Returns:

meaning

public java.lang.String meaning()

The english meaning of this DataQueryOption

Returns:

dataAvailabilityOptionForKeyword

public PersonalProfileService.DataQueryOption dataAvailabilityOptionForKeyword(java.lang.String keyword)

returns a DataQueryOption matching the supplied keyword

Parameters:

keyword -

Returns:

a DataQueryOption or null if there is no match