Package com.onenetwork.platform.common

Class KPI

java.lang.Object
com.onenetwork.platform.common.Model
com.onenetwork.platform.common.KPI
All Implemented Interfaces:
Model, java.io.Serializable
public class KPI
extends com.onenetwork.platform.common.Model
implements java.io.Serializable
Stores a computed KPI value.

Java class for KPI complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="KPI">
   <complexContent>
     <extension base="{http://www.onenetwork.com/Platform}Model">
       <sequence>
         <element name="ActionExecTime" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="ActionName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="InputRefId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Error" type="{http://www.onenetwork.com/Platform}Error" minOccurs="0"/>
         <element name="CreationUser" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="LastModifiedUser" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="LastModifiedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="LevelModifiedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="ValueChainId" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="KPIDefName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="KPIDefOwningEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="KPIDefOwningUserName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="KPIDefOwningUserEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Value" type="{http://www.onenetwork.com/Platform}NullableDouble" minOccurs="0"/>
         <element name="DateComputed" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="ComputedByName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ComputedByEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="BucketStartDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="KPIHistory" type="{http://www.onenetwork.com/Platform}KPIHistory" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Udfs" type="{http://www.onenetwork.com/Platform}NameValuePairList" minOccurs="0"/>
         <element name="Issue" type="{http://www.onenetwork.com/Platform}Issue" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.onenetwork.com/Platform}MDFs" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Attribute" type="{http://www.onenetwork.com/Platform}AttributeValue" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:
Serialized Form

  • Field Details

  • Constructor Details

    • KPI

      public KPI()

  • Method Details

    • getActionExecTime

      public java.util.Calendar getActionExecTime()
      Gets the value of the actionExecTime property.
      Returns:
      possible object is String

    • setActionExecTime

      public void setActionExecTime​(java.util.Calendar value)
      Sets the value of the actionExecTime property.
      Parameters:
      value - allowed object is String

    • isSetActionExecTime

      public boolean isSetActionExecTime()

    • getActionName

      public java.lang.String getActionName()
      Gets the value of the actionName property.
      Overrides:
      getActionName in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setActionName

      public void setActionName​(java.lang.String value)
      Sets the value of the actionName property.
      Overrides:
      setActionName in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetActionName

      public boolean isSetActionName()

    • getInputRefId

      public java.lang.String getInputRefId()
      Gets the value of the inputRefId property.
      Returns:
      possible object is String

    • setInputRefId

      public void setInputRefId​(java.lang.String value)
      Sets the value of the inputRefId property.
      Parameters:
      value - allowed object is String

    • isSetInputRefId

      public boolean isSetInputRefId()

    • getError

      public StatusMessage getError()
      Gets the value of the error property.
      Specified by:
      getError in interface Model
      Overrides:
      getError in class com.onenetwork.platform.common.Model
      Returns:
      possible object is ErrorDef

    • setError

      public void setError​(StatusMessage value)
      Sets the value of the error property.
      Specified by:
      setError in interface Model
      Overrides:
      setError in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is ErrorDef

    • isSetError

      public boolean isSetError()

    • getCreationUser

      public java.lang.String getCreationUser()
      Gets the value of the creationUser property.
      Returns:
      possible object is String

    • setCreationUser

      public void setCreationUser​(java.lang.String value)
      Sets the value of the creationUser property.
      Parameters:
      value - allowed object is String

    • isSetCreationUser

      public boolean isSetCreationUser()

    • getCreationDate

      public java.util.Calendar getCreationDate()
      Gets the value of the creationDate property.
      Returns:
      possible object is String

    • setCreationDate

      public void setCreationDate​(java.util.Calendar value)
      Sets the value of the creationDate property.
      Parameters:
      value - allowed object is String

    • isSetCreationDate

      public boolean isSetCreationDate()

    • getLastModifiedUser

      public java.lang.String getLastModifiedUser()
      Gets the value of the lastModifiedUser property.
      Specified by:
      getLastModifiedUser in interface Model
      Overrides:
      getLastModifiedUser in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setLastModifiedUser

      public void setLastModifiedUser​(java.lang.String value)
      Sets the value of the lastModifiedUser property.
      Specified by:
      setLastModifiedUser in interface Model
      Overrides:
      setLastModifiedUser in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetLastModifiedUser

      public boolean isSetLastModifiedUser()

    • getLastModifiedDate

      public java.util.Calendar getLastModifiedDate()
      Gets the value of the lastModifiedDate property.
      Specified by:
      getLastModifiedDate in interface Model
      Overrides:
      getLastModifiedDate in class com.onenetwork.platform.common.Model
      Returns:
      possible object is String

    • setLastModifiedDate

      public void setLastModifiedDate​(java.util.Calendar value)
      Sets the value of the lastModifiedDate property.
      Specified by:
      setLastModifiedDate in interface Model
      Overrides:
      setLastModifiedDate in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is String

    • isSetLastModifiedDate

      public boolean isSetLastModifiedDate()

    • getLevelModifiedDate

      public java.util.Calendar getLevelModifiedDate()
      Gets the value of the levelModifiedDate property.
      Returns:
      possible object is String

    • setLevelModifiedDate

      public void setLevelModifiedDate​(java.util.Calendar value)
      Sets the value of the levelModifiedDate property.
      Parameters:
      value - allowed object is String

    • isSetLevelModifiedDate

      public boolean isSetLevelModifiedDate()

    • getValueChainId

      public long getValueChainId()
      Gets the value of the valueChainId property.

    • setValueChainId

      public void setValueChainId​(long value)
      Sets the value of the valueChainId property.

    • isSetValueChainId

      public boolean isSetValueChainId()

    • getKPIDefName

      public java.lang.String getKPIDefName()
      Gets the value of the kpiDefName property.
      Returns:
      possible object is String

    • setKPIDefName

      public void setKPIDefName​(java.lang.String value)
      Sets the value of the kpiDefName property.
      Parameters:
      value - allowed object is String

    • isSetKPIDefName

      public boolean isSetKPIDefName()

    • getKPIDefOwningEnterpriseName

      public java.lang.String getKPIDefOwningEnterpriseName()
      Gets the value of the kpiDefOwningEnterpriseName property.
      Returns:
      possible object is String

    • setKPIDefOwningEnterpriseName

      public void setKPIDefOwningEnterpriseName​(java.lang.String value)
      Sets the value of the kpiDefOwningEnterpriseName property.
      Parameters:
      value - allowed object is String

    • isSetKPIDefOwningEnterpriseName

      public boolean isSetKPIDefOwningEnterpriseName()

    • getKPIDefOwningUserName

      public java.lang.String getKPIDefOwningUserName()
      Gets the value of the kpiDefOwningUserName property.
      Returns:
      possible object is String

    • setKPIDefOwningUserName

      public void setKPIDefOwningUserName​(java.lang.String value)
      Sets the value of the kpiDefOwningUserName property.
      Parameters:
      value - allowed object is String

    • isSetKPIDefOwningUserName

      public boolean isSetKPIDefOwningUserName()

    • getKPIDefOwningUserEnterpriseName

      public java.lang.String getKPIDefOwningUserEnterpriseName()
      Gets the value of the kpiDefOwningUserEnterpriseName property.
      Returns:
      possible object is String

    • setKPIDefOwningUserEnterpriseName

      public void setKPIDefOwningUserEnterpriseName​(java.lang.String value)
      Sets the value of the kpiDefOwningUserEnterpriseName property.
      Parameters:
      value - allowed object is String

    • isSetKPIDefOwningUserEnterpriseName

      public boolean isSetKPIDefOwningUserEnterpriseName()

    • setValue

      public void setValue​(double value)
      Sets the value of the value property.
      Parameters:
      value - allowed object is String

    • isSetValue

      public boolean isSetValue()

    • getDateComputed

      public java.util.Calendar getDateComputed()
      Gets the value of the dateComputed property.
      Returns:
      possible object is String

    • setDateComputed

      public void setDateComputed​(java.util.Calendar value)
      Sets the value of the dateComputed property.
      Parameters:
      value - allowed object is String

    • isSetDateComputed

      public boolean isSetDateComputed()

    • getComputedByName

      public java.lang.String getComputedByName()
      Gets the value of the computedByName property.
      Returns:
      possible object is String

    • isSetComputedByName

      public boolean isSetComputedByName()

    • getComputedByEnterpriseName

      public java.lang.String getComputedByEnterpriseName()
      Gets the value of the computedByEnterpriseName property.
      Returns:
      possible object is String

    • isSetComputedByEnterpriseName

      public boolean isSetComputedByEnterpriseName()

    • getBucketStartDate

      public java.util.Calendar getBucketStartDate()
      Gets the value of the bucketStartDate property.
      Returns:
      possible object is String

    • setBucketStartDate

      public void setBucketStartDate​(java.util.Calendar value)
      Sets the value of the bucketStartDate property.
      Parameters:
      value - allowed object is String

    • isSetBucketStartDate

      public boolean isSetBucketStartDate()

    • getKPIHistorys

      public java.util.List<KPIHistory> getKPIHistorys()
      Gets the value of the kpiHistorys property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the kpiHistorys property.

      For example, to add a new item, do as follows: 

          getKPIHistorys().add(newItem);

      Objects of the following type(s) are allowed in the list KPIHistory

    • isSetKPIHistorys

      public boolean isSetKPIHistorys()

    • unsetKPIHistorys

      public void unsetKPIHistorys()

    • getUdfs

      public com.onenetwork.platform.common.NameValuePairList getUdfs()
      Gets the value of the udfs property.
      Overrides:
      getUdfs in class com.onenetwork.platform.common.Model
      Returns:
      possible object is NameValuePairList

    • setUdfs

      public void setUdfs​(com.onenetwork.platform.common.NameValuePairList value)
      Sets the value of the udfs property.
      Overrides:
      setUdfs in class com.onenetwork.platform.common.Model
      Parameters:
      value - allowed object is NameValuePairList

    • isSetUdfs

      public boolean isSetUdfs()
      Overrides:
      isSetUdfs in class com.onenetwork.platform.common.Model

    • getIssues

      public java.util.List<Issue> getIssues()
      Gets the value of the issues property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the issues property.

      For example, to add a new item, do as follows: 

          getIssues().add(newItem);

      Objects of the following type(s) are allowed in the list Issue

    • isSetIssues

      public boolean isSetIssues()

    • unsetIssues

      public void unsetIssues()

    • getMDFsList

      public java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> getMDFsList()
      Gets the value of the mdFsList property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the mdFsList property.

      For example, to add a new item, do as follows: 

          getMDFsList().add(newItem);

      Objects of the following type(s) are allowed in the list JAXBElement<DummyMDFs> JAXBElement<MDFs>

      Overrides:
      getMDFsList in class com.onenetwork.platform.common.Model

    • isSetMDFsList

      public boolean isSetMDFsList()

    • unsetMDFsList

      public void unsetMDFsList()

    • getAttributes

      public java.util.List<AttributeValue> getAttributes()
      Gets the value of the attributes property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the attributes property.

      For example, to add a new item, do as follows: 

          getAttributes().add(newItem);

      Objects of the following type(s) are allowed in the list AttributeValue

      Overrides:
      getAttributes in class com.onenetwork.platform.common.Model

    • isSetAttributes

      public boolean isSetAttributes()

    • unsetAttributes

      public void unsetAttributes()

    • setComputedByName

      public void setComputedByName​(java.lang.String value)
      Sets the value of ComputedByName, and also nullifies the following surrogate ids: SysComputedById. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for ComputedByName - the following will also be nullified: SysComputedById

    • setComputedByEnterpriseName

      public void setComputedByEnterpriseName​(java.lang.String value)
      Sets the value of ComputedByEnterpriseName, and also nullifies the following surrogate ids: SysComputedById. This nullification is done to ensure that a client can set either natural keys or sys id as desired. If you as a client wish to populate *both* natural and surrogate ids, you should set the natural keys first, then set the surrogate ids passing 'false' as the second parameter
      Parameters:
      value - new value for ComputedByEnterpriseName - the following will also be nullified: SysComputedById

    • getValue

      public double getValue()

    • unsetValue

      public void unsetValue()

    • issueOn

      public com.onenetwork.platform.common.Issue issueOn​(java.lang.String issueName, IssueSeverity issueSeverity)
      Utility method to create an issue and set it on JAXB

    • issueOff

      public com.onenetwork.platform.common.Issue issueOff​(java.lang.String issueName)
      Utility method to create an issue and set it on JAXB

    • equals

      public boolean equals​(java.lang.Object obj)
      Description copied from interface: Model
      A Model object is considered "equal" to another Model object if it is a Model of the same type and its Natural Key fields are identical.
      Specified by:
      equals in interface Model
      Overrides:
      equals in class java.lang.Object
      Parameters:
      obj - object to compare
      Returns:
      true if the object is the same type of Model with identical Natural Key fields

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • internalToString

      protected java.lang.String internalToString()
      Overrides:
      internalToString in class com.onenetwork.platform.common.Model

    • toStrContrib

      public java.lang.String toStrContrib()
      Not intended for use by Clients

    • getModelType

      public com.onenetwork.platform.data.model.impl.ModelType getModelType()
      methods to get ModelType for this JAXB.
      Overrides:
      getModelType in class com.onenetwork.platform.common.Model

    • getModelLevelType

      public com.onenetwork.platform.data.model.impl.ModelLevelType getModelLevelType()
      methods to get ModelLevelType for this JAXB.
      Overrides:
      getModelLevelType in class com.onenetwork.platform.common.Model

    • getStandardModelName

      public java.lang.String getStandardModelName()
      method to get standard model name for this JAXB.
      Overrides:
      getStandardModelName in class com.onenetwork.platform.common.Model

    • getSysKPIDefId

      public java.lang.Long getSysKPIDefId()
      Returns the surrogate id value for SysKPIDefId. After reading a model, this will always match with the corresponding natural keys, which are: kpiDefName, kpiDefOwningEnterpriseName, kpiDefOwningUserName, kpiDefOwningUserEnterpriseName

    • setSysKPIDefId

      public void setSysKPIDefId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysKPIDefId. As a client, when you want to update the model in the database, you may set values either by natural key or by sys id, or by both. Calling this method with 'true' will nullify the natural keys for this surrogate key: kpiDefName, kpiDefOwningEnterpriseName, kpiDefOwningUserName, kpiDefOwningUserEnterpriseName. This ensures the values don't conflict. If you are 'populating' an object and want to set both natural and surrogate keys, you should set the natural keys first, then call this method with 'false' for nullifyNaturalKeys.
      Parameters:
      value - new value for SysKPIDefId
      nullifyNaturalKeys - true to nullify the related natural keys (kpiDefName, kpiDefOwningEnterpriseName, kpiDefOwningUserName, kpiDefOwningUserEnterpriseName), or false to leave as is - please note that you can pass either surrogate id or natural keys to the server write API, or both

    • getSysComputedById

      public java.lang.Long getSysComputedById()
      Returns the surrogate id value for SysComputedById. After reading a model, this will always match with the corresponding natural keys, which are: computedByName, computedByEnterpriseName

    • setSysComputedById

      public void setSysComputedById​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysComputedById. As a client, when you want to update the model in the database, you may set values either by natural key or by sys id, or by both. Calling this method with 'true' will nullify the natural keys for this surrogate key: computedByName, computedByEnterpriseName. This ensures the values don't conflict. If you are 'populating' an object and want to set both natural and surrogate keys, you should set the natural keys first, then call this method with 'false' for nullifyNaturalKeys.
      Parameters:
      value - new value for SysComputedById
      nullifyNaturalKeys - true to nullify the related natural keys (computedByName, computedByEnterpriseName), or false to leave as is - please note that you can pass either surrogate id or natural keys to the server write API, or both