/* Copyright (c) 2008 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.appsforyourdomain.provisioning;

import com.google.gdata.data.BaseEntry;
import com.google.gdata.data.Category;
import com.google.gdata.data.ExtensionDescription;
import com.google.gdata.data.ExtensionProfile;
import com.google.gdata.data.Kind;
import com.google.gdata.data.extensions.Who;
import com.google.gdata.util.Namespaces;

/**
 * Google Apps for Your Domain GData Entry which models a particular recipient
 * on an email list.  This is a simple Entry which contain only a single Who
 * extension.  
 *
 * This is temporary for code reviewers.
 * 
 * Sample XML.
 * <code>
 * <?xml version="1.0" encoding="UTF-8"?>
 * <atom:entry xmlns:atom="http://www.w3.org/2005/Atom">
 *   <atom:category scheme="http://schemas.google.com/g/2005#kind"
 * term="http://schemas.google.com/apps/2006#emailList.recipient"/>
 *   <gd:who xmlns:gd="http://schemas.google.com/g/2005"
 * email="SusanJones-1321@apps-provisioning-test.com"/>
 * </atom:entry>
 * </code>
 *
 * 
 */
@Kind.Term(EmailListRecipientEntry.EMAILLIST_RECIPIENT_KIND)
public class EmailListRecipientEntry
    extends BaseEntry<EmailListRecipientEntry> {

  /**
   * Kind term value for EmailListRecipient category labels.
   */
  public static final String EMAILLIST_RECIPIENT_KIND
      = com.google.gdata.data.appsforyourdomain.Namespaces.APPS_PREFIX
	  + "emailList.recipient";

  /**
   * Kind category used to label feeds or entries that have EmailListRecipient
   * extension data.
   */
  public static final Category EMAILLIST_RECIPIENT_CATEGORY =
      new Category(Namespaces.gKind, EMAILLIST_RECIPIENT_KIND);

  /**
   * Constructs a new empty EmailListRecipientEntry with the appropriate kind
   * category to indicate that it is an email list.
   */
  public EmailListRecipientEntry() {
    super();
    getCategories().add(EMAILLIST_RECIPIENT_CATEGORY);
  }

  /**
   * Constructs a new EmailListRecipientEntry by doing a shallow copy of data
   * from an existing BaseEntry intance.
   */
  public EmailListRecipientEntry(BaseEntry<?> sourceEntry) {
    super(sourceEntry);
    getCategories().add(EMAILLIST_RECIPIENT_CATEGORY);
  }

  /**
   * Declares an Extension.
   */
  @Override
  public void declareExtensions(ExtensionProfile extensionProfile) {

    // Who extension is repeatable by default.
    ExtensionDescription desc = Who.getDefaultDescription();
    desc.setRepeatable(false);

    // The Who extension is required for EmailListRecipientEntry
    desc.setRequired(true);
    extensionProfile.declare(EmailListRecipientEntry.class, desc);

    // Declare our "apps" namespace
    extensionProfile.declareAdditionalNamespace(
        com.google.gdata.data.appsforyourdomain.Namespaces.APPS_NAMESPACE);
  }

}