com.bowstreet.webapp
Interface WebAppObject

All Superinterfaces:

IExemplar

All Known Subinterfaces:

ActionList, ClassInfo, ConfigInfo, DataService, LinkedModel, Method, Page, Schema, Variable

public interface WebAppObject
extends IExemplar

Base class for primary WebApp objects (Page, Method, ActionList, Variable, LinkedModel).

Field Summary

static int	ALWAYS_VISIBLE Used for visibility to set the visibility level
static java.lang.String	INFORMATION_PROPERTY Name of property for informational display, e.g. how a builder uses this object
static int	NEVER_VISIBLE
static int	SOMETIMES_VISIBLE

Method Summary

java.lang.Object	clone() Clone an instance of this object.
BuilderCall	getBuilderCall() Which builder call generated this object - may be null
java.lang.String	getName() Gets unique identifier name for this object.
java.util.Iterator	getProperties() Gets an iterator to the keys of the properties.
java.lang.Object	getProperty(java.lang.String key) Gets a property value given the key.
int	getVisibility() Get "visibility" info.
boolean	isHidden() Get "hidden" flag.
void	putProperty(java.lang.String key, java.lang.Object value) Sets the specified property value with the associated key.
void	setBuilderCall(BuilderCall call)
void	setHidden(boolean set) Set "hidden" flag.
void	setName(java.lang.String name) Sets the identifier name for this object.
void	setVisibility(int set) Set "visibility" level.

Methods inherited from interface com.bowstreet.util.IExemplar

newInstance

Field Detail

ALWAYS_VISIBLE

static final int ALWAYS_VISIBLE

Used for visibility to set the visibility level

See Also:

Constant Field Values

INFORMATION_PROPERTY

static final java.lang.String INFORMATION_PROPERTY

Name of property for informational display, e.g. how a builder uses this object

See Also:

Constant Field Values

NEVER_VISIBLE

static final int NEVER_VISIBLE

See Also:

Constant Field Values

SOMETIMES_VISIBLE

static final int SOMETIMES_VISIBLE

See Also:

Constant Field Values

Method Detail

clone

java.lang.Object clone()

Clone an instance of this object.

Returns:

The cloned object.

getBuilderCall

BuilderCall getBuilderCall()

Which builder call generated this object - may be null

Returns:

BuilderCall, may be null

getName

java.lang.String getName()

Gets unique identifier name for this object.

Returns:

The unique identifier name for this object.

getProperties

java.util.Iterator getProperties()

Gets an iterator to the keys of the properties.

Returns:

Iterator of property keys.

getProperty

java.lang.Object getProperty(java.lang.String key)

Gets a property value given the key.

Parameters:

key - The key to get the value for.

Returns:

The value of the specified property, or null if not found.

getVisibility

int getVisibility()

Get "visibility" info.

Returns:

int for level of visibility a value between ALWAYS_VISIBLE and NEVER_VISIBLE (10 - 0) or SOMETIMES_VISIBLE 5(in Designer).

isHidden

boolean isHidden()

Get "hidden" flag. Hidden attribute on WebAppObject

Returns:

True if hidden (in Designer).

putProperty

void putProperty(java.lang.String key,
                 java.lang.Object value)

Sets the specified property value with the associated key.

Parameters:

key - The key to associate the value to.

value - The value for the specified key. If the value is null the specified key will be removed from the properties.

setBuilderCall

void setBuilderCall(BuilderCall call)

Parameters:

call - The BuilderCall that created this element

setHidden

void setHidden(boolean set)

Set "hidden" flag. Hidden attribute on WebAppObject

Parameters:

set - True if hidden (in Designer).

setName

void setName(java.lang.String name)

Sets the identifier name for this object.

Parameters:

name - The identifier name for this object.

setVisibility

void setVisibility(int set)

Set "visibility" level.

Parameters:

set - a value between ALWAYS_VISIBLE and NEVER_VISIBLE (10 - 0) or SOMETIMES_VISIBLE to only sometime be seen in chooser dialog(in Designer).