com.sas.actionprovider
Class ActionAttributeDescriptor

com.sas.actionprovider.ActionAttributeDescriptor

All Implemented Interfaces:

SupplementalPropertyKeysInterface, AttributeDescriptorInterface, BaseAttributeDescriptorInterface, com.sas.RemoteObjectInterface, java.rmi.Remote

public class ActionAttributeDescriptor
implements AttributeDescriptorInterface, SupplementalPropertyKeysInterface

An implementation of the AttributeDescriptorInterface for the Action Provider Framework.

• For general information on the ActionProvider Framework, including an overview of how the primary classes of the framework work together, refer to the com.sas.actionprovider package documentation.

• For examples demonstrating how to use the ActionProvider Framework, including how to override default Actions or add new custom Actions, refer to the Samples Site.

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

Since:

3.1.4

See Also:

AttributeDescriptorInterface

Field Summary

protected java.util.Map

supplementalProperties

Fields inherited from interface com.sas.entities.AttributeDescriptorInterface

DEFAULTVALUESET, EXPERT, MODIFIABLE, PROPERTY, REQUIRED, VISIBLE

Fields inherited from interface com.sas.actionprovider.SupplementalPropertyKeysInterface

COMMAND, CUSTOM, DYNAMIC, ENCODE, EXTERNAL

Constructor Summary

ActionAttributeDescriptor()
Default constructor

ActionAttributeDescriptor(java.lang.String name)
Constructs an instance of AttributeDescriptor with the given name.

Method Summary

boolean	getCommand() Returns the boolean indicating whether the attribute should be applied to the command object during the execution phase.
boolean	getCustom() Returns the boolean indicating whether the ActionProvider Framework should determine the dynamic value of the Action attribute in a manner specific to the support class.
java.lang.String	getDescription(java.util.Locale locale) Return the description of this object; this is the description which the user will see in a UI (User Interface) component.
java.util.Map	getDescriptions() Returns a mapping of all of the descriptions defined for this object.
boolean	getDynamic() Returns the boolean indicating whether the ActionProvider Framework should attempt to set the attribute during the action acquisition phase.
boolean	getEncode() Returns the boolean indicating whether the ActionProvider Framework should attempt encode the value when passing as a request parameter.
boolean	getExternal() Returns the boolean indicating whether the ActionProvider Framework should prepend the attribute's value with the ActionProvider's parameterPrefix when passing as a request parameter.
java.lang.String	getLabel(java.util.Locale locale) Return the label of this object; this is the name which will the user will see in a UI (User Interface) component.
java.lang.String	getName() Return the name of this object.
boolean	isDefaultValueHasBeenSet() Return true if a default value has been set (through a AttributeDescriptorInterface.setDefault(Object defaultValue) call).
boolean	isVisible() Returns true if the AttributeDescriptor is visible.
void	setCommand(boolean command) Sets the boolean indicating whether the attribute should be applied to the command object during the execution phase.
void	setCustom(boolean custom) Sets the boolean indicating whether the ActionProvider Framework should determine the dynamic value of the Action attribute in a manner specific to the support class.
void	setDynamic(boolean dynamic) Sets the boolean indicating whether the ActionProvider Framework should attempt to set the attribute during the action acquisition phase.
void	setEncode(boolean encode) Sets the boolean indicating whether the ActionProvider Framework should attempt encode the value when passing as a request parameter.
void	setExpert(boolean expert) Sets the expert state.
void	setExternal(boolean external) Sets the boolean indicating whether the ActionProvider Framework should prepend the attribute's value with the ActionProvider's parameterPrefix when passing as a request parameter.
void	setLabel(java.util.Locale locale, java.lang.String label) Set the label of this object; this is the name which will the user will see in a UI (User Interface) component.
void	setModifiable(boolean modifiable) Sets whether the AttributeDescriptor is modifiable.
void	setName(java.lang.String name) Set the name of this object.
void	setVisible(boolean visible) Sets whether the AttributeDescriptor should be visible.

Field Detail

supplementalProperties

protected java.util.Map supplementalProperties

Constructor Detail

ActionAttributeDescriptor

public ActionAttributeDescriptor()

Default constructor

ActionAttributeDescriptor

public ActionAttributeDescriptor(java.lang.String name)

Constructs an instance of AttributeDescriptor with the given name.

Parameters:

name - name associated with the AttributeDescriptor

Method Detail

getDynamic

public boolean getDynamic()

Returns the boolean indicating whether the ActionProvider Framework should attempt to set the attribute during the action acquisition phase.

Returns:

the value of the dynamic attribute.

setDynamic

public void setDynamic(boolean dynamic)

Sets the boolean indicating whether the ActionProvider Framework should attempt to set the attribute during the action acquisition phase.

Parameters:

dynamic - the value of the dynamic attribute.

getCommand

public boolean getCommand()

Returns the boolean indicating whether the attribute should be applied to the command object during the execution phase.

Returns:

the value of the command attribute.

setCommand

public void setCommand(boolean command)

Sets the boolean indicating whether the attribute should be applied to the command object during the execution phase.

Parameters:

command - the value of the command attribute.

getCustom

public boolean getCustom()

Returns the boolean indicating whether the ActionProvider Framework should determine the dynamic value of the Action attribute in a manner specific to the support class.

Returns:

the value of the custom attribute.

setCustom

public void setCustom(boolean custom)

