com.bowstreet.profiles
Class ProfileSetDescription

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ProfileSet

public class ProfileSetDescription
extends NamedObject

Class to hold description and name information for a ProfileSet. This is used when getting a list of ProfileSet form the ProfileSetManager so we can just return metadata and not the entire ProfileSet.

See Also:

ProfileSet, 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

ProfileSetDescription(java.lang.String strName, java.lang.String strDescription, long lastTimeModified, java.lang.String strLastModifiedBy)
Constructs a ProfileSetDescription with the specified description information.

Method Summary

IXml	getAsIXml(boolean getAll) Currently does nothing.
java.lang.String	getDescription() Gets the description data of this ProfileSet.
java.lang.String	getLastModifiedBy() Gets the name of the user who last modified this ProfileSet.
long	getLastTimeModified() Gets the last time this ProfileSet was modified.
void	setDescription(java.lang.String strDescription) Sets the description field of this Profile Set.
void	setFromIXml(IXml tdData) Currently does nothing.
void	setLastModifiedBy(java.lang.String strLastModifiedBy) Sets the name of the user who last modified this ProfileSet.
void	setLastTimeModified(long lastTimeModified) Sets the last time this ProfileSet was modified.
void	setUseQualifiedProfileNames(boolean useQualifiedProfileNames) Sets if this profile set should be using full names (e.g. bowstreet.hr.foo).
java.lang.String	toString() Gets a string representation of this description for debugging.
void	update(com.bowstreet.profiles.IXmlDataAccess item) Updates from an existing ProfileSetDescription.
boolean	useQualifiedProfileNames() Checks if this profile set should be using full names (e.g. bowstreet.hr.foo).

Methods inherited from class com.bowstreet.profiles.NamedObject

clone, equals, getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileSetDescription

public ProfileSetDescription(java.lang.String strName,
                             java.lang.String strDescription,
                             long lastTimeModified,
                             java.lang.String strLastModifiedBy)

Constructs a ProfileSetDescription with the specified description information.

Parameters:

strName - The ProfileSet name.

strDescription - The ProfileSet description.

lastTimeModified - The last time the ProfileSet was modified.

strLastModifiedBy - The name of who last modified the ProfileSet.

Method Detail

getAsIXml

public IXml getAsIXml(boolean getAll)
               throws ProfileException

Currently does nothing.

Parameters:

getAll - true to get all of the calculated inherited data, else false.

Returns:

The XML data representation of this ProfileSet.

Throws:

ProfileException

See Also:

IXml

getDescription

public java.lang.String getDescription()

Gets the description data of this ProfileSet.

Returns:

The description.

getLastModifiedBy

public java.lang.String getLastModifiedBy()

Gets the name of the user who last modified this ProfileSet. This is set only when a ProfileSet is written to the storage device.

Returns:

The name of the user last modified this ProfileSet.

getLastTimeModified

public long getLastTimeModified()

Gets the last time this ProfileSet was modified. This is set only when a ProfileSet is read from the storage device.

Returns:

The last time this ProfileSet was modified.

setDescription

public void setDescription(java.lang.String strDescription)

Sets the description field of this Profile Set.

Parameters:

strDescription - The description to set on this ProfileSet.

setFromIXml

public void setFromIXml(IXml tdData)
                 throws ProfileException

Currently does nothing.

Parameters:

tdData - The IXml representation of a ProfileSetDescription.

Throws:

ProfileException

See Also:

IXml

setLastModifiedBy

public void setLastModifiedBy(java.lang.String strLastModifiedBy)

Sets the name of the user who last modified this ProfileSet. This is set only when a ProfileSet is written to the storage device.

Parameters:

strLastModifiedBy - The name of the user last modified this ProfileSet.

setLastTimeModified

public void setLastTimeModified(long lastTimeModified)

Sets the last time this ProfileSet was modified. This should only be set by the ProfileSet storage device.

Parameters:

lastTimeModified - The last time this ProfileSet was modified.

setUseQualifiedProfileNames

public void setUseQualifiedProfileNames(boolean useQualifiedProfileNames)

Sets if this profile set should be using full names (e.g. bowstreet.hr.foo).

Parameters:

useQualifiedProfileNames - true if this profile set should be using full names (e.g. bowstreet.hr.foo), else false.

toString

public java.lang.String toString()

Gets a string representation of this description for debugging.

Overrides:

toString in class java.lang.Object

Returns:

The String.

update

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

Updates from an existing ProfileSetDescription.

Specified by:

update in interface com.bowstreet.profiles.IXmlDataAccess

Overrides:

update in class NamedObject

Parameters:

item - The IXmlDataAccess, which must be a ProfileSetDescription.

useQualifiedProfileNames

public boolean useQualifiedProfileNames()

Checks if this profile set should be using full names (e.g. bowstreet.hr.foo).

Returns:

true if this profile set should be using full names (e.g. bowstreet.hr.foo), else false.