org.apache.shindig.extras.as.opensocial.model.ActivityEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of shindig-extras Show documentation
Provides extra, deprecated or extended functionality. The items here have unstable APIs and could change at any time.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package org.apache.shindig.extras.as.opensocial.model;

import java.util.List;

import org.apache.shindig.protocol.model.Exportablebean;
import org.apache.shindig.extras.as.core.model.ActivityEntryImpl;

import com.google.inject.ImplementedBy;

/**
 * ActivityEntry interface.
 * TODO: comment a description for this class
 * TODO: ensure verbs are up to date
 * TODO: comment all classes
 */

@ImplementedBy(ActivityEntryImpl.class)
@Exportablebean
public interface ActivityEntry {
  
  /**
   * Fields that represent JSON elements for an activity entry.
   */
  public static enum Field {
    ICON("icon"),
    TIME("time"),
    ACTOR("actor"),
    VERB("verb"),
    OBJECT("object"),
    TARGET("target"),
    GENERATOR("generator"),
    SERVICE_PROVIDER("serviceProvider"),
    TITLE("title"),
    BODY("body"),
    STANDARD_LINK("standardLink");
    
    /**
     * The name of the JSON element.
     */
    private final String jsonString;
    
    /**
     * Constructs the field base for the JSON element.
     * 
     * @param jsonString the name of the element
     */
    private Field(String jsonString) {
      this.jsonString = jsonString;
    }
    
    /**
     * Returns the name of the JSON element.
     * 
     * @return String the name of the JSON element
     */
    public String toString() {
      return jsonString;
    }
  }
  
  /**
   * Possible verbs for an activity stream entry.
   */
  public static enum Verb {
    MARK_AS_FAVORITE("markAsFavorite"),
    START_FOLLOWING("startFollowing"),
    MARK_AS_LIKED("markAsLiked"),
    MAKE_FRIEND("makeFriend"),
    JOIN("join"),
    PLAY("play"),
    POST("post"),
    SAVE("save"),
    SHARE("share"),
    TAG("tag"),
    UPDATE("update");
    
    /**
     * The name of the JSON element.
     */
    private final String jsonString;
    
    /**
     * Constructs the field base for the JSON element.
     * 
     * @param jsonString the name of the element
     */
    private Verb(String jsonString) {
      this.jsonString = jsonString;
    }
    
    /**
     * Returns the name of the JSON element.
     * 
     * @return String the name of the JSON element
     */
    public String toString() {
      return jsonString;
    }
  }
  
  /**
   * getIcon
   *
   * @return a {@link java.lang.String} object.
   */
  String getIcon();

  /**
   * setIcon
   *
   * @param icon a {@link java.lang.String} object.
   */
  void setIcon(String icon);

  /**
   * getTime
   *
   * @return a {@link java.lang.String} object.
   */
  String getTime();

  /**
   * setTime
   *
   * @param time a {@link java.lang.String} object.
   */
  void setTime(String time);

  /**
   * getActor
   *
   * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  ActivityObject getActor();

  /**
   * setActor
   *
   * @param actor a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  void setActor(ActivityObject actor);

  /**
   * getVerb
   *
   * @return a {@link java.util.List} object.
   */
  List getVerb();

  /**
   * setVerb
   *
   * @param verb a {@link java.util.List} object.
   */
  void setVerb(List verb);

  /**
   * getObject
   *
   * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  ActivityObject getObject();

  /**
   * setObject
   *
   * @param object a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  void setObject(ActivityObject object);
  
  /**
   * getTarget
   *
   * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  ActivityObject getTarget();
  
  /**
   * setTarget
   *
   * @param target a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  void setTarget(ActivityObject target);
  
  /**
   * getGenerator
   *
   * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  ActivityObject getGenerator();

  /**
   * setGenerator
   *
   * @param generator a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  void setGenerator(ActivityObject generator);

  /**
   * getServiceProvider
   *
   * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  ActivityObject getServiceProvider();

  /**
   * setServiceProvider
   *
   * @param serviceProvider a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
   */
  void setServiceProvider(ActivityObject serviceProvider);

  /**
   * getTitle
   *
   * @return a {@link java.lang.String} object.
   */
  String getTitle();

  /**
   * setTitle
   *
   * @param title a {@link java.lang.String} object.
   */
  void setTitle(String title);

  /**
   * getBody
   *
   * @return a {@link java.lang.String} object.
   */
  String getBody();

  /**
   * setBody
   *
   * @param body a {@link java.lang.String} object.
   */
  void setBody(String body);

  /**
   * getStandardLink
   *
   * @return a {@link java.util.List} object.
   */
  List getStandardLink();

  /**
   * setStandardLink
   *
   * @param standardLink a {@link java.util.List} object.
   */
  void setStandardLink(List standardLink);
}