/**
* This file was auto-generated by mofcomp -j version 1.0.0 on Wed Jan 12
* 09:21:06 CET 2011.
*/
package org.opennaas.extensions.router.model;
import java.io.*;
import java.lang.Exception;
/**
* This Class contains accessor and mutator methods for all properties defined in the CIM class CLPSettingData as well as methods comparable to the
* invokeMethods defined for this class. This Class implements the CLPSettingDataBean Interface. The CIM class CLPSettingData is described as follows:
*
* A representation of the SettingData of a CLProtocol. The relationship between the SettingData and the CLP Service is described by instantiating the
* ProvidesEndpoint association, with an association to the transport (TelnetProtocolEndpoint or SSHProtocolEndpoint) with a BindsTo association.
*/
public class CLPSettingData extends SettingData implements Serializable {
/**
* This constructor creates a CLPSettingDataBeanImpl Class which implements the CLPSettingDataBean Interface, and encapsulates the CIM class
* CLPSettingData in a Java Bean. The CIM class CLPSettingData is described as follows:
*
* A representation of the SettingData of a CLProtocol. The relationship between the SettingData and the CLP Service is described by instantiating
* the ProvidesEndpoint association, with an association to the transport (TelnetProtocolEndpoint or SSHProtocolEndpoint) with a BindsTo
* association.
*/
public CLPSettingData() {
};
/**
* The following constants are defined for use with the ValueMap/Values qualified property currentDefaultTarget.
*/
private String currentDefaultTarget;
/**
* This method returns the CLPSettingData.currentDefaultTarget property value. This property is described as follows:
*
* Identifies the initial Current Default Target when a CLP Session is established. The Current Default Target is the CLP session environment
* setting that establishes a default base address for all command targets that are expressed as a relative target address and is used as the
* command target if no command target is specified in a command. The CLP specification requires this value to be fixed at the root of the address
* space being managed. Therefore this value does not have a write qualifier.
*
* @return String current currentDefaultTarget property value
* @exception Exception
*/
public String getCurrentDefaultTarget() {
return this.currentDefaultTarget;
} // getCurrentDefaultTarget
/**
* This method sets the CLPSettingData.currentDefaultTarget property value. This property is described as follows:
*
* Identifies the initial Current Default Target when a CLP Session is established. The Current Default Target is the CLP session environment
* setting that establishes a default base address for all command targets that are expressed as a relative target address and is used as the
* command target if no command target is specified in a command. The CLP specification requires this value to be fixed at the root of the address
* space being managed. Therefore this value does not have a write qualifier.
*
* @param String
* new currentDefaultTarget property value
* @exception Exception
*/
public void setCurrentDefaultTarget(String currentDefaultTarget) {
this.currentDefaultTarget = currentDefaultTarget;
} // setCurrentDefaultTarget
/**
* The following constants are defined for use with the ValueMap/Values qualified property keepTime.
*/
private int keepTime;
/**
* This method returns the CLPSettingData.keepTime property value. This property is described as follows:
*
* Establishes the amount of time in seconds that the CLP Session should retain a CLP command job status. A KeepTime value of zero shall be
* interpreted to mean keep forever.
*
* @return int current keepTime property value
* @exception Exception
*/
public int getKeepTime() {
return this.keepTime;
} // getKeepTime
/**
* This method sets the CLPSettingData.keepTime property value. This property is described as follows:
*
* Establishes the amount of time in seconds that the CLP Session should retain a CLP command job status. A KeepTime value of zero shall be
* interpreted to mean keep forever.
*
* @param int new keepTime property value
* @exception Exception
*/
public void setKeepTime(int keepTime) {
this.keepTime = keepTime;
} // setKeepTime
/**
* The following constants are defined for use with the ValueMap/Values qualified property waitBehavior.
*/
private boolean waitBehavior;
/**
* This method returns the CLPSettingData.waitBehavior property value. This property is described as follows:
*
* When TRUE the CLP Session will not return a command response until all spawned jobs have completed, otherwise it may.
*
* @return boolean current waitBehavior property value
* @exception Exception
*/
public boolean isWaitBehavior() {
return this.waitBehavior;
} // getWaitBehavior
/**
* This method sets the CLPSettingData.waitBehavior property value. This property is described as follows:
*
* When TRUE the CLP Session will not return a command response until all spawned jobs have completed, otherwise it may.
*
* @param boolean new waitBehavior property value
* @exception Exception
*/
public void setWaitBehavior(boolean waitBehavior) {
this.waitBehavior = waitBehavior;
} // setWaitBehavior
/**
* The following constants are defined for use with the ValueMap/Values qualified property OutputFormat.
*/
public enum OutputFormat {
TEXT,
CLPCSV,
KEYWORD,
CLPXML,
DMTF_RESERVED,
VENDOR_RESERVED
}
private OutputFormat outputFormat;
/**
* This method returns the CLPSettingData.outputFormat property value. This property is described as follows:
*
* OutputFormat establishes the default CLP Session command output format, as described in SM CLP Specification, DMTF document DSP0214.
*
* @return int current outputFormat property value
* @exception Exception
*/
public OutputFormat getOutputFormat() {
return this.outputFormat;
} // getOutputFormat
/**
* This method sets the CLPSettingData.outputFormat property value. This property is described as follows:
*
* OutputFormat establishes the default CLP Session command output format, as described in SM CLP Specification, DMTF document DSP0214.
*
* @param int new outputFormat property value
* @exception Exception
*/
public void setOutputFormat(OutputFormat outputFormat) {
this.outputFormat = outputFormat;
} // setOutputFormat
/**
* The following constants are defined for use with the ValueMap/Values qualified property OutputVerbosity.
*/
public enum OutputVerbosity {
ERROR,
TERSE,
VERBOSE,
DMTF_RESERVED,
VENDOR_RESERVED
}
private OutputVerbosity outputVerbosity;
/**
* This method returns the CLPSettingData.outputVerbosity property value. This property is described as follows:
*
* OutputVerbosity establishes the default CLP Session output level of detail, as described in SM CLP Specification, DMTF document DSP0214.
*
* @return int current outputVerbosity property value
* @exception Exception
*/
public OutputVerbosity getOutputVerbosity() {
return this.outputVerbosity;
} // getOutputVerbosity
/**
* This method sets the CLPSettingData.outputVerbosity property value. This property is described as follows:
*
* OutputVerbosity establishes the default CLP Session output level of detail, as described in SM CLP Specification, DMTF document DSP0214.
*
* @param int new outputVerbosity property value
* @exception Exception
*/
public void setOutputVerbosity(OutputVerbosity outputVerbosity) {
this.outputVerbosity = outputVerbosity;
} // setOutputVerbosity
/**
* The following constants are defined for use with the ValueMap/Values qualified property outputLanguage.
*/
private String outputLanguage;
/**
* This method returns the CLPSettingData.outputLanguage property value. This property is described as follows:
*
* Establishes the default CLP Session command output language. As described in SM CLP Specification, DMTF document DSP0214, the language value is
* a 3-character string identifier of language as specified in ISO 639.2; "eng" is the default.
*
* @return String current outputLanguage property value
* @exception Exception
*/
public String getOutputLanguage() {
return this.outputLanguage;
} // getOutputLanguage
/**
* This method sets the CLPSettingData.outputLanguage property value. This property is described as follows:
*
* Establishes the default CLP Session command output language. As described in SM CLP Specification, DMTF document DSP0214, the language value is
* a 3-character string identifier of language as specified in ISO 639.2; "eng" is the default.
*
* @param String
* new outputLanguage property value
* @exception Exception
*/
public void setOutputLanguage(String outputLanguage) {
this.outputLanguage = outputLanguage;
} // setOutputLanguage
/**
* The following constants are defined for use with the ValueMap/Values qualified property OutputPosition.
*/
public enum OutputPosition {
BEGIN,
END,
DMTF_RESERVED,
VENDOR_RESERVED
}
private OutputPosition outputPosition;
/**
* This method returns the CLPSettingData.outputPosition property value. This property is described as follows:
*
* OutputPosition establishes the default CLP Session command output beginning position when multiple items are returned in the command output, as
* described in SM CLP Specification, DMTF document DSP0214.
*
* @return int current outputPosition property value
* @exception Exception
*/
public OutputPosition getOutputPosition() {
return this.outputPosition;
} // getOutputPosition
/**
* This method sets the CLPSettingData.outputPosition property value. This property is described as follows:
*
* OutputPosition establishes the default CLP Session command output beginning position when multiple items are returned in the command output, as
* described in SM CLP Specification, DMTF document DSP0214.
*
* @param int new outputPosition property value
* @exception Exception
*/
public void setOutputPosition(OutputPosition outputPosition) {
this.outputPosition = outputPosition;
} // setOutputPosition
/**
* The following constants are defined for use with the ValueMap/Values qualified property OutputOrder.
*/
public enum OutputOrder {
DEFAULT,
REVERSE,
DMTF_RESERVED,
VENDOR_RESERVED
}
private OutputOrder outputOrder;
/**
* This method returns the CLPSettingData.outputOrder property value. This property is described as follows:
*
* OutputOrder establishes the default CLP Session command output order when multiple items are returned in the command output as described in SM
* CLP Specification, DMTF document DSP0214.
*
* @return int current outputOrder property value
* @exception Exception
*/
public OutputOrder getOutputOrder() {
return this.outputOrder;
} // getOutputOrder
/**
* This method sets the CLPSettingData.outputOrder property value. This property is described as follows:
*
* OutputOrder establishes the default CLP Session command output order when multiple items are returned in the command output as described in SM
* CLP Specification, DMTF document DSP0214.
*
* @param int new outputOrder property value
* @exception Exception
*/
public void setOutputOrder(OutputOrder outputOrder) {
this.outputOrder = outputOrder;
} // setOutputOrder
/**
* The following constants are defined for use with the ValueMap/Values qualified property outputCount.
*/
private long outputCount;
/**
* This method returns the CLPSettingData.outputCount property value. This property is described as follows:
*
* Establishes the default CLP Session command output count number when multiple items are returned in the output as described in SM CLP
* Specification, DMTF document DSP0214. The value 0xFFFFFFFF shall be interpreted to mean that all items are to be returned. The maximum value
* for the count number is determined by the class of the target.
*
* @return long current outputCount property value
* @exception Exception
*/
public long getOutputCount() {
return this.outputCount;
} // getOutputCount
/**
* This method sets the CLPSettingData.outputCount property value. This property is described as follows:
*
* Establishes the default CLP Session command output count number when multiple items are returned in the output as described in SM CLP
* Specification, DMTF document DSP0214. The value 0xFFFFFFFF shall be interpreted to mean that all items are to be returned. The maximum value
* for the count number is determined by the class of the target.
*
* @param long new outputCount property value
* @exception Exception
*/
public void setOutputCount(long outputCount) {
this.outputCount = outputCount;
} // setOutputCount
/**
* The following constants are defined for use with the ValueMap/Values qualified property displayOption.
*/
private String displayOption;
/**
* This method returns the CLPSettingData.displayOption property value. This property is described as follows:
*
* Establishes the default value for the display option. The argument string is stored "as-is" without normalization beyond capitalization. The
* argument string is compliant with the SM CLP command line grammar.
*
* @return String current displayOption property value
* @exception Exception
*/
public String getDisplayOption() {
return this.displayOption;
} // getDisplayOption
/**
* This method sets the CLPSettingData.displayOption property value. This property is described as follows:
*
* Establishes the default value for the display option. The argument string is stored "as-is" without normalization beyond capitalization. The
* argument string is compliant with the SM CLP command line grammar.
*
* @param String
* new displayOption property value
* @exception Exception
*/
public void setDisplayOption(String displayOption) {
this.displayOption = displayOption;
} // setDisplayOption
} // Class CLPSettingData