oracle.webcenter.portal.persistence

Annotation Type PersistProperty

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

Used on the accessor of an accessor/mutator pair to identify properties of model interfaces (PortalEntitys) that need to be persisted.

In order to ensure consistency when properties are stored and retrieved, the combination of offset() and type() elements must be unique within each PortalEntity. Also, if new properties are added to an exisiting model interface, the @PeristProperty elements of exisiting properties must remain the same.

Note that there restrictions on the types of properties supported depending on the values of the type() element:

• When type() is set to PersistedDataType.STRING only the following data types are supported:
  • char
  • boolean
  • Character
  • Boolean
  • String
  • Any Enum
• When type() is set to PersistedDataType.NUMBER only the following data types are supported:
  • short
  • byte
  • int
  • long
  • boolean
  • Short
  • Byte
  • Integer
  • Long
  • Boolean
  • BigDecimal
• When type() is set to PersistedDataType.DATE only the following data types are supported:
  • Date
  • Calendar

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	offset The auxillary column number that the persistence manager will use to store the annotated property.
PersistedDataType	type The type of auxillary column that the persistence manager will use to store the annotated property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	export Flag to indicate whether the value of this property should be exported.

Element Detail

offset

public abstract int offset

The auxillary column number that the persistence manager will use to store the annotated property.

type

public abstract PersistedDataType type

The type of auxillary column that the persistence manager will use to store the annotated property.

export

public abstract boolean export

Flag to indicate whether the value of this property should be exported.

Default:

true