org.usergrid.persistence.Entity Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of usergrid-core Show documentation
Core services for Usergrid system.
There is a newer version: 0.0.27.1
/*******************************************************************************
 * Copyright 2012 Apigee Corporation
 * 
 * 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.usergrid.persistence;

import static org.usergrid.persistence.Schema.PROPERTY_UUID;
import static org.usergrid.persistence.Schema.PROPERTY_NAME;
import static org.usergrid.persistence.Schema.PROPERTY_TYPE;
import static org.usergrid.persistence.Schema.PROPERTY_URI;

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

import javax.xml.bind.annotation.XmlRootElement;

import org.codehaus.jackson.annotate.JsonAnyGetter;
import org.codehaus.jackson.annotate.JsonAnySetter;
import org.codehaus.jackson.annotate.JsonIgnore;
import org.codehaus.jackson.annotate.JsonPropertyOrder;
import org.usergrid.persistence.annotations.EntityProperty;

/**
 * Entities are the base object type in the service.
 */
@XmlRootElement
@JsonPropertyOrder({ PROPERTY_UUID, PROPERTY_TYPE, PROPERTY_URI, PROPERTY_NAME })
public interface Entity extends EntityRef, Comparable {

	@Override
	@EntityProperty(required = true, mutable = false, basic = true, indexed = false)
	public UUID getUuid();

	public void setUuid(UUID id);

	@Override
	@EntityProperty(required = true, mutable = false, basic = true, indexed = true)
	public String getType();

	public void setType(String type);

	public abstract String getName();

	@EntityProperty(indexed = true, required = true, mutable = false)
	public abstract Long getCreated();

	public abstract void setCreated(Long created);

	@EntityProperty(indexed = true, required = true, mutable = true)
	public abstract Long getModified();

	public abstract void setModified(Long modified);

	@JsonIgnore
	public Map getProperties();

	public void setProperties(Map properties);

	public void addProperties(Map properties);

	public abstract Object getProperty(String propertyName);

	public abstract void setProperty(String propertyName, Object propertyValue);

	@Override
	public abstract int compareTo(Entity o);

	public abstract Entity toTypedEntity();

	public abstract Object getMetadata(String key);

	public abstract void setMetadata(String key, Object value);

	public abstract void mergeMetadata(Map metadata);

	public abstract void clearMetadata();

	public abstract List getCollections(String key);

	public abstract void setCollections(String name, List results);

	public abstract List getConnections(String key);

	public abstract void setConnections(String name, List results);

	@JsonAnySetter
	public abstract void setDynamicProperty(String key, Object value);

	@JsonAnyGetter
	public abstract Map getDynamicProperties();
}