com.google.gwt.gdata.client.gbase.SnippetsEntry.java Source code

Introduction

Here is the source code for com.google.gwt.gdata.client.gbase.SnippetsEntry.java

Source

/*
 * Copyright 2009 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.gwt.gdata.client.gbase;

import com.google.gwt.gdata.client.batch.Interrupted;
import com.google.gwt.gdata.client.batch.Operation;
import com.google.gwt.gdata.client.batch.Status;

/**
 * Describes an entry in the feed of snippets of public items.
 */
public class SnippetsEntry extends com.google.gwt.gdata.client.Entry<SnippetsEntry> {

    /**
     * Constructs a Google Base snippet entry.
     * @return A SnippetsEntry object.
     */
    public static native SnippetsEntry newInstance() /*-{
                                                     return new $wnd.google.gdata.gbase.SnippetsEntry();
                                                     }-*/;

    protected SnippetsEntry() {
    }

    /**
     * Returns the attribute.
     * 
     * @param name Name of attribute.
     * @return Attribute.
     */
    public final Attribute[] getAttribute(String name) {
        return this.getAttributes().get(name);
    }

    /**
     * Returns the attributes. The returned object is a map from attribute name
     * to the associated Attribute class.
     * 
     * @return Attributes.
     */
    public final native MapAttribute getAttributes() /*-{
                                                     return this.getAttributes();
                                                     }-*/;

    /**
     * Returns the batch identifier. This element is optional.
     * 
     * @return Batch identifier.
     */
    public final native com.google.gwt.gdata.client.batch.Id getBatchId() /*-{
                                                                          return this.getBatchId();
                                                                          }-*/;

    /**
     * Returns the batch interruption information. This element is optional.
     * 
     * @return Batch interruption information.
     */
    public final native Interrupted getBatchInterrupted() /*-{
                                                          return this.getBatchInterrupted();
                                                          }-*/;

    /**
     * Returns the batch operation. This element is optional.
     * 
     * @return Batch operation.
     */
    public final native Operation getBatchOperation() /*-{
                                                      return this.getBatchOperation();
                                                      }-*/;

    /**
     * Returns the batch response status information. This element is optional.
     * 
     * @return Batch response status information.
     */
    public final native Status getBatchStatus() /*-{
                                                return this.getBatchStatus();
                                                }-*/;

    /**
     * Returns the link that provides the URI of an alternate format of the
     * entry's or feed's contents.
     * 
     * @return Link that provides the URI of an alternate format of the entry's
     * or feed's contents.
     */
    public final native com.google.gwt.gdata.client.atom.Link getHtmlLink() /*-{
                                                                            return this.getHtmlLink();
                                                                            }-*/;

    /**
     * Sets the attribute.
     * 
     * @param name name of attribute.
     * @param attribute Attribute to add, or object to use as a parameter to the
     * Attribute constructor.
     */
    public final native void setAttribute(String name, Attribute attribute) /*-{
                                                                            this.setAttribute(name, attribute);
                                                                            }-*/;

    /**
     * Sets the attributes. The parameter is a map from attribute name to the
     * associated Attribute class.
     * 
     * @param attributes Attributes, where each attribute is added using
     * setAttribute().
     */
    public final native void setAttributes(MapAttribute attributes) /*-{
                                                                    this.setAttributes(attributes);
                                                                    }-*/;

    /**
     * Sets the batch identifier. This element is optional.
     * 
     * @param batchId Batch identifier.
     */
    public final native void setBatchId(com.google.gwt.gdata.client.batch.Id batchId) /*-{
                                                                                      this.setBatchId(batchId);
                                                                                      }-*/;

    /**
     * Sets the batch interruption information. This element is optional.
     * 
     * @param batchInterrupted Batch interruption information.
     */
    public final native void setBatchInterrupted(Interrupted batchInterrupted) /*-{
                                                                               this.setBatchInterrupted(batchInterrupted);
                                                                               }-*/;

    /**
     * Sets the batch operation. This element is optional.
     * 
     * @param batchOperation Batch operation.
     */
    public final native void setBatchOperation(Operation batchOperation) /*-{
                                                                         this.setBatchOperation(batchOperation);
                                                                         }-*/;

    /**
     * Sets the batch response status information. This element is optional.
     * 
     * @param batchStatus Batch response status information.
     */
    public final native void setBatchStatus(Status batchStatus) /*-{
                                                                this.setBatchStatus(batchStatus);
                                                                }-*/;

}