com.novell.db.object.bean
Class ItemBean

java.lang.Object
  com.novell.sentinel.client.bean.SentinelBean
      com.novell.db.object.bean.ItemBean

public class ItemBean
extends SentinelBean

An automatically-generated "bean" class for the Sentinel data object type 'menu-item'.

The description of the type is:

"Object representing a configured event action."

The Sentinel data object bean classes are designed to be used to transport data to and from the Sentinel server. There exists a supporting infrastructure that handles the serialization/parsing of the data to/from the JSON transport format and which handles the actual HTTP transport.

A more complete description of Sentinel data object beans is found in the description of SentinelBean.

See Also:

SentinelBean, BeanTransporter

Field Summary

static String	ACTION The "bean name" of the Sentinel data object field 'action'.
static String	COMMAND The "bean name" of the Sentinel data object field 'command'.
static String	DESCRIPTION The "bean name" of the Sentinel data object field 'description'.
static String	ENABLED The "bean name" of the Sentinel data object field 'enabled'.
static String	FILETYPE The "bean name" of the Sentinel data object field 'filetype'.
static String	NAME The "bean name" of the Sentinel data object field 'name'.
static String	PARAMETERS The "bean name" of the Sentinel data object field 'parameters'.
static String	PERMISSION The "bean name" of the Sentinel data object field 'permission'.
static String	USEBROWSER The "bean name" of the Sentinel data object field 'usebrowser'.

Constructor Summary

	ItemBean() Construct an instance of the bean class.
protected	ItemBean(BeanMetaData<? extends SentinelBean> metadata) Constructor for use by derived classes.

Method Summary

void	clearAction() Clear any current value for the 'action' field in the bean.
void	clearCommand() Clear any current value for the 'command' field in the bean.
void	clearDescription() Clear any current value for the 'description' field in the bean.
void	clearEnabled() Clear any current value for the 'enabled' field in the bean.
void	clearFiletype() Clear any current value for the 'file-type' field in the bean.
void	clearName() Clear any current value for the 'name' field in the bean.
void	clearParameters() Clear any current value for the 'parameters' field in the bean.
void	clearPermission() Clear any current value for the 'permission' field in the bean.
void	clearUsebrowser() Clear any current value for the 'use-browser' field in the bean.
ItemBean	clone() Create a duplicate of this bean instance, including all field values.
String	getAction() Get the value for the 'action' field.
static BeanMetaData<? extends ItemBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getCommand() Get the value for the 'command' field.
String	getDescription() Get the value for the 'description' field.
String	getEnabled() Get the value for the 'enabled' field.
String	getFiletype() Get the value for the 'file-type' field.
String	getName() Get the value for the 'name' field.
String	getParameters() Get the value for the 'parameters' field.
String	getPermission() Get the value for the 'permission' field.
String	getUsebrowser() Get the value for the 'use-browser' field.
boolean	isActionClear() Get whether the value for the 'action' field is clear or not.
boolean	isActionNull() Get whether the 'action' field has been set to Null or not.
boolean	isCommandClear() Get whether the value for the 'command' field is clear or not.
boolean	isCommandNull() Get whether the 'command' field has been set to Null or not.
boolean	isDescriptionClear() Get whether the value for the 'description' field is clear or not.
boolean	isDescriptionNull() Get whether the 'description' field has been set to Null or not.
boolean	isEnabledClear() Get whether the value for the 'enabled' field is clear or not.
boolean	isEnabledNull() Get whether the 'enabled' field has been set to Null or not.
boolean	isFiletypeClear() Get whether the value for the 'file-type' field is clear or not.
boolean	isFiletypeNull() Get whether the 'file-type' field has been set to Null or not.
boolean	isNameClear() Get whether the value for the 'name' field is clear or not.
boolean	isNameNull() Get whether the 'name' field has been set to Null or not.
boolean	isParametersClear() Get whether the value for the 'parameters' field is clear or not.
boolean	isParametersNull() Get whether the 'parameters' field has been set to Null or not.
boolean	isPermissionClear() Get whether the value for the 'permission' field is clear or not.
boolean	isPermissionNull() Get whether the 'permission' field has been set to Null or not.
boolean	isUsebrowserClear() Get whether the value for the 'use-browser' field is clear or not.
boolean	isUsebrowserNull() Get whether the 'use-browser' field has been set to Null or not.
void	setAction(String action) Set the value for the 'action' field.
void	setActionNull() Set to Null any current value for the 'action' field in the bean.
void	setCommand(String command) Set the value for the 'command' field.
void	setCommandNull() Set to Null any current value for the 'command' field in the bean.
void	setDescription(String description) Set the value for the 'description' field.
void	setDescriptionNull() Set to Null any current value for the 'description' field in the bean.
void	setEnabled(String enabled) Set the value for the 'enabled' field.
void	setEnabledNull() Set to Null any current value for the 'enabled' field in the bean.
void	setFiletype(String filetype) Set the value for the 'file-type' field.
void	setFiletypeNull() Set to Null any current value for the 'file-type' field in the bean.
void	setName(String name) Set the value for the 'name' field.
void	setNameNull() Set to Null any current value for the 'name' field in the bean.
void	setParameters(String parameters) Set the value for the 'parameters' field.
void	setParametersNull() Set to Null any current value for the 'parameters' field in the bean.
void	setPermission(String permission) Set the value for the 'permission' field.
void	setPermissionNull() Set to Null any current value for the 'permission' field in the bean.
void	setUsebrowser(String usebrowser) Set the value for the 'use-browser' field.
void	setUsebrowserNull() Set to Null any current value for the 'use-browser' field in the bean.

