commentdata.java

google的gdata api包

/* Copyright (c) 2006 Google Inc.
 *
 * Licensed 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 com.google.gdata.data.photos;

import com.google.gdata.data.Category;

/**
 * Shared comment data object, this contains all setters/getters of fields that
 * are specific to a comment.
 *
 * 
 */
public interface CommentData extends GphotoData {

  /** The unqualified kind for a comment. */
  public static final String KIND = "comment";

  /** The fully qualified kind term for comments. */
  public static final String COMMENT_KIND
      = Namespaces.PHOTOS_PREFIX + KIND;

  /** A category object for comments.  All comments will have this set. */
  public static final Category COMMENT_CATEGORY
      = new Category(com.google.gdata.util.Namespaces.gKind, COMMENT_KIND);

  /**
   * @return the albumId of the album this comment is on.
   */
  public String getAlbumId();

  /**
   * Set the albumId for the album this comment is on.
   *
   * @param albumId the albumId of the comment.
   */
  public void setAlbumId(Long albumId);

  /**
   * Set the albumId by string for the album the comment is on.
   *
   * @param albumId the albumId of the comment.
   */
  public void setAlbumId(String albumId);

  /**
   * @return the photoId of the photo this comment is on.
   */
  public String getPhotoId();

  /**
   * Set the photoId for the photo this comment is on.
   *
   * @param photoId the photoId of the comment.
   */
  public void setPhotoId(Long photoId);


  /**
   * Set the photoId as a string for the photo this comment is on.
   *
   * @param photoId the photoId of the comment.
   */
  public void setPhotoId(String photoId);
}