org.sakaiproject.entitybroker.entityprovider.annotations

Annotation Type EntityParameters

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface EntityParameters

This annotation indicates that this method is accepts or expects certain parameters to be present before it can be executed, these parameters are accessible in the params map
Any parameters included in this annotation can be documented using the i18n properties files by placing a message at: prefix.action.actionname.field.fieldname OR prefix.view.viewkey.field.fieldname
NOTE: there is no need to list the field names of the fields which are included in the entity class or map here, this is for additional parameters only

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

See Also:

EntityCustomAction, CustomAction, Createable, Updateable, Deleteable, Resolvable, CollectionResolvable

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	accepted Indicates the valid parameters for a custom action or standard entity method (e.g.
String[]	required Indicates the parameters that must be included for the method this is on to succeed this will stop the method from executing if any of these methods are not present and will generate an approriate failure which indicates that fields are missing and which ones By default this indicates no parameters are required Any parameter included here can be documented using the i18n properties files by placing a message at: prefix.action.actionname.field.fieldname OR prefix.view.viewkey.field.fieldname NOTE: there is no need to list the field names of the fields which are included in the entity class or map here, this is for additional parameters only

Element Detail

accepted

public abstract String[] accepted

Indicates the valid parameters for a custom action or standard entity method (e.g. Createable.createEntity(EntityReference, Object, Map)), this will not stop parameters from coming in which are not included here but it serves as an indicator of the ones which are expected and handled
By default this indicates no parameters are known
Any parameter included here can be documented using the i18n properties files by placing a message at: prefix.action.actionname.field.fieldname OR prefix.view.viewkey.field.fieldname
NOTE: there is no need to list the field names of the fields which are included in the entity class or map here, this is for additional parameters only

Returns:

an array of all handled parameters

Default:

{}

required

public abstract String[] required

Indicates the parameters that must be included for the method this is on to succeed
this will stop the method from executing if any of these methods are not present and will generate an approriate failure which indicates that fields are missing and which ones
By default this indicates no parameters are required
Any parameter included here can be documented using the i18n properties files by placing a message at: prefix.action.actionname.field.fieldname OR prefix.view.viewkey.field.fieldname
NOTE: there is no need to list the field names of the fields which are included in the entity class or map here, this is for additional parameters only

Returns:

an array of all required parameters

Default:

{}