Methods inherited from class com.novell.sentinel.client.bean.SentinelBean

clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ENABLED

public static final String ENABLED

The "bean name" of the Sentinel data object field 'enabled'. The value is ""enabled"".

The description of the 'enabled' field is:

"Flag indicating if action is enabled(1) or disabled(0)."

See Also:

Constant Field Values

NAME

public static final String NAME

The "bean name" of the Sentinel data object field 'name'. The value is ""name"".

The description of the 'name' field is:

"The name or title of the event action."

See Also:

Constant Field Values

PERMISSION

public static final String PERMISSION

The "bean name" of the Sentinel data object field 'permission'. The value is ""permission"".

The description of the 'permission' field is:

"Reserved for future use."

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

The "bean name" of the Sentinel data object field 'description'. The value is ""description"".

The description of the 'description' field is:

"The description of the event action."

See Also:

Constant Field Values

PARAMETERS

public static final String PARAMETERS

The "bean name" of the Sentinel data object field 'parameters'. The value is ""parameters"".

The description of the 'parameters' field is:

"Parameters to pass to the action or command."

See Also:

Constant Field Values

FILETYPE

public static final String FILETYPE

The "bean name" of the Sentinel data object field 'filetype'. The value is ""file-type"".

The description of the 'file-type' field is:

"The type of content generated by executing the action; such as txt, html or xml."

See Also:

Constant Field Values

ACTION

public static final String ACTION

The "bean name" of the Sentinel data object field 'action'. The value is ""action"".

The description of the 'action' field is:

"The ID of the action to execute."

See Also:

Constant Field Values

COMMAND

public static final String COMMAND

The "bean name" of the Sentinel data object field 'command'. The value is ""command"".

The description of the 'command' field is:

"The system command to execute."

See Also:

Constant Field Values

USEBROWSER

public static final String USEBROWSER

The "bean name" of the Sentinel data object field 'usebrowser'. The value is ""use-browser"".

The description of the 'use-browser' field is:

"Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false)."

See Also:

Constant Field Values

Constructor Detail

ItemBean

public ItemBean()

Construct an instance of the bean class.

ItemBean

protected ItemBean(BeanMetaData<? extends SentinelBean> metadata)

Constructor for use by derived classes.

Parameters:

metadata - The metadata instance for the derived bean class. Normally this constructor will only be called by generated code.

Method Detail

getEnabled

public String getEnabled()

Get the value for the 'enabled' field. The description of the 'enabled' field is:

"Flag indicating if action is enabled(1) or disabled(0)."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

ENABLED

isEnabledNull

public boolean isEnabledNull()

Get whether the 'enabled' field has been set to Null or not. The description of the 'enabled' field is:

"Flag indicating if action is enabled(1) or disabled(0)."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setEnabledNull(), ENABLED

isEnabledClear

