com.novell.db.object.bean
Class AttachmentBean

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

public class AttachmentBean
extends SentinelBean

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

The description of the type is:

"A file included or added to an incident."

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	ATTACHMENT_DESC The "bean name" of the Sentinel data object field 'Description'.
static String	CREATOR The "bean name" of the Sentinel data object field 'Creator'.
static String	DATA The "bean name" of the Sentinel data object field 'Data'.
static String	DATE_CREATED The "bean name" of the Sentinel data object field 'DateCreated'.
static String	DATE_MODIFIED The "bean name" of the Sentinel data object field 'DateModified'.
static String	FILE_EXT The "bean name" of the Sentinel data object field 'FileExtension'.
static String	MODIFIER The "bean name" of the Sentinel data object field 'Modifier'.
static String	NAME The "bean name" of the Sentinel data object field 'FileName'.
static String	SRC_REF The "bean name" of the Sentinel data object field 'Source'.
static String	SUB_TYP The "bean name" of the Sentinel data object field 'SubType'.
static String	TYP The "bean name" of the Sentinel data object field 'Type'.

Constructor Summary

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

Method Summary

void	clearData() Clear any current value for the 'data' field in the bean.
void	clearDescription() Clear any current value for the 'desc' field in the bean.
void	clearFileExtension() Clear any current value for the 'extension' field in the bean.
void	clearFileName() Clear any current value for the 'filename' field in the bean.
void	clearSource() Clear any current value for the 'source' field in the bean.
void	clearSubType() Clear any current value for the 'sub-type' field in the bean.
void	clearType() Clear any current value for the 'type' field in the bean.
AttachmentBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends AttachmentBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getCreatorLink() Get the URL for the 'creator' field.
String	getData() Get the value for the 'data' field.
Date	getDateCreated() Get the value for the 'createdate' field.
Date	getDateModified() Get the value for the 'moddate' field.
String	getDescription() Get the value for the 'desc' field.
String	getFileExtension() Get the value for the 'extension' field.
String	getFileName() Get the value for the 'filename' field.
String	getModifierLink() Get the URL for the 'modifier' field.
String	getSource() Get the value for the 'source' field.
String	getSubType() Get the value for the 'sub-type' field.
String	getType() Get the value for the 'type' field.
boolean	isCreatorLinkClear() Get whether the value for the 'creator' URL field is clear or not.
boolean	isCreatorLinkNull() Get whether the 'creator' URL field has been set to Null or not.
boolean	isDataClear() Get whether the value for the 'data' field is clear or not.
boolean	isDataNull() Get whether the 'data' field has been set to Null or not.
boolean	isDateCreatedClear() Get whether the value for the 'createdate' field is clear or not.
boolean	isDateCreatedNull() Get whether the 'createdate' field has been set to Null or not.
boolean	isDateModifiedClear() Get whether the value for the 'moddate' field is clear or not.
boolean	isDateModifiedNull() Get whether the 'moddate' field has been set to Null or not.
boolean	isDescriptionClear() Get whether the value for the 'desc' field is clear or not.
boolean	isDescriptionNull() Get whether the 'desc' field has been set to Null or not.
boolean	isFileExtensionClear() Get whether the value for the 'extension' field is clear or not.
boolean	isFileExtensionNull() Get whether the 'extension' field has been set to Null or not.
boolean	isFileNameClear() Get whether the value for the 'filename' field is clear or not.
boolean	isFileNameNull() Get whether the 'filename' field has been set to Null or not.
boolean	isModifierLinkClear() Get whether the value for the 'modifier' URL field is clear or not.
boolean	isModifierLinkNull() Get whether the 'modifier' URL field has been set to Null or not.
boolean	isSourceClear() Get whether the value for the 'source' field is clear or not.
boolean	isSourceNull() Get whether the 'source' field has been set to Null or not.
boolean	isSubTypeClear() Get whether the value for the 'sub-type' field is clear or not.
boolean	isSubTypeNull() Get whether the 'sub-type' field has been set to Null or not.
boolean	isTypeClear() Get whether the value for the 'type' field is clear or not.
boolean	isTypeNull() Get whether the 'type' field has been set to Null or not.
void	setData(String data) Set the value for the 'data' field.
void	setDataNull() Set to Null any current value for the 'data' field in the bean.
void	setDescription(String description) Set the value for the 'desc' field.
void	setDescriptionNull() Set to Null any current value for the 'desc' field in the bean.
void	setFileExtension(String fileExtension) Set the value for the 'extension' field.
void	setFileExtensionNull() Set to Null any current value for the 'extension' field in the bean.
void	setFileName(String fileName) Set the value for the 'filename' field.
void	setFileNameNull() Set to Null any current value for the 'filename' field in the bean.
void	setSource(String source) Set the value for the 'source' field.
void	setSourceNull() Set to Null any current value for the 'source' field in the bean.
void	setSubType(String subType) Set the value for the 'sub-type' field.
void	setSubTypeNull() Set to Null any current value for the 'sub-type' field in the bean.
void	setType(String type) Set the value for the 'type' field.
void	setTypeNull() Set to Null any current value for the 'type' 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

