com.bowstreet.profiles
Class ProfileDefEntry

java.lang.Object
  com.bowstreet.profiles.NamedObject
      com.bowstreet.profiles.ProfileDefEntry

All Implemented Interfaces:

IProfileDefines, com.bowstreet.profiles.IXmlDataAccess, java.io.Serializable

public class ProfileDefEntry
extends NamedObject
implements IProfileDefines

Class that represents a single Entry from within a ProfileDef. The ProfileDefEntry contains metadata about ProfileValues that are stored within a Profile.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.bowstreet.profiles.IProfileDefines

CURRENT_CUSTOM_VALUE_PSET, CUSTOM_VALUE_MAP_KEY, DEFAULT, DESCRIPTION, EDIT_STATUS, EDITABLE, EFFECTS_CHILD, emptyIterator, ENTRIES, ENTRY, EXTRA_DATA, FALSE, FINAL_LOCKED, FINAL_LOCKED_STR, INHERITED_FROM, INHERITED_LOCKED, INHERITED_LOCKED_STR, IS_CONTAINER, IS_FINAL, IS_INHERITED, IS_RUNTIME, LAST_MODIFIED, LAST_MODIFIED_BY, MODEL, MODELS, NAME, PARENT, PC_ALREADY_CONVERTED, PC_INVALID_DATA, PC_NO_PROFILE, PC_OK, PROFILE, PROFILE_ATTR, PROFILE_DEF, PROFILE_SET, PROFILE_SET_MAP_PREVIEW_KEY, PROFILED, PROFILES, PROMPT, ROLE, ROLE_SELECTION_CLASS, ROLES, TRUE, TYPE, UI, USE_FULL_NAMES, VALUE, VALUE_CLASS, VALUES

Constructor Summary

ProfileDefEntry()
Empty constructor.

ProfileDefEntry(IXml tdEntry)
Constructs ProfileDefEntry from IXml.

ProfileDefEntry(java.lang.String strName, java.lang.String strType, java.lang.String strPrompt, java.lang.String strExtraData)
Constructs a ProfileDefEntry and sets its data members with the specified values.

Method Summary

boolean	equals(java.lang.Object obj) Compare two ProfileDefEntry's.
IXml	getAsIXml(boolean getAll) Gets the entire ProfileDefEntry as IXml.
java.lang.String	getUIExtraData() Gets the optional extra data that in associated with the UI type.
java.lang.String	getUIPrompt() Gets the display prompt of this ProfileDefEntry.
java.lang.String	getUIType() Gets the UI type of this ProfileDefEntry.
boolean	isRuntime() Checks if this entry is used for runtime data.
void	setFromIXml(IXml tdEntry) Sets the entire ProfileDefEntry from a IXml.
void	setIsRuntime(boolean isRuntime) Sets if this entry is to be used for runtime data.
void	setUIExtraData(java.lang.String strExtraData) Sets the optional extra data that in associated with the UI type.
void	setUIPrompt(java.lang.String strPrompt) Sets the display prompt of this ProfileDefEntry.
void	setUIType(java.lang.String strType) Sets the UI type of this ProfileDefEntry.
void	update(com.bowstreet.profiles.IXmlDataAccess item) Updates data members from an existing ProfileDefEntry.

Methods inherited from class com.bowstreet.profiles.NamedObject

clone, getName, setName

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileDefEntry

public ProfileDefEntry()

Empty constructor.

ProfileDefEntry

public ProfileDefEntry(IXml tdEntry)
                throws ProfileException

Constructs ProfileDefEntry from IXml.

Parameters:

tdEntry - The XML representation of a ProfileDefEntry.

Throws:

ProfileException - On error.

ProfileDefEntry

public ProfileDefEntry(java.lang.String strName,
                       java.lang.String strType,
                       java.lang.String strPrompt,
                       java.lang.String strExtraData)

Constructs a ProfileDefEntry and sets its data members with the specified values.

Parameters:

strName - The Name, which must be unique within this ProfileSet.

strType - The UI Type.

strPrompt - The display prompt.

strExtraData - The extra data.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compare two ProfileDefEntry's.

Overrides:

equals in class NamedObject

Parameters:

obj - The ProfileDefEntry to compare against.

Returns:

true if ProfileDefEntry is equal, else false.

getAsIXml

public IXml getAsIXml(boolean getAll)
               throws ProfileException

Gets the entire ProfileDefEntry as IXml. The entire ProfileDefEntry will be represented as one block of XML(IXml).

Specified by:

getAsIXml in interface com.bowstreet.profiles.IXmlDataAccess

Parameters:

getAll - specifies if all of the data should be returned. This has no effect on a ProfileDefEntry.

Returns:

The XML data representation of this ProfileDefEntry.

Throws:

ProfileException - On error.

See Also:

IXml

getUIExtraData

public java.lang.String getUIExtraData()

Gets the optional extra data that in associated with the UI type.

Returns:

The extra UI data.

getUIPrompt

public java.lang.String getUIPrompt()

Gets the display prompt of this ProfileDefEntry.

Returns:

The prompt.

getUIType

public java.lang.String getUIType()

Gets the UI type of this ProfileDefEntry.

Returns:

The UI Type.

isRuntime

public boolean isRuntime()

Checks if this entry is used for runtime data. If true then this entry can be specifies when profiling a Builder input that accepts runtime profile data. If false this entry can only be used as a Builder input that accepts regeneration time profile data. When this is true the regeneration process will not considered this entry when determining if the profile has changed and therefore forcing a new WebApp to be generated.

Returns:

true if this entry is specified to be used as runtime profile data, else false.

setFromIXml

public void setFromIXml(IXml tdEntry)
                 throws ProfileException

Sets the entire ProfileDefEntry from a IXml. The entire ProfileDefEntry will be overwritten with the XML(IXml) data.

Specified by:

setFromIXml in interface com.bowstreet.profiles.IXmlDataAccess

Parameters:

tdEntry - The IXml representation of a ProfileDefEntry.

Throws:

ProfileException - On error.

See Also:

IXml

setIsRuntime

public void setIsRuntime(boolean isRuntime)

Sets if this entry is to be used for runtime data. If true then this entry can be specifies when profiling a Builder input that accepts runtime profile data. If false this entry can only be used as a Builder input that accepts regeneration time profile data. When this is true the regeneration process will not considered this entry when determining if the profile has changed and therefore forcing a new WebApp to be generated.

Parameters:

isRuntime - true if this entry is specified to be used as runtime profile data, else false.

setUIExtraData

public void setUIExtraData(java.lang.String strExtraData)

Sets the optional extra data that in associated with the UI type.

Parameters:

strExtraData - The extra data.

setUIPrompt

public void setUIPrompt(java.lang.String strPrompt)

Sets the display prompt of this ProfileDefEntry.

Parameters:

strPrompt - The display prompt.

setUIType

public void setUIType(java.lang.String strType)

Sets the UI type of this ProfileDefEntry.

Parameters:

strType - The UI Type.

update

public void update(com.bowstreet.profiles.IXmlDataAccess item)

Updates data members from an existing ProfileDefEntry.

Specified by:

update in interface com.bowstreet.profiles.IXmlDataAccess

Overrides:

update in class NamedObject

Parameters:

item - The IXmlDataAccess, which must be a ProfileDefEntry.