com.google.code.linkedinapi.client.enumeration
Enum SearchParameter

java.lang.Object
  extended by java.lang.Enum<SearchParameter>
      extended by com.google.code.linkedinapi.client.enumeration.SearchParameter
All Implemented Interfaces:
FieldEnum, java.io.Serializable, java.lang.Comparable<SearchParameter>

public enum SearchParameter
extends java.lang.Enum<SearchParameter>
implements FieldEnum

Author:
Nabeel Mukhtar

Enum Constant Summary
COMPANY_NAME
          Returns members who have a particular company name on their profile.
COUNTRY_CODE
          Returns members within a specific country.
CURRENT_COMPANY
          Valid values are true or false.
CURRENT_SCHOOL
          Valid values are true or false.
CURRENT_TITLE
          Valid values are true or false.
DISTANCE
          Matches members within a distance from a central point.
FACET
          Facet values to search over.
FACETS
          Facet buckets to return.
FIRST_NAME
          Members with a matching first name.
KEYWORDS
          Returns members who have keywords anywhere in their profile.
LAST_NAME
          Members with a matching last name.
POSTAL_CODE
          Returns members within a specific postal code.
SCHOOL_NAME
          Members who have a matching school name on their profile.
TITLE
          Returns members who have a particular title on their profile
 
Field Summary
private  java.lang.String fieldName
          Field description
private static java.util.Map<java.lang.String,SearchParameter> stringToEnum
          Field Description.
 
Method Summary
 java.lang.String fieldName()
           
static SearchParameter fromString(java.lang.String symbol)
           
 java.lang.String toString()
          Method description
static SearchParameter valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SearchParameter[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

KEYWORDS

public static final SearchParameter KEYWORDS
Returns members who have keywords anywhere in their profile. Multiple words should be separated by a plus (+) sign. Boolean logic isn't supported in this parameter.


FIRST_NAME

public static final SearchParameter FIRST_NAME
Members with a matching first name. Matches must be exact. Multiple words should be separated by a space.


LAST_NAME

public static final SearchParameter LAST_NAME
Members with a matching last name. Matches must be exactly. Multiple words should be separated by a space.


COMPANY_NAME

public static final SearchParameter COMPANY_NAME
Returns members who have a particular company name on their profile. company works with the current-company parameter which specifies whether the company must be a current company or whether it can be anywhere on a profile.


CURRENT_COMPANY

public static final SearchParameter CURRENT_COMPANY
Valid values are true or false.


TITLE

public static final SearchParameter TITLE
Returns members who have a particular title on their profile


CURRENT_TITLE

public static final SearchParameter CURRENT_TITLE
Valid values are true or false.


SCHOOL_NAME

public static final SearchParameter SCHOOL_NAME
Members who have a matching school name on their profile.


CURRENT_SCHOOL

public static final SearchParameter CURRENT_SCHOOL
Valid values are true or false. A value of true matches members who currently attend the school specified in the school-name parameter.


COUNTRY_CODE

public static final SearchParameter COUNTRY_CODE
Returns members within a specific country.


POSTAL_CODE

public static final SearchParameter POSTAL_CODE
Returns members within a specific postal code.


DISTANCE

public static final SearchParameter DISTANCE
Matches members within a distance from a central point. This is measured in miles.


FACET

public static final SearchParameter FACET
Facet values to search over.


FACETS

public static final SearchParameter FACETS
Facet buckets to return.

Field Detail

stringToEnum

private static final java.util.Map<java.lang.String,SearchParameter> stringToEnum
Field Description.


fieldName

private final java.lang.String fieldName
Field description

Method Detail

values

public static SearchParameter[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (SearchParameter c : SearchParameter.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchParameter 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
java.lang.NullPointerException - if the argument is null

fieldName

public java.lang.String fieldName()
Specified by:
fieldName in interface FieldEnum
Returns:
the name of the field

toString

public java.lang.String toString()
Method description

Overrides:
toString in class java.lang.Enum<SearchParameter>
Returns:

fromString

public static SearchParameter fromString(java.lang.String symbol)
Returns:
Returns SearchParameter for string, or null if string is invalid