1 /**
2 *
3 * Copyright (C) 2011 Cloud Conscious, LLC. <info@cloudconscious.com>
4 *
5 * ====================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 * ====================================================================
18 */
19 package org.jclouds.vcloud.domain;
20
21 import java.util.List;
22 import java.util.Map;
23
24 import javax.annotation.Nullable;
25
26 import org.jclouds.vcloud.domain.internal.OrgImpl;
27
28 import com.google.inject.ImplementedBy;
29
30 /**
31 * A vCloud organization is a high-level abstraction that provides a unit of administration for
32 * objects and resources. As viewed by a user, an organization (represented by an Org element) can
33 * contain Catalog, Network, and vDC elements. If there are any queued, running, or recently
34 * completed tasks owned by a member of the organization, it also contains a TasksList element. As
35 * viewed by an administrator, an organization also contains users, groups, and other information
36 *
37 * @author Adrian Cole
38 */
39 @ImplementedBy(OrgImpl.class)
40 public interface Org extends ReferenceType {
41 /**
42 * optional description
43 *
44 * @since vcloud api 0.8
45 */
46 @Nullable
47 String getDescription();
48
49 /**
50 * full name of the organization
51 *
52 * @since vcloud api 1.0
53 */
54 @Nullable
55 String getFullName();
56
57 /**
58 * @since vcloud api 0.8
59 */
60 Map<String, ReferenceType> getCatalogs();
61
62 /**
63 * @since vcloud api 0.8
64 */
65 Map<String, ReferenceType> getVDCs();
66
67 /**
68 * If there are any queued, running, or recently completed tasks owned by a member of the
69 * organization, it also contains a TasksList.
70 *
71 * @since vcloud api 0.8
72 */
73 @Nullable
74 ReferenceType getTasksList();
75
76 /**
77 * @since vcloud api 1.0
78 */
79 Map<String, ReferenceType> getNetworks();
80
81 /**
82 * readâonly container for Task elements. Each element in the container represents a queued,
83 * running, or failed task owned by this object.
84 *
85 * @since vcloud api 1.0
86 */
87 List<Task> getTasks();
88
89 }