DefaultProduct.java

/*
 * 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.catalog;

import com.ning.billing.catalog.api.Product;
import com.ning.billing.catalog.api.ProductCategory;
import com.ning.billing.util.config.ValidatingConfig;
import com.ning.billing.util.config.ValidationErrors;

import javax.xml.bind.annotation.*;
import java.net.URI;

@XmlAccessorType(XmlAccessType.NONE)
public class DefaultProduct extends ValidatingConfig<StandaloneCatalog> implements Product {
	private static final DefaultProduct[] EMPTY_PRODUCT_LIST = new DefaultProduct[0];
	
	@XmlAttribute (required=true)
	@XmlID
    private String name;

	@XmlElement(required=true)
    private ProductCategory category;
	
	@XmlElementWrapper(name="included", required=false)
	@XmlIDREF @XmlElement(name="addonProduct", required=true)
    private DefaultProduct[] included = EMPTY_PRODUCT_LIST;
	
	@XmlElementWrapper(name="available", required=false)
	@XmlIDREF @XmlElement(name="addonProduct", required=true)
    private DefaultProduct[] available = EMPTY_PRODUCT_LIST;

	//Not included in XML
	private String catalogName;
	
	
	@Override
	public String getCatalogName() {
		return catalogName;
	}

	@Override
    public ProductCategory getCategory() {
		return category;
	}

    @Override
	public DefaultProduct[] getIncluded() {
		return included;
	}

    @Override
	public DefaultProduct[] getAvailable() {
		return available;
	}

	public DefaultProduct() {
    }

	public DefaultProduct(String name, ProductCategory category) {
		this.category = category;
		this.name = name;
    }

    @Override
	public String getName() {
        return name;
    }

	public boolean isIncluded(DefaultProduct addon) {
		for(DefaultProduct p : included) {
			if (addon == p) {
				return true;
			}
		}
		return false;
	}

	public boolean isAvailable(DefaultProduct addon) {
		for(DefaultProduct p : included) {
			if (addon == p) {
				return true;
			}
		}
		return false;
	}
	
	@Override
	public void initialize(StandaloneCatalog catalog, URI sourceURI) {
		catalogName = catalog.getCatalogName();
	}

	@Override
	public ValidationErrors validate(StandaloneCatalog catalog, ValidationErrors errors) {
		//TODO: MDW validation: inclusion and exclusion lists can only contain addon products
		//TODO: MDW validation: a given product can only be in, at most, one of inclusion and exclusion lists
		return errors;
	}

	protected DefaultProduct setName(String name) {
		this.name = name;
		return this;
	}

	protected DefaultProduct setCatagory(ProductCategory category) {
		this.category = category;
		return this;
	}

	protected DefaultProduct setCategory(ProductCategory category) {
		this.category = category;
		return this;
	}

	protected DefaultProduct setIncluded(DefaultProduct[] included) {
		this.included = included;
		return this;
	}

	protected DefaultProduct setAvailable(DefaultProduct[] available) {
		this.available = available;
		return this;
	}

	protected DefaultProduct setCatalogName(String catalogName) {
		this.catalogName = catalogName;
		return this;
	}

}