be.SIRAPRISE.client.jsba

Annotation Type GetterMethod

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface GetterMethod

The GetterMethod annotation documents the name of, type of, escaping requirement for the value of, and relvarname for the attribute corresponding to a getter/setter method.
The annotation elements are all arrays, the elements of which define the way how the annotated getter method fits in the JSBA to provide attribute values for database assignment commands.
The GetterMethod annotation is inspected when using JSBA objects for updating the database, that is, when building the database update command objects that reflect an INSERT, DELETE or UPDATE request corresponding to the annotated JSBA object.
The annotation type is experimental and currently unused.

Author:

Erwin

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
AttributeDef[]	attributeDefs Gets The annotation-form defs of the attribute in the respective relvar(s) named in this annotation. The length this array must be equal to the length of the array of Relvar names, with the sole exception for the case when the attribute name is the same for all relvars (in which case this array is allowed to have only one element).
java.lang.String[]	relvarNames Gets The names of the corresponding relvar(s) for which this getter method is to be used by the jsba, when constructing assignment commands for a DBObject [of a class in which the annotation appears].

Element Detail

relvarNames

public abstract java.lang.String[] relvarNames

Gets The names of the corresponding relvar(s) for which this getter method is to be used by the jsba, when constructing assignment commands for a DBObject [of a class in which the annotation appears]. The set of Relvar names mentioned in a JSBAGetterMethod annotation, must be a subset of the set of Relvar names mentioned in the class-level ForRelvars annotation of the DBObject's class.

Returns:

The names of the corresponding relvar(s) for which this getter method is to be used by the jsba, when constructing assignment commands for a DBObject [of a class in which the annotation appears]. The set of Relvar names mentioned in a JSBAGetterMethod annotation, must be a subset of the set of Relvar names mentioned in the class-level ForRelvars annotation of the DBObject's class.

attributeDefs

public abstract AttributeDef[] attributeDefs

Gets The annotation-form defs of the attribute in the respective relvar(s) named in this annotation.
The length this array must be equal to the length of the array of Relvar names, with the sole exception for the case when the attribute name is the same for all relvars (in which case this array is allowed to have only one element).

Returns:

The annotation-form defs of the attribute in the respective relvar(s) named in this annotation