public boolean isEnabledClear()

Get whether the value for the 'enabled' field is clear or not. The description of the 'enabled' field is:

"Flag indicating if action is enabled(1) or disabled(0)."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearEnabled(), ENABLED

setEnabled

public void setEnabled(String enabled)

Set the value for the 'enabled' field. The description of the 'enabled' field is:

"Flag indicating if action is enabled(1) or disabled(0)."

Parameters:

enabled - Value to set

See Also:

ENABLED

clearEnabled

public void clearEnabled()

Clear any current value for the 'enabled' field in the bean. The description of the 'enabled' field is:

"Flag indicating if action is enabled(1) or disabled(0)."

Using this method will not clear the server value when the bean is PUT to the server. Use the setEnabledNull() method to clear the server's value.

See the description of cleared values.

See Also:

ENABLED

setEnabledNull

public void setEnabledNull()

Set to Null any current value for the 'enabled' field in the bean. The description of the 'enabled' field is:

"Flag indicating if action is enabled(1) or disabled(0)."

Using this method will clear the server value when the bean is PUT to the server. Use the clearEnabled() method to avoid clearing the server's value.

See the description of Null values.

See Also:

ENABLED

getUsebrowser

public String getUsebrowser()

Get the value for the 'use-browser' field. The description of the 'use-browser' field is:

"Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false)."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

USEBROWSER

isUsebrowserNull

public boolean isUsebrowserNull()

Get whether the 'use-browser' field has been set to Null or not. The description of the 'use-browser' field is:

"Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false)."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setUsebrowserNull(), USEBROWSER

isUsebrowserClear

public boolean isUsebrowserClear()

Get whether the value for the 'use-browser' field is clear or not. The description of the 'use-browser' field is:

"Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false)."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearUsebrowser(), USEBROWSER

setUsebrowser

public void setUsebrowser(String usebrowser)

Set the value for the 'use-browser' field. The description of the 'use-browser' field is:

"Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false)."

Parameters:

usebrowser - Value to set

See Also:

USEBROWSER

clearUsebrowser

public void clearUsebrowser()

Clear any current value for the 'use-browser' field in the bean. The description of the 'use-browser' field is:

"Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false)."

Using this method will not clear the server value when the bean is PUT to the server. Use the setUsebrowserNull() method to clear the server's value.

See the description of cleared values.

See Also:

USEBROWSER

setUsebrowserNull

public void setUsebrowserNull()

Set to Null any current value for the 'use-browser' field in the bean. The description of the 'use-browser' field is:

"Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false)."

Using this method will clear the server value when the bean is PUT to the server. Use the clearUsebrowser() method to avoid clearing the server's value.

See the description of Null values.

See Also:

USEBROWSER

getDescription

public String getDescription()

Get the value for the 'description' field. The description of the 'description' field is:

"The description of the event action."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

DESCRIPTION

isDescriptionNull

public boolean isDescriptionNull()

Get whether the 'description' field has been set to Null or not. The description of the 'description' field is:

"The description of the event action."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setDescriptionNull(), DESCRIPTION

isDescriptionClear

public boolean isDescriptionClear()

Get whether the value for the 'description' field is clear or not. The description of the 'description' field is:

"The description of the event action."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearDescription(), DESCRIPTION

setDescription

public void setDescription(String description)

Set the value for the 'description' field. The description of the 'description' field is:

"The description of the event action."

Parameters:

description - Value to set

See Also:

DESCRIPTION

clearDescription

public void clearDescription()

Clear any current value for the 'description' field in the bean. The description of the 'description' field is:

"The description of the event action."

Using this method will not clear the server value when the bean is PUT to the server. Use the setDescriptionNull() method to clear the server's value.

See the description of cleared values.

See Also:

DESCRIPTION

setDescriptionNull

public void setDescriptionNull()

Set to Null any current value for the 'description' field in the bean. The description of the 'description' field is:

"The description of the event action."

Using this method will clear the server value when the bean is PUT to the server. Use the clearDescription() method to avoid clearing the server's value.

See the description of Null values.

See Also:

DESCRIPTION

getName

public String getName()

Get the value for the 'name' field. The description of the 'name' field is:

"The name or title of the event action."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

NAME

isNameNull

public boolean isNameNull()

