com.huawei.openstack4j.api.identity.v3.ProjectService Maven / Gradle / Ivy

/*******************************************************************************
 * 	Copyright 2016 ContainX and OpenStack4j                                          
 * 	                                                                                 
 * 	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.huawei.openstack4j.api.identity.v3;

import java.util.List;

import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.common.ActionResponse;
import com.huawei.openstack4j.model.identity.v3.Project;

/**
 * Identity Project Service
 *
 */
public interface ProjectService extends RestService {

	/**
	 * Creates a new Project
	 *
	 * @param project the project to create
	 * @return the new Project including it's id
	 */
	Project create(Project project);

	/**
	 * Creates a new Project
	 *
	 * @param domainId the domain id
	 * @param name the name of the new project
	 * @param description the description of the new project
	 * @param enabled the enabled status of the new project
	 * @return the newly created project
	 */
	Project create(String domainId, String name, String description, boolean enabled);

	/**
	 * get detailed information on a project
	 *
	 * @param projectId the project id
	 * @return the project
	 */
	Project get(String projectId);

	/**
	 * get detailed information about projects machting specified name across all domains
	 *
	 * @param projectName the project name
	 * @return the list of projects matching the name across all domains
	 */
	List getByName(String projectName);

	/**
     * get detailed information about a project specified by project name and domain id
	 *
	 * @param projectName the project name
	 * @param domainId the domain id
	 * @return the project or null if not found
	 */
	Project getByName(String projectName, String domainId);

	/**
	 * updates an existing project
	 *
	 * @param project the project set to update
	 * @return the updated project
	 */
	Project update(Project project);

	/**
	 * delete a project by id
	 *
	 * @param projectId the project id
	 * @return the ActionResponse
	 */
	ActionResponse delete(String projectId);

	/**
	 * list all projects the current token has access to
	 *
	 * @return list of projects
	 */
	List list();

}