Package wt.util.jmx

Interface PropertiesEditorMBean

All Superinterfaces:

AbstractFileViewMBean, AbstractPropertiesManagerMBean, SelfEmailingMBean

public interface PropertiesEditorMBean
extends AbstractPropertiesManagerMBean

MBean for editing Windchill properties

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
void	addToProperty(String propertyName, String propertyValue)	Add a property value to the named multivalued property Supported API: true
String	getTargetFile()	Retrieve the target property filename relative to the Windchill home directory Supported API: true
void	removeFromProperty(String propertyName, String propertyValue)	Remove a property value from the named multivalued property Supported API: true
void	resetProperty(String propertyName)	Reset the named property to the default value Supported API: true
void	setProperty(String propertyName, String propertyValue)	Set the named property to the specified value Supported API: true
void	setProperty(String propertyName, String propertyValue, String comment)	Set the named property to the specified value Supported API: true
void	undefineProperty(String propertyName)	Undefine the named proeprty Supported API: true

Methods inherited from interface wt.jmx.core.mbeans.AbstractFileViewMBean

getLastModifiedTime, getName, getPath, isExists

Methods inherited from interface wt.util.jmx.AbstractPropertiesManagerMBean

applyPendingChanges, clearPendingChanges, emailFile, getLogger, getLogLevel, getProperty, getSize, reviewPendingChanges, searchFile, sendFileToSupport, setLogLevel, viewFile

Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

emailThisMBean

Method Details

getTargetFile

String getTargetFile()

Retrieve the target property filename relative to the Windchill home directory

Supported API: true

setProperty

@MBeanOperationImpact(1)
void setProperty(String propertyName,
 String propertyValue)
          throws IllegalAccessException

Set the named property to the specified value

Supported API: true

Parameters:

propertyName - Property to set

propertyValue - Property value to set

Throws:

IllegalAccessException

setProperty

@MBeanOperationImpact(1)
void setProperty(String propertyName,
 String propertyValue,
 String comment)
          throws IllegalAccessException

Set the named property to the specified value

Supported API: true

Parameters:

propertyName - Property to set

propertyValue - Property value to set

comment -

Throws:

IllegalAccessException

resetProperty

@MBeanOperationImpact(1)
void resetProperty(String propertyName)
            throws IllegalAccessException

Reset the named property to the default value

Supported API: true

Parameters:

propertyName - Property to reset

Throws:

IllegalAccessException

addToProperty

@MBeanOperationImpact(1)
void addToProperty(String propertyName,
 String propertyValue)
            throws IllegalAccessException

Add a property value to the named multivalued property

Supported API: true

Parameters:

propertyName - Property to add to

propertyValue - Property value to add

Throws:

IllegalAccessException

removeFromProperty

@MBeanOperationImpact(1)
void removeFromProperty(String propertyName,
 String propertyValue)
                 throws IllegalAccessException

Remove a property value from the named multivalued property

Supported API: true

Parameters:

propertyName - Property to remove from

propertyValue - Property value to remove

Throws:

IllegalAccessException

undefineProperty

@MBeanOperationImpact(1)
void undefineProperty(String propertyName)
               throws IllegalAccessException

Undefine the named proeprty

Supported API: true

Parameters:

propertyName - Property to undefine

Throws:

IllegalAccessException