org.tentackle.pdo.DomainContextProvider Maven / Gradle / Ivy
/*
* Tentackle - https://tentackle.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.tentackle.pdo;
/**
* DomainContext provider.
*
* Provides access to a certain domain context.
*
* @author harald
*/
public interface DomainContextProvider {
/**
* Gets the domain context.
*
* @return the domain context
*/
DomainContext getDomainContext();
/**
* Creates a PDO for an entity type within the domain context of this object.
* The method is an acronym for "object new" and is provided as a shorter and better readable alternative to
* {@link Pdo#create(java.lang.Class, org.tentackle.pdo.DomainContext)}.
*
*
* Example:
*
* List<Invoice> invoices = on(Invoice.class).selectByCustomerId(customerId);
*
* is equivalent to
*
* List<Invoice> invoices = Pdo.create(Invoice.class, getDomainContext()).selectByCustomerId(customerId);
*
*
* @param the persistent domain object type
* @param clazz the PDO interface
* @return the created PDO
*/
default > T on(Class clazz) {
return PdoFactory.getInstance().create(clazz, getDomainContext());
}
/**
* Creates a PDO within a new named domain context.
* Same as {@link #on(Class)}, but uses a new sub context of the given name.
*
* @param the persistent domain object type
* @param clazz the PDO interface
* @param contextName the context name
* @return the created PDO
*/
default > T on(Class clazz, String contextName) {
return PdoFactory.getInstance().create(clazz, getDomainContext().clone(contextName));
}
/**
* Creates an operation within the domain context of this object.
* Same as {@link #on(Class)} but for operations.
*
* @param the operation type
* @param clazz the operation interface
* @return the created operation
*/
default > T op(Class clazz) {
return OperationFactory.getInstance().create(clazz, getDomainContext());
}
/**
* Creates an operation within a new domain context.
* Same as {@link #op(Class)}, but uses a new sub context of the given name.
*
* @param the operation type
* @param clazz the operation interface
* @param contextName the context name
* @return the created operation
*/
default > T op(Class clazz, String contextName) {
return OperationFactory.getInstance().create(clazz, getDomainContext().clone(contextName));
}
/**
* Determines whether the provided context belongs to an inheritance hierarchy that
* is created from a given context object.
*
* @param contextId the object ID of a context object, 0 = default context
* @param contextClassId the class id of the context object, 0 = default context
* @return true if within that context, false if context does not apply
* @see DomainContext#isWithinContext(long, int)
*/
default boolean isWithinContext(long contextId, int contextClassId) {
DomainContext context = getDomainContext();
return context != null && context.isWithinContext(contextId, contextClassId);
}
/**
* Checks whether the given name equals the name of this or one of its parent contexts.
*
* @param name the requested name
* @return true if within context, false if not
* @see DomainContext#isWithinContext(String)
*/
default boolean isWithinContext(String name) {
DomainContext context = getDomainContext();
return context != null && context.isWithinContext(name);
}
}