org.jclouds.vcloud.domain.Org Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jclouds-vcloud Show documentation
jclouds Core components to access vcloud
The newest version!
/**
 *
 * Copyright (C) 2010 Cloud Conscious, LLC. 
 *
 * ====================================================================
 * 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 org.jclouds.vcloud.domain;

import java.util.List;
import java.util.Map;

import javax.annotation.Nullable;

import org.jclouds.vcloud.domain.internal.OrgImpl;

import com.google.inject.ImplementedBy;

/**
 * A vCloud organization is a high-level abstraction that provides a unit of administration for
 * objects and resources. As viewed by a user, an organization (represented by an Org element) can
 * contain Catalog, Network, and vDC elements. If there are any queued, running, or recently
 * completed tasks owned by a member of the organization, it also contains a TasksList element. As
 * viewed by an administrator, an organization also contains users, groups, and other information
 * 
 * @author Adrian Cole
 */
@ImplementedBy(OrgImpl.class)
public interface Org extends ReferenceType {
   /**
    * optional description
    * 
    * @since vcloud api 0.8
    */
   @Nullable
   String getDescription();

   /**
    * full name of the organization
    * 
    * @since vcloud api 1.0
    */
   @Nullable
   String getFullName();

   /**
    * @since vcloud api 0.8
    */
   Map getCatalogs();

   /**
    * @since vcloud api 0.8
    */
   Map getVDCs();

   /**
    * If there are any queued, running, or recently completed tasks owned by a member of the
    * organization, it also contains a TasksList.
    * 
    * @since vcloud api 0.8
    */
   @Nullable
   ReferenceType getTasksList();

   /**
    * @since vcloud api 1.0
    */
   Map getNetworks();

   /**
    * read‐only container for Task elements. Each element in the container represents a queued,
    * running, or failed task owned by this object.
    * 
    * @since vcloud api 1.0
    */
   List getTasks();

}