ATTACHMENT_DESC

public static final String ATTACHMENT_DESC

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

The description of the 'desc' field is:

"A description of the file being attached to the incident."

See Also:

Constant Field Values

DATE_MODIFIED

public static final String DATE_MODIFIED

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

The description of the 'moddate' field is:

"The date and time when the object was last modified."

See Also:

Constant Field Values

NAME

public static final String NAME

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

The description of the 'filename' field is:

"The name of the file being attached to the incident."

See Also:

Constant Field Values

TYP

public static final String TYP

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

The description of the 'type' field is:

"The type of file being attached to the incident."

See Also:

Constant Field Values

CREATOR

public static final String CREATOR

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

The description of the 'creator' field is:

"The URL of the Sentinel User object that represents the creator of the object."

See Also:

Constant Field Values

MODIFIER

public static final String MODIFIER

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

The description of the 'modifier' field is:

"The URL of the Sentinel User object that represents the last modifier of the object."

See Also:

Constant Field Values

DATA

public static final String DATA

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

The description of the 'data' field is:

"The data being attached to an incident, such as a log file."

See Also:

Constant Field Values

DATE_CREATED

public static final String DATE_CREATED

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

The description of the 'createdate' field is:

"The date and time when the object was created."

See Also:

Constant Field Values

SUB_TYP

public static final String SUB_TYP

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

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

"The sub-type of the file being attached to the incident."

See Also:

Constant Field Values

FILE_EXT

public static final String FILE_EXT

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

The description of the 'extension' field is:

"The extension of the file being attached to the incident."

See Also:

Constant Field Values

SRC_REF

public static final String SRC_REF

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

The description of the 'source' field is:

"The source of the file being attached to the incident."

See Also:

Constant Field Values

Constructor Detail

AttachmentBean

public AttachmentBean()

Construct an instance of the bean class.

AttachmentBean