Sets the boolean indicating whether the ActionProvider Framework should determine the dynamic value of the Action attribute in a manner specific to the support class.

Parameters:

custom - the value of the custom attribute.

getEncode

public boolean getEncode()

Returns the boolean indicating whether the ActionProvider Framework should attempt encode the value when passing as a request parameter.

Returns:

the value of the encode attribute.

setEncode

public void setEncode(boolean encode)

Sets the boolean indicating whether the ActionProvider Framework should attempt encode the value when passing as a request parameter.

Parameters:

encode - the value of the encode attribute.

getExternal

public boolean getExternal()

Returns the boolean indicating whether the ActionProvider Framework should prepend the attribute's value with the ActionProvider's parameterPrefix when passing as a request parameter.

Returns:

the value of the external attribute.

setExternal

public void setExternal(boolean external)

Sets the boolean indicating whether the ActionProvider Framework should prepend the attribute's value with the ActionProvider's parameterPrefix when passing as a request parameter.

Parameters:

external - the value of the external attribute.

getName

public java.lang.String getName()

Description copied from interface: BaseAttributeDescriptorInterface

Return the name of this object. This is an identifier and is not locale sensitive.

Specified by:

getName in interface BaseAttributeDescriptorInterface

Returns:

object name

See Also:

BaseAttributeDescriptorInterface.setName(String name)

setName

public void setName(java.lang.String name)

Description copied from interface: BaseAttributeDescriptorInterface

Set the name of this object. This is an identifier and is not locale sensitive.

Specified by:

setName in interface BaseAttributeDescriptorInterface

Parameters:

name - object name

See Also:

BaseAttributeDescriptorInterface.getName()

getLabel

public java.lang.String getLabel(java.util.Locale locale)

Description copied from interface: BaseAttributeDescriptorInterface

Return the label of this object; this is the name which will the user will see in a UI (User Interface) component. It is a locale-sensitive string. If no label is associated with the locale, then the label associated with the null locale is returned. If that does not exist, the name is returned.

Specified by:

getLabel in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale with which the label is associated. This parameter may be null.

Returns:

object label

See Also:

BaseAttributeDescriptorInterface.setLabel(Locale locale, String label)

setLabel

public void setLabel(java.util.Locale locale,
                     java.lang.String label)

Description copied from interface: BaseAttributeDescriptorInterface

Set the label of this object; this is the name which will the user will see in a UI (User Interface) component. It is a locale-sensitive string.

Specified by:

setLabel in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale with which the label is associated. This parameter may be null.

label - the visible name

See Also:

BaseAttributeDescriptorInterface.getLabel(Locale locale)

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Description copied from interface: BaseAttributeDescriptorInterface

Return the description of this object; this is the description which the user will see in a UI (User Interface) component. It is a locale-sensitive string. If no description is associated with the locale, then the description associated with the null locale is returned. If that does not exist, the name is returned.

Specified by:

getDescription in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale with which this description is associated. This may be null.

Returns:

object description

See Also:

BaseAttributeDescriptorInterface.setDescription(Locale locale, String description)

getDescriptions

public java.util.Map getDescriptions()

Description copied from interface: BaseAttributeDescriptorInterface

Returns a mapping of all of the descriptions defined for this object. The first item of each entry is the locale and the second item is the description.

Specified by:

getDescriptions in interface BaseAttributeDescriptorInterface

Returns:

description map

isVisible

public boolean isVisible()

Description copied from interface: AttributeDescriptorInterface

Returns true if the AttributeDescriptor is visible. If false, UI (UserInterface) components should not display the AttributeDescriptor.

Specified by:

isVisible in interface AttributeDescriptorInterface

Returns:

true if visible, false otherwise

See Also:

AttributeDescriptorInterface.setVisible(boolean visible)

setVisible

public void setVisible(boolean visible)

Description copied from interface: AttributeDescriptorInterface

Sets whether the AttributeDescriptor should be visible.

Specified by:

setVisible in interface AttributeDescriptorInterface

Parameters:

visible - a boolean value. If false, the AttributeDescriptor should not be displayed in UI (User Interface) components.

See Also:

AttributeDescriptorInterface.isVisible()

setModifiable

public void setModifiable(boolean modifiable)

Description copied from interface: AttributeDescriptorInterface

Sets whether the AttributeDescriptor is modifiable.

Specified by:

setModifiable in interface AttributeDescriptorInterface

Parameters:

modifiable - a boolean value. If false, UI (User Interface) components can display the AttributeDescriptor but should not allow it to be modified.

See Also:

AttributeDescriptorInterface.isModifiable()

setExpert

public void setExpert(boolean expert)

Description copied from interface: AttributeDescriptorInterface

Sets the expert state.

Specified by:

setExpert in interface AttributeDescriptorInterface

Parameters:

expert - a boolean value. If true, under normal circumstances, UI (User Interface) components will not display the AttributeDescriptor.

See Also:

AttributeDescriptorInterface.isExpert()

isDefaultValueHasBeenSet

public boolean isDefaultValueHasBeenSet()

Description copied from interface: AttributeDescriptorInterface

Return true if a default value has been set (through a AttributeDescriptorInterface.setDefault(Object defaultValue) call).

Specified by:

isDefaultValueHasBeenSet in interface AttributeDescriptorInterface

Returns:

true if default value set; false otherwise

See Also:

AttributeDescriptorInterface.setDefaultValueHasBeenSet(boolean defaultValueHasBeenSet)