com.liferay.apio.architect.annotation.ParentId Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of release.portal.api Show documentation

POM was created by Sonatype Nexus

There is a newer version: 7.4.3.112-ga112

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * 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.
 */

package com.liferay.apio.architect.annotation;

import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import com.liferay.apio.architect.identifier.Identifier;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Provides information about a parent type ID.
 *
 * 
 * This annotation should always be used on an {@link
 * com.liferay.apio.architect.router.ActionRouter} method parameter representing
 * an parent resource ID.
 * 
 *
 * 
 * A {@link com.liferay.apio.architect.uri.mapper.PathIdentifierMapper} for the
 * ID type must exist in order for Apio to be able to auto convert it from the
 * request.
 * 
 *
 * @author Alejandro Hernández
 * @review
 */
@Retention(RUNTIME)
@Target(PARAMETER)
public @interface ParentId {

	/**
	 * Returns the class of the parent resource.
	 *
	 * @return the class of the parent resource
	 * @review
	 */
	public Class> value();

}