org.wso2.carbon.registry.social.api.activity
Enum Activity.Field

java.lang.Object
  extended by java.lang.Enum<Activity.Field>
      extended by org.wso2.carbon.registry.social.api.activity.Activity.Field
All Implemented Interfaces:
Serializable, Comparable<Activity.Field>
Enclosing interface:
Activity

public static enum Activity.Field
extends Enum<Activity.Field>

The fields that represent the activity object in json form.

All of the fields that activities can have.

It is only OPTIONAL to set one of TITLE_ID or TITLE. In addition, if you are using any variables in your title or title template, you must set TEMPLATE_PARAMS.

Other possible fields to set are: URL, MEDIA_ITEMS, BODY_ID, BODY, EXTERNAL_ID, PRIORITY, STREAM_TITLE, STREAM_URL, STREAM_SOURCE_URL, and STREAM_FAVICON_URL.

Containers are only OPTIONAL to use TITLE_ID or TITLE, they may ignore additional parameters.


Enum Constant Summary
APP_ID
          the json field for appId.
BODY
          the json field for body.
BODY_ID
          the json field for bodyId.
EXTERNAL_ID
          the json field for externalId.
ID
          the json field for id.
LAST_UPDATED
          the json field for updated.
MEDIA_ITEMS
          the json field for mediaItems.
POSTED_TIME
          the json field for postedTime.
PRIORITY
          the json field for priority.
STREAM_FAVICON_URL
          the json field for streamFaviconUrl.
STREAM_SOURCE_URL
          the json field for streamSourceUrl.
STREAM_TITLE
          the json field for streamTitle.
STREAM_URL
          the json field for streamUrl.
TEMPLATE_PARAMS
          the json field for templateParams.
TITLE
          the json field for title.
TITLE_ID
          the json field for titleId.
URL
          the json field for url.
USER_ID
          the json field for userId.
 
Method Summary
 String toString()
          emit the field as a json element.
static Activity.Field valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Activity.Field[] 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

APP_ID

public static final Activity.Field APP_ID
the json field for appId.


BODY

public static final Activity.Field BODY
the json field for body.


BODY_ID

public static final Activity.Field BODY_ID
the json field for bodyId.


EXTERNAL_ID

public static final Activity.Field EXTERNAL_ID
the json field for externalId.


ID

public static final Activity.Field ID
the json field for id.


LAST_UPDATED

public static final Activity.Field LAST_UPDATED
the json field for updated.


MEDIA_ITEMS

public static final Activity.Field MEDIA_ITEMS
the json field for mediaItems.


POSTED_TIME

public static final Activity.Field POSTED_TIME
the json field for postedTime.


PRIORITY

public static final Activity.Field PRIORITY
the json field for priority.


STREAM_FAVICON_URL

public static final Activity.Field STREAM_FAVICON_URL
the json field for streamFaviconUrl.


STREAM_SOURCE_URL

public static final Activity.Field STREAM_SOURCE_URL
the json field for streamSourceUrl.


STREAM_TITLE

public static final Activity.Field STREAM_TITLE
the json field for streamTitle.


STREAM_URL

public static final Activity.Field STREAM_URL
the json field for streamUrl.


TEMPLATE_PARAMS

public static final Activity.Field TEMPLATE_PARAMS
the json field for templateParams.


TITLE

public static final Activity.Field TITLE
the json field for title.


TITLE_ID

public static final Activity.Field TITLE_ID
the json field for titleId.


URL

public static final Activity.Field URL
the json field for url.


USER_ID

public static final Activity.Field USER_ID
the json field for userId.

Method Detail

values

public static Activity.Field[] 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 (Activity.Field c : Activity.Field.values())
    System.out.println(c);

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

valueOf

public static Activity.Field valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

toString

public String toString()
emit the field as a json element.

Overrides:
toString in class Enum<Activity.Field>
Returns:
the field name


Copyright © 2013 WSO2 Inc. All Rights Reserved.