com.oberon.ooql.sdk
Class AdminComponent

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.AdminComponent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Column, FieldRange, Item, Stage, Step, Transition, Validation

public abstract class AdminComponent
extends OBBase
implements java.io.Serializable

A base class for components of Admin Objects.

Since:

4.0

Version:

5.0

See Also:

Serialized Form

Field Summary

java.util.BitSet

bsOptions Element options

Method Summary

java.lang.String	checkChangeName() Check if the object name was changed
void	fromXML(org.jdom.Element rootElement) Load the administrative object basic properties from XML element tree
java.lang.String	getAdminType() Get the administrative object Type
java.lang.String	getCommonProperty(java.lang.String propertyName, java.lang.String token, Framework framework) Get a (basic) property for the administrative object by its OOQL identifier
java.util.Vector<java.lang.String>	getCommonTargetNames(java.lang.String composedName, Framework framework) Return a Vector of administrative object names extracted by using an OOQL selector
java.lang.String	getCrtDate() Return the administrative object creation date
java.lang.String	getDescription() Get the administrative object Description
java.lang.String	getEditBasicCommand(java.lang.String propertyName) Return the OOQL command to edit a given administrative object basic property
byte[]	getImage() Return the administrative object icon
java.lang.String	getImageData() Return the administrative object icon codified as base64 string data
java.lang.String	getImageFile() Return the administrative object icon file path.
java.lang.String	getModDate() Return the administrative object last modification date
java.lang.String	getModUser() Return the administrative object modification User
java.lang.String	getName() Get the administrative object Name
java.lang.String	getOldName() Get the original administrative object Name keep the value read from DB
boolean	hasImage() Test if the administrative object has an image icon
void	setCrtDate(java.lang.String date) Set the administrative object creation date; [INTERNAL USAGE]
void	setDescription(java.lang.String description) Set the administrative object Description
void	setImage(byte[] image) Set the administrative object icon;
void	setImageData(java.lang.String base64ImageData) Set the administrative object icon from a base64 string data;
void	setImageFile(java.lang.String fileName) Set the administrative object icon importing it from a file;
void	setModDate(java.lang.String date) Set the administrative object modification date; [INTERNAL USAGE]
void	setModUser(java.lang.String userName) Set the administrative object modification User; [INTERNAL USAGE]
void	setName(java.lang.String name) Set the administrative object Name
org.jdom.Element	toCommonXML(boolean getImage, boolean fullDump, Framework framework) Return the administrative object basic properties as XML element tree
org.jdom.Element	toXML(java.lang.String adminType, boolean getImage, boolean fullDump, Framework framework) Return the administrative object basic properties as XML element tree

Methods inherited from class com.oberon.ooql.sdk.OBBase

addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, getProperty, getTargetNames, isLinked, removeChange, resetChanges, setId, setLinked

Methods inherited from class java.lang.Object

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

Field Detail

bsOptions

public java.util.BitSet bsOptions

Element options

Method Detail

getAdminType

public java.lang.String getAdminType()

Get the administrative object Type

setName

public void setName(java.lang.String name)
             throws OberonException

Set the administrative object Name

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains the pipe '|' character

getOldName

public java.lang.String getOldName()

Get the original administrative object Name keep the value read from DB

Returns:

the original name of the administrative object

getName

public java.lang.String getName()

Get the administrative object Name

Specified by:

getName in class OBBase

Returns:

the name of the administrative object

checkChangeName

public java.lang.String checkChangeName()

Check if the object name was changed

Returns:

the old name if changed or empty string otherwise

Since:

4.0

setDescription

public void setDescription(java.lang.String description)

Set the administrative object Description

Parameters:

description - the description to set for the administrative object

getDescription

public java.lang.String getDescription()

Get the administrative object Description

Returns:

the description of the administrative object

setImage

public void setImage(byte[] image)

Set the administrative object icon;

Parameters:

image - the image data

getImage

public byte[] getImage()

Return the administrative object icon

Returns:

the image data

setImageFile

public void setImageFile(java.lang.String fileName)

Set the administrative object icon importing it from a file;

Parameters:

fileName - the image file absolute path

getImageFile

public java.lang.String getImageFile()

Return the administrative object icon file path. The path is not stored on DB

Returns:

the image file absolute path previously settled

See Also:

setImageFile(String)

setImageData

public void setImageData(java.lang.String base64ImageData)

Set the administrative object icon from a base64 string data;

Parameters:

base64ImageData - the base64 image data

getImageData

public java.lang.String getImageData()

Return the administrative object icon codified as base64 string data

Returns:

the base64 string representing the image data

hasImage

public boolean hasImage()

Test if the administrative object has an image icon

setModDate

public void setModDate(java.lang.String date)

Set the administrative object modification date; [INTERNAL USAGE]

Parameters:

date - the modification date

getModDate

public java.lang.String getModDate()

Return the administrative object last modification date

Returns:

the last modification date

setCrtDate

public void setCrtDate(java.lang.String date)

Set the administrative object creation date; [INTERNAL USAGE]

Parameters:

date - the creation date

getCrtDate

public java.lang.String getCrtDate()

Return the administrative object creation date

Returns:

the creation date

setModUser

public void setModUser(java.lang.String userName)

Set the administrative object modification User; [INTERNAL USAGE]

Parameters:

userName - the User name who performed the last operation on the object

getModUser

public java.lang.String getModUser()

Return the administrative object modification User

Returns:

the User name who performed the last operation on the object

getCommonProperty

public java.lang.String getCommonProperty(java.lang.String propertyName,
                                          java.lang.String token,
                                          Framework framework)

Get a (basic) property for the administrative object by its OOQL identifier

Parameters:

propertyName - OOQL property identifier/name (example: id , name , moddate , description ...)

token - separator token for complex properties

framework - the current framework

Returns:

the property value

getCommonTargetNames

public java.util.Vector<java.lang.String> getCommonTargetNames(java.lang.String composedName,
                                                               Framework framework)

Return a Vector of administrative object names extracted by using an OOQL selector

Parameters:

composedName - OOQL property identifier/name (example: feature , feature[name] .. )

framework - the current framework

Returns:

a Vector of target names, used to extract their (sub)properties values

toXML

public org.jdom.Element toXML(java.lang.String adminType,
                              boolean getImage,
                              boolean fullDump,
                              Framework framework)

Return the administrative object basic properties as XML element tree

Parameters:

adminType - the object admin type

getImage - true to include "imagedata" element with the base64 encoded image data

fullDump - true to include detailed information

framework - the current framework

toCommonXML

public org.jdom.Element toCommonXML(boolean getImage,
                                    boolean fullDump,
                                    Framework framework)

Return the administrative object basic properties as XML element tree

Parameters:

getImage - true to include "imagedata" element with the base64 encoded image data

fullDump - true to include detailed information

framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the administrative object basic properties from XML element tree

getEditBasicCommand

public java.lang.String getEditBasicCommand(java.lang.String propertyName)

Return the OOQL command to edit a given administrative object basic property

Parameters:

propertyName - the name of the property (example: name, description , ....)