com.ptc.windchill.structconf
Class SetSiteProperty

java.lang.Object
  com.ptc.windchill.structconf.StructConfManagerCommand
      com.ptc.windchill.structconf.TargetFileBearingCommand
          com.ptc.windchill.structconf.SetSiteProperty

public class SetSiteProperty

extends TargetFileBearingCommand

Command to instruct the StructConfManager to change the site-specific value of the named property to the specified value.

Field Summary

private String	comment_
private String	propertyName_
private String	propertyValue_

Fields inherited from class com.ptc.windchill.structconf.TargetFileBearingCommand

Fields inherited from class com.ptc.windchill.structconf.StructConfManagerCommand

Constructor Summary

SetSiteProperty(String property_name, String property_value)
Create instance to set property_name to property_value, using the declared target file as the target file.

SetSiteProperty(String property_name, String property_value, String target_file)
Create instance to set property_name to property_value, using the specified target file as the target file.

SetSiteProperty(String property_name, String property_value, String target_file, String comment)
Create instance to set property_name to property_value, using the specified target file as the target file.

Method Summary

(package private) void	execute()
void	setComment(String comment)

Methods inherited from class com.ptc.windchill.structconf.TargetFileBearingCommand

getTargetFile, hasTargetFile, setTargetFile

Methods inherited from class com.ptc.windchill.structconf.StructConfManagerCommand

execute, getCollector, getDeclarativeUpdater, getManager, getSiteUpdater, getUpdater, getUpdater, requiresSaveImmediatelyAfter, setRequiresSaveImmediatelyAfter

Methods inherited from class java.lang.Object

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

Field Detail

propertyName_

private String propertyName_

propertyValue_

private String propertyValue_

comment_

private String comment_

Constructor Detail

SetSiteProperty

public SetSiteProperty(String property_name,
                       String property_value)

Create instance to set property_name to property_value, using the declared target file as the target file. If the property is not declared anywhere, then the alternative constructor must be used to specify a target file.

See Also:

SetSiteProperty(java.lang.String,java.lang.String,java.lang.String)

SetSiteProperty

public SetSiteProperty(String property_name,
                       String property_value,
                       String target_file)

Create instance to set property_name to property_value, using the specified target file as the target file. The target file must match the declared target file OR there must be no declaration of the property in order to use this alternative.

SetSiteProperty

public SetSiteProperty(String property_name,
                       String property_value,
                       String target_file,
                       String comment)

Create instance to set property_name to property_value, using the specified target file as the target file. The target file must match the declared target file OR there must be no declaration of the property in order to use this alternative.

Method Detail

setComment

public void setComment(String comment)

execute

void execute()
       throws StructConfManagerException

Specified by:

execute in class StructConfManagerCommand

Throws:

StructConfManagerException