oracle.adf.controller.savepoint

Class SavePointAttributes

java.lang.Object

oracle.adf.controller.savepoint.SavePointAttributes

All Implemented Interfaces:

java.io.Serializable

public class SavePointAttributes
extends java.lang.Object
implements java.io.Serializable

Defines attributes used to describe a save point. The attributes include name, description, and any additional user attributes that must be serializable. The save point attributes will be persisted with the state manager along with a save point.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SavePointAttributes	EMPTY_SAVEPOINT_ATTRIBUTES Not updateable empty save point attributes.

Constructor Summary

Constructors

Constructor and Description
SavePointAttributes(java.lang.String name, java.lang.String description, java.util.Map<java.lang.String,java.io.Serializable> attrs) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.String	getName()
java.util.Map<java.lang.String,java.io.Serializable>	getUserAttributes()
void	setDescription(java.lang.String description) Set the description field.
void	setName(java.lang.String name) Set the name field.
void	setUserAttributes(java.util.Map<java.lang.String,java.io.Serializable> attrs)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_SAVEPOINT_ATTRIBUTES

public static final SavePointAttributes EMPTY_SAVEPOINT_ATTRIBUTES

Not updateable empty save point attributes. Name and description are null, and user attributes is an empty array.

Constructor Detail

SavePointAttributes

public SavePointAttributes(java.lang.String name,
                           java.lang.String description,
                           java.util.Map<java.lang.String,java.io.Serializable> attrs)

Constructor.

Parameters:

name - the name for the save point.

description - the escription for the save point.

attrs - a map of extra attributes for this save point keyed by attribute name. These attributes need to be serializable.

Method Detail

getName

public java.lang.String getName()

Returns:

the name attribute

setName

public void setName(java.lang.String name)

Set the name field.

Parameters:

name - the value of the name field to set to.

getDescription

public java.lang.String getDescription()

Returns:

the description attribute

setDescription

public void setDescription(java.lang.String description)

Set the description field.

Parameters:

description - the value of the description field to set to.

getUserAttributes

public java.util.Map<java.lang.String,java.io.Serializable> getUserAttributes()

Returns:

the custom user attributes, keyed by attribute name

setUserAttributes

public void setUserAttributes(java.util.Map<java.lang.String,java.io.Serializable> attrs)

Parameters:

attrs - the custom user attributes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object