org.alfresco.repo.policy

Interface PolicyDefinition<P extends Policy>

Type Parameters:

P - the policy interface

@AlfrescoPublicApi
public interface PolicyDefinition<P extends Policy>

Definition of a Policy

Author:

David Caruana

Method Summary

Modifier and Type	Method and Description
Policy.Arg	getArgument(int index) Gets Policy Argument definition for the specified argument index
Policy.Arg[]	getArguments() Gets Policy Argument definitions for all arguments in order of arguments
org.alfresco.service.namespace.QName	getName() Gets the name of the Policy
Class<P>	getPolicyInterface() Gets the Policy interface class
PolicyType	getType() Gets the Policy type

Method Detail

getName

org.alfresco.service.namespace.QName getName()

Gets the name of the Policy

Returns:

policy name

getPolicyInterface

Class<P> getPolicyInterface()

Gets the Policy interface class

Returns:

the class

getType

PolicyType getType()

Gets the Policy type

Returns:

the policy type

getArgument

Policy.Arg getArgument(int index)

Gets Policy Argument definition for the specified argument index

Parameters:

index - argument index

Returns:

ARG.KEY or ARG.START_VALUE or ARG.END_VALUE

getArguments

Policy.Arg[] getArguments()

Gets Policy Argument definitions for all arguments in order of arguments

Returns:

Arg[]