Get whether the 'name' field has been set to Null or not. The description of the 'name' field is:

"The name or title of the event action."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setNameNull(), NAME

isNameClear

public boolean isNameClear()

Get whether the value for the 'name' field is clear or not. The description of the 'name' field is:

"The name or title of the event action."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearName(), NAME

setName

public void setName(String name)

Set the value for the 'name' field. The description of the 'name' field is:

"The name or title of the event action."

Parameters:

name - Value to set

See Also:

NAME

clearName

public void clearName()

Clear any current value for the 'name' field in the bean. The description of the 'name' field is:

"The name or title of the event action."

Using this method will not clear the server value when the bean is PUT to the server. Use the setNameNull() method to clear the server's value.

See the description of cleared values.

See Also:

NAME

setNameNull

public void setNameNull()

Set to Null any current value for the 'name' field in the bean. The description of the 'name' field is:

"The name or title of the event action."

Using this method will clear the server value when the bean is PUT to the server. Use the clearName() method to avoid clearing the server's value.

See the description of Null values.

See Also:

NAME

getCommand

public String getCommand()

Get the value for the 'command' field. The description of the 'command' field is:

"The system command to execute."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

COMMAND

isCommandNull

public boolean isCommandNull()

Get whether the 'command' field has been set to Null or not. The description of the 'command' field is:

"The system command to execute."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setCommandNull(), COMMAND

isCommandClear

public boolean isCommandClear()

Get whether the value for the 'command' field is clear or not. The description of the 'command' field is:

"The system command to execute."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearCommand(), COMMAND

setCommand

public void setCommand(String command)

Set the value for the 'command' field. The description of the 'command' field is:

"The system command to execute."

Parameters:

command - Value to set

See Also:

COMMAND

clearCommand

public void clearCommand()

Clear any current value for the 'command' field in the bean. The description of the 'command' field is:

"The system command to execute."

Using this method will not clear the server value when the bean is PUT to the server. Use the setCommandNull() method to clear the server's value.

See the description of cleared values.

See Also:

COMMAND

setCommandNull

public void setCommandNull()

Set to Null any current value for the 'command' field in the bean. The description of the 'command' field is:

"The system command to execute."

Using this method will clear the server value when the bean is PUT to the server. Use the clearCommand() method to avoid clearing the server's value.

See the description of Null values.

See Also:

COMMAND

getAction

public String getAction()

Get the value for the 'action' field. The description of the 'action' field is:

"The ID of the action to execute."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

ACTION

isActionNull

public boolean isActionNull()

Get whether the 'action' field has been set to Null or not. The description of the 'action' field is:

"The ID of the action to execute."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setActionNull(), ACTION

isActionClear

public boolean isActionClear()

Get whether the value for the 'action' field is clear or not. The description of the 'action' field is:

"The ID of the action to execute."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearAction(), ACTION

setAction

public void setAction(String action)

Set the value for the 'action' field. The description of the 'action' field is:

"The ID of the action to execute."

Parameters:

action - Value to set

See Also:

ACTION

clearAction

public void clearAction()

Clear any current value for the 'action' field in the bean. The description of the 'action' field is:

"The ID of the action to execute."

Using this method will not clear the server value when the bean is PUT to the server. Use the setActionNull() method to clear the server's value.

See the description of cleared values.

See Also:

ACTION

setActionNull

public void setActionNull()

Set to Null any current value for the 'action' field in the bean. The description of the 'action' field is:

"The ID of the action to execute."

Using this method will clear the server value when the bean is PUT to the server. Use the clearAction() method to avoid clearing the server's value.

See the description of Null values.

See Also:

ACTION

getPermission

public String getPermission()

Get the value for the 'permission' field. The description of the 'permission' field is:

"Reserved for future use."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

PERMISSION

isPermissionNull

public boolean isPermissionNull()

Get whether the 'permission' field has been set to Null or not. The description of the 'permission' field is:

"Reserved for future use."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setPermissionNull(), PERMISSION

isPermissionClear

public boolean isPermissionClear()

Get whether the value for the 'permission' field is clear or not. The description of the 'permission' field is:

"Reserved for future use."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearPermission(), PERMISSION

setPermission

public void setPermission(String permission)

