Interface com.symantec.itools.vcafe.openapi.Attributes

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.symantec.itools.vcafe.openapi.Attributes

public interface Attributes

An api that stores named arbitrary data in either a VisualProject or global to the Visual Cafe environment. The data can be persistent between sessions, or temporary.

Version:: 1.0
Author:: Symantec Internet Tools Division
Since:: VCafe 3.0
See Also:: getAttributes, getAttributes

attributeNames(): Gets an enumeration used to cycle through the names of all attributes.
attributeNames(Class): Gets an enumeration used to cycle through the names of all attributes that belong to the specified owner.
getPersistentAttributeValue(Class, String): Retrieve a named attribute from the list of persistent attributes.
getSessionAttributeValue(Class, String): Retrieve the value of a session-duration attribute.
isAttributePersistent(Class, String): Determine if an attribute is persistent.
setPersistentAttributeValue(Class, String, Serializable): Sets the value of a persistent attribute.
setSessionAttributeValue(Class, String, Object): Sets the value of a session-duration attribute.

attributeNames

public abstract java.util.Enumeration attributeNames()

Gets an enumeration used to cycle through the names of all attributes. The names are returned as String objects, formatted as owner.getName() + "#" + attributeName. If a session attribute was set without an owner, the attributeName is returned.

Returns:: An enumeration of the locale-independent names of all attributes that have been registered.
See Also:: setSessionAttributeValue, setPersistentAttributeValue

attributeNames

public abstract java.util.Enumeration attributeNames(Class owner)

Gets an enumeration used to cycle through the names of all attributes that belong to the specified owner. The names are returned as String objects set to the attributeName.

Parameters:: owner - The Class that was specified when the attribute value was set.
Returns:: An enumeration of the locale-independent names of all attributes that have been registered with the given owner.
See Also:: setSessionAttributeValue, setPersistentAttributeValue

getPersistentAttributeValue

public abstract java.lang.Object getPersistentAttributeValue(Class owner,
                                                             String attributeName) throws InvalidPersistentAttributeException

Retrieve a named attribute from the list of persistent attributes.

Parameters:: owner - The class that conceptually owns this attribute/value (cannot be null).; attributeName - The locale-independent name of the attribute
Returns:: The value of the attribute, or null if the attribute is unknown.
Throws: InvalidPersistentAttributeException: If the value can't be properly streamed in or out.
See Also:: setPersistentAttributeValue, getSessionAttributeValue

getSessionAttributeValue

public abstract java.lang.Object getSessionAttributeValue(Class owner,
                                                          String attributeName)

Retrieve the value of a session-duration attribute.

Parameters:: owner - The Class that conceptually owns this attribute/value (can be null).; attributeName - The locale-independent name of the attribute.
Returns:: The value of the attribute, or null if the attribute is unknown.
See Also:: setSessionAttributeValue, getPersistentAttributeValue

isAttributePersistent

public abstract boolean isAttributePersistent(Class owner,
                                              String attributeName)

Determine if an attribute is persistent.

Parameters:: owner - The class that conceptually owns the attribute/value.; attributeName - The locale-independent name of the attribute.
Returns:: true if the attribute is persistent, false otherwise.

setPersistentAttributeValue

public abstract void setPersistentAttributeValue(Class owner,
                                                 String attributeName,
                                                 Serializable value) throws InvalidPersistentAttributeException

Sets the value of a persistent attribute. Once a value has been set, the Object's data cannot be changed without being re-set. The attribute/value is saved and restored between sessions.

Parameters:: owner - The Class that conceptually owns this attribute/value (cannot be null).; attributeName - The locale-independent name of the attribute.; value - The value.
Throws: InvalidPersistentAttributeException: If the value can't be properly streamed in or out.
See Also:: getPersistentAttributeValue, setSessionAttributeValue

setSessionAttributeValue

public abstract void setSessionAttributeValue(Class owner,
                                              String attributeName,
                                              Object value)

Sets the value of a session-duration attribute. Once a value has been set, the Object's data cannot be changed without being re-set. The attribute/value persists only for the duration of the session.

Parameters:: owner - The Class that conceptually owns this attribute/value (can be null).; attributeName - The locale-independent name of the attribute.; value - The value.
See Also:: getSessionAttributeValue, setPersistentAttributeValue

All Packages  Class Hierarchy  This Package  Previous  Next  Index