/*
 * Copyright 2010-2011 Ning, Inc.
 *
 * Ning licenses this file to you 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.ning.billing.util.api;

import java.util.List;
import java.util.UUID;

import com.ning.billing.util.callcontext.CallContext;

import com.ning.billing.util.dao.ObjectType;
import com.ning.billing.util.tag.Tag;
import com.ning.billing.util.tag.TagDefinition;

// TODO: add ability to create, update and remove tags
public interface TagUserApi {
    /***
     *
     * @return the list of all available tag definitions
     */
    public List<TagDefinition> getTagDefinitions();

    /***
     *
     * @param definitionName Identifies the definition.
     * @param description Describes the use of the definition.
     * @param context The call context, for auditing purposes
     * @return the newly created tag definition
     * @throws TagDefinitionApiException
     */
    public TagDefinition create(String definitionName, String description, CallContext context) throws TagDefinitionApiException;

    /***
     *
     * @param definitionName Identifies the definition.
     * @param context The call context, for auditing purposes
     * @throws TagDefinitionApiException
     */
    public void deleteAllTagsForDefinition(String definitionName, CallContext context) throws TagDefinitionApiException;

    /***
     *
     * @param definitionName Identifies the definition.
     * @param context The call context, for auditing purposes
     * @throws TagDefinitionApiException
     */
    public void deleteTagDefinition(String definitionName, CallContext context) throws TagDefinitionApiException;

	/**
	 * 
	 * @param name
	 * @return the tag with this definition
     * @throws TagDefinitionApiException
	 */
	public TagDefinition getTagDefinition(String name) throws TagDefinitionApiException;

	public List<Tag> createControlTags(UUID objectId, ObjectType objectType, List<TagDefinition> tagDefinitions) throws TagDefinitionApiException;

    public Tag createControlTag(UUID objectId, ObjectType objectType, TagDefinition tagDefinition) throws TagDefinitionApiException;

	public List<Tag> createDescriptiveTags(UUID objectId, ObjectType objectType, List<TagDefinition> tagDefinitions) throws TagDefinitionApiException;

	public Tag createDescriptiveTag(UUID objectId, ObjectType objectType, TagDefinition tagDefinition) throws TagDefinitionApiException;
}
