de.alpharogroup.service.domain.DomainService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domain-api Show documentation

There is a newer version: 5.0.0

package de.alpharogroup.service.domain;

import java.io.Serializable;

import de.alpharogroup.domain.DomainObject;

/**
 * The Interface {@link DomainService} provide methods for crud processes.
 *
 * @param 
 *            the generic type of the primary key
 * @param 
 *            the generic type of the domain object
 */
public interface DomainService> {

	/**
	 * Creates an entity from the given domain object and persist it to the underlying database.
	 *
	 * @param domainObject
	 *            the domain object
	 * @return the domain object with the id from the entity.
	 */
	DO create(DO domainObject);

	/**
	 * Deletes an entity with the given id.
	 *
	 * @param id
	 *            the id
	 */
	void delete(PK id);

	/**
	 * Read an entity with the given id and maps it to a domain object that will be returned.
	 *
	 * @param id
	 *            the id
	 * @return the domain object
	 */
	DO read(PK id);

	/**
	 * Updates the given domain object to the underlying database.
	 *
	 * @param domainObject
	 *            the domain object
	 */
	void update(DO domainObject);

}