Set the value for the 'permission' field. The description of the 'permission' field is:

"Reserved for future use."

Parameters:

permission - Value to set

See Also:

PERMISSION

clearPermission

public void clearPermission()

Clear any current value for the 'permission' field in the bean. The description of the 'permission' field is:

"Reserved for future use."

Using this method will not clear the server value when the bean is PUT to the server. Use the setPermissionNull() method to clear the server's value.

See the description of cleared values.

See Also:

PERMISSION

setPermissionNull

public void setPermissionNull()

Set to Null any current value for the 'permission' field in the bean. The description of the 'permission' field is:

"Reserved for future use."

Using this method will clear the server value when the bean is PUT to the server. Use the clearPermission() method to avoid clearing the server's value.

See the description of Null values.

See Also:

PERMISSION

getParameters

public String getParameters()

Get the value for the 'parameters' field. The description of the 'parameters' field is:

"Parameters to pass to the action or command."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

PARAMETERS

isParametersNull

public boolean isParametersNull()

Get whether the 'parameters' field has been set to Null or not. The description of the 'parameters' field is:

"Parameters to pass to the action or command."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setParametersNull(), PARAMETERS

isParametersClear

public boolean isParametersClear()

Get whether the value for the 'parameters' field is clear or not. The description of the 'parameters' field is:

"Parameters to pass to the action or command."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearParameters(), PARAMETERS

setParameters

public void setParameters(String parameters)

Set the value for the 'parameters' field. The description of the 'parameters' field is:

"Parameters to pass to the action or command."

Parameters:

parameters - Value to set

See Also:

PARAMETERS

clearParameters

public void clearParameters()

Clear any current value for the 'parameters' field in the bean. The description of the 'parameters' field is:

"Parameters to pass to the action or command."

Using this method will not clear the server value when the bean is PUT to the server. Use the setParametersNull() method to clear the server's value.

See the description of cleared values.

See Also:

PARAMETERS

setParametersNull

public void setParametersNull()

Set to Null any current value for the 'parameters' field in the bean. The description of the 'parameters' field is:

"Parameters to pass to the action or command."

Using this method will clear the server value when the bean is PUT to the server. Use the clearParameters() method to avoid clearing the server's value.

See the description of Null values.

See Also:

PARAMETERS

getFiletype

public String getFiletype()

Get the value for the 'file-type' field. The description of the 'file-type' field is:

"The type of content generated by executing the action; such as txt, html or xml."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

FILETYPE

isFiletypeNull

public boolean isFiletypeNull()

Get whether the 'file-type' field has been set to Null or not. The description of the 'file-type' field is:

"The type of content generated by executing the action; such as txt, html or xml."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setFiletypeNull(), FILETYPE

isFiletypeClear

public boolean isFiletypeClear()

Get whether the value for the 'file-type' field is clear or not. The description of the 'file-type' field is:

"The type of content generated by executing the action; such as txt, html or xml."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearFiletype(), FILETYPE

setFiletype

public void setFiletype(String filetype)

Set the value for the 'file-type' field. The description of the 'file-type' field is:

"The type of content generated by executing the action; such as txt, html or xml."

Parameters:

filetype - Value to set

See Also:

FILETYPE

clearFiletype

public void clearFiletype()

Clear any current value for the 'file-type' field in the bean. The description of the 'file-type' field is:

"The type of content generated by executing the action; such as txt, html or xml."

Using this method will not clear the server value when the bean is PUT to the server. Use the setFiletypeNull() method to clear the server's value.

See the description of cleared values.

See Also:

FILETYPE

setFiletypeNull

public void setFiletypeNull()

Set to Null any current value for the 'file-type' field in the bean. The description of the 'file-type' field is:

"The type of content generated by executing the action; such as txt, html or xml."

Using this method will clear the server value when the bean is PUT to the server. Use the clearFiletype() method to avoid clearing the server's value.

See the description of Null values.

See Also:

FILETYPE

getBeanMetaData

public static BeanMetaData<? extends ItemBean> getBeanMetaData()

Get the metadata class instance for this type.

The metadata is used primarily as a parameter to a BeanTransporter implementation''s constructor.

clone

public ItemBean clone()

Create a duplicate of this bean instance, including all field values.

Overrides:

clone in class Object