protected AttachmentBean(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

getFileExtension

public String getFileExtension()

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

"The extension of the file being attached to the incident."

Returns:

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

See Also:

FILE_EXT

isFileExtensionNull

public boolean isFileExtensionNull()

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

"The extension of the file being attached to the incident."

See the description of Null values.

Returns:

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

See Also:

setFileExtensionNull(), FILE_EXT

isFileExtensionClear

public boolean isFileExtensionClear()

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

"The extension of the file being attached to the incident."

See the description of cleared values.

Returns:

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

See Also:

clearFileExtension(), FILE_EXT

setFileExtension

public void setFileExtension(String fileExtension)

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

"The extension of the file being attached to the incident."

Parameters:

fileExtension - Value to set

See Also:

FILE_EXT

clearFileExtension

public void clearFileExtension()

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

"The extension of the file being attached to the incident."

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

See the description of cleared values.

See Also:

FILE_EXT

setFileExtensionNull

public void setFileExtensionNull()

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

"The extension of the file being attached to the incident."

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

See the description of Null values.

See Also:

FILE_EXT

getSubType

public String getSubType()

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

"The sub-type of the file being attached to the incident."

Returns:

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

See Also:

SUB_TYP

isSubTypeNull

public boolean isSubTypeNull()

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

"The sub-type of the file being attached to the incident."

See the description of Null values.

Returns:

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

See Also:

setSubTypeNull(), SUB_TYP

isSubTypeClear

public boolean isSubTypeClear()

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

"The sub-type of the file being attached to the incident."

See the description of cleared values.

Returns:

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

See Also:

clearSubType(), SUB_TYP

setSubType

public void setSubType(String subType)

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

"The sub-type of the file being attached to the incident."

Parameters:

subType - Value to set

See Also:

SUB_TYP

clearSubType

public void clearSubType()

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

"The sub-type of the file being attached to the incident."

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

See the description of cleared values.

See Also:

SUB_TYP

setSubTypeNull

public void setSubTypeNull()

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

"The sub-type of the file being attached to the incident."

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

See the description of Null values.

See Also:

SUB_TYP

getDateModified

public Date getDateModified()

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

"The date and time when the object was last modified."

Returns:

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

See Also:

DATE_MODIFIED

isDateModifiedNull

public boolean isDateModifiedNull()

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

"The date and time when the object was last modified."

See the description of Null values.

Returns:

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

See Also:

DATE_MODIFIED

isDateModifiedClear

public boolean isDateModifiedClear()

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

"The date and time when the object was last modified."

See the description of cleared values.

Returns:

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

See Also:

DATE_MODIFIED

getDescription

public String getDescription()

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

"A description of the file being attached to the incident."

Returns:

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

See Also:

ATTACHMENT_DESC

isDescriptionNull

public boolean isDescriptionNull()

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

"A description of the file being attached to the incident."

See the description of Null values.

Returns:

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

See Also:

setDescriptionNull(), ATTACHMENT_DESC

isDescriptionClear

public boolean isDescriptionClear()

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

"A description of the file being attached to the incident."

See the description of cleared values.

Returns:

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

See Also:

clearDescription(), ATTACHMENT_DESC

setDescription

public void setDescription(String description)

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

"A description of the file being attached to the incident."

Parameters:

description - Value to set

See Also:

ATTACHMENT_DESC

clearDescription

public void clearDescription()

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

"A description of the file being attached to the incident."

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:

ATTACHMENT_DESC

setDescriptionNull

public void setDescriptionNull()

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

"A description of the file being attached to the incident."

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:

ATTACHMENT_DESC

getSource

public String getSource()

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

"The source of the file being attached to the incident."

Returns:

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

See Also:

SRC_REF

isSourceNull

public boolean isSourceNull()

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

"The source of the file being attached to the incident."

See the description of Null values.

Returns:

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

See Also:

setSourceNull(), SRC_REF

isSourceClear

public boolean isSourceClear()

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

"The source of the file being attached to the incident."

See the description of cleared values.

Returns:

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

See Also:

clearSource(), SRC_REF

setSource

public void setSource(String source)

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

"The source of the file being attached to the incident."

Parameters:

source - Value to set

See Also:

SRC_REF

clearSource

public void clearSource()

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

"The source of the file being attached to the incident."

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

See the description of cleared values.

See Also:

SRC_REF

setSourceNull

public void setSourceNull()

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

"The source of the file being attached to the incident."

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

See the description of Null values.

See Also:

SRC_REF

getDateCreated

public Date getDateCreated()

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

"The date and time when the object was created."

Returns:

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

See Also:

DATE_CREATED

isDateCreatedNull

public boolean isDateCreatedNull()

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

"The date and time when the object was created."

See the description of Null values.

Returns:

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

See Also:

DATE_CREATED

isDateCreatedClear

public boolean isDateCreatedClear()

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

"The date and time when the object was created."

See the description of cleared values.

Returns:

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

See Also:

DATE_CREATED

getData

public String getData()

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

"The data being attached to an incident, such as a log file."

Returns:

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

See Also:

DATA

isDataNull

public boolean isDataNull()

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

"The data being attached to an incident, such as a log file."

See the description of Null values.

Returns:

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

See Also:

setDataNull(), DATA

isDataClear

public boolean isDataClear()

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

"The data being attached to an incident, such as a log file."

See the description of cleared values.

Returns:

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

See Also:

clearData(), DATA

setData

public void setData(String data)

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

"The data being attached to an incident, such as a log file."

Parameters:

data - Value to set

See Also:

DATA

clearData

public void clearData()

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

"The data being attached to an incident, such as a log file."

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

See the description of cleared values.

See Also:

DATA

setDataNull

public void setDataNull()

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

"The data being attached to an incident, such as a log file."

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

See the description of Null values.

See Also:

DATA

getFileName

public String getFileName()

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

"The name of the file being attached to the incident."

Returns:

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

See Also:

NAME

isFileNameNull

public boolean isFileNameNull()

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

"The name of the file being attached to the incident."

See the description of Null values.

Returns:

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

See Also:

setFileNameNull(), NAME

isFileNameClear

public boolean isFileNameClear()

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

"The name of the file being attached to the incident."

See the description of cleared values.

Returns:

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

See Also:

clearFileName(), NAME

setFileName

public void setFileName(String fileName)

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

"The name of the file being attached to the incident."

Parameters:

fileName - Value to set

See Also:

NAME

clearFileName

public void clearFileName()

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

"The name of the file being attached to the incident."

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

See the description of cleared values.

See Also:

NAME

setFileNameNull

public void setFileNameNull()

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

"The name of the file being attached to the incident."

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

See the description of Null values.

See Also:

NAME

getType

public String getType()

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

"The type of file being attached to the incident."

Returns:

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

See Also:

TYP

isTypeNull

public boolean isTypeNull()

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

"The type of file being attached to the incident."

See the description of Null values.

Returns:

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

See Also:

setTypeNull(), TYP

isTypeClear

public boolean isTypeClear()

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

"The type of file being attached to the incident."

See the description of cleared values.

Returns:

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

See Also:

clearType(), TYP

setType

public void setType(String type)

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

"The type of file being attached to the incident."

Parameters:

type - Value to set

See Also:

TYP

clearType

public void clearType()

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

"The type of file being attached to the incident."

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

See the description of cleared values.

See Also:

TYP

setTypeNull

public void setTypeNull()

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

"The type of file being attached to the incident."

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

See the description of Null values.

See Also:

TYP

getModifierLink

public String getModifierLink()

Get the URL for the 'modifier' field. The description of the 'modifier' field is:

"The URL of the Sentinel User object that represents the last modifier of the object."

Returns:

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

See Also:

MODIFIER

isModifierLinkNull

public boolean isModifierLinkNull()

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

"The URL of the Sentinel User object that represents the last modifier of the object."

See the description of Null values.

Returns:

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

See Also:

MODIFIER

isModifierLinkClear

public boolean isModifierLinkClear()

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

"The URL of the Sentinel User object that represents the last modifier of the object."

See the description of cleared values.

Returns:

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

See Also:

MODIFIER

getCreatorLink

public String getCreatorLink()

Get the URL for the 'creator' field. The description of the 'creator' field is:

"The URL of the Sentinel User object that represents the creator of the object."

Returns:

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

See Also:

CREATOR

isCreatorLinkNull

public boolean isCreatorLinkNull()

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

"The URL of the Sentinel User object that represents the creator of the object."

See the description of Null values.

Returns:

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

See Also:

CREATOR

isCreatorLinkClear

public boolean isCreatorLinkClear()

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

"The URL of the Sentinel User object that represents the creator of the object."

See the description of cleared values.

Returns:

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

See Also:

CREATOR

getBeanMetaData

public static BeanMetaData<? extends AttachmentBean> 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 AttachmentBean clone()

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

Overrides:

clone in class Object