Package org.forgerock.api.annotations
Annotation Type PropertyPolicies
- 
@Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface PropertyPolicies
An annotation to declare the policies for property access in the CREST API Descriptor schema elements. 
- 
- 
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description booleanerrorOnWritePolicyFailureWhether breaking the declared policy will result in an error from the service.ReadPolicyreadThe read policy for the property.booleanreturnOnDemandtruewhen a field is available, but must be explicitly requested, orfalse(default) when always returned.WritePolicywriteThe write policy for the property. 
 - 
 
- 
- 
Element Detail
- 
write
WritePolicy write
The write policy for the property. Defaults toWRITABLE.- Default:
 - org.forgerock.api.enums.WritePolicy.WRITABLE
 
 
 - 
 
- 
- 
read
ReadPolicy read
The read policy for the property. Defaults toUSER.- Default:
 - org.forgerock.api.enums.ReadPolicy.USER
 
 
 - 
 
- 
- 
errorOnWritePolicyFailure
boolean errorOnWritePolicyFailure
Whether breaking the declared policy will result in an error from the service. Only required whenwrite()is not set toWRITABLE. Defaults tofalse.- Default:
 - false
 
 
 - 
 
 -