Package com.onenetwork.platform.common

Class Role

java.lang.Object
com.onenetwork.platform.common.Model
com.onenetwork.platform.common.Role
All Implemented Interfaces:
Model, java.io.Serializable
public class Role
extends com.onenetwork.platform.common.Model
implements java.io.Serializable
Each User in the system can play one or more Roles. A Role has a set of permissions attached to it which determine what operations the User can execute while playing that Role. Note that a Role is distinct from a Role Type. For example you might have a Role Type "Transportation Manager", but separate Roles for Company A and Company B, both of which are of type Transportation Manager.

Java class for Role complex type.

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

 <complexType name="Role">
   <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="Name" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="ValueChainId" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="EnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="OrganizationName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SiteName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="TypeName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="LastModifiedDate" type="{http://www.onenetwork.com/Platform}DateTime" minOccurs="0"/>
         <element name="LastModifiedUser" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Active" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="LastComputedDate" type="{http://www.onenetwork.com/Platform}DateTime" 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="OrgHierarchyForReadName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="OrgHierarchyForReadEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="OrgHierarchyForWriteName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="OrgHierarchyForWriteEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationTemplateName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationTemplateBaseTemplateName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationTemplateBaseTemplateLevelType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationTemplateOwningOrgName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationTemplateOwningOrgEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationTemplateOwningUserName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreationTemplateOwningUserEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" 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

    • Role

      public Role()

  • 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()

    • getName

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

    • setName

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

    • isSetName

      public boolean isSetName()

    • 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()

    • getEnterpriseName

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

    • isSetEnterpriseName

      public boolean isSetEnterpriseName()

    • getOrganizationName

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

    • isSetOrganizationName

      public boolean isSetOrganizationName()

    • getSiteName

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

    • isSetSiteName

      public boolean isSetSiteName()

    • getTypeName

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

    • setTypeName

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

    • isSetTypeName

      public boolean isSetTypeName()

    • 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()

    • 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()

    • setActive

      public void setActive​(boolean value)
      Sets the value of the active property.
      Parameters:
      value - allowed object is Boolean

    • isSetActive

      public boolean isSetActive()

    • getLastComputedDate

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

    • setLastComputedDate

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

    • isSetLastComputedDate

      public boolean isSetLastComputedDate()

    • 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()

    • getOrgHierarchyForReadName

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

    • isSetOrgHierarchyForReadName

      public boolean isSetOrgHierarchyForReadName()

    • getOrgHierarchyForReadEnterpriseName

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

    • isSetOrgHierarchyForReadEnterpriseName

      public boolean isSetOrgHierarchyForReadEnterpriseName()

    • getOrgHierarchyForWriteName

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

    • isSetOrgHierarchyForWriteName

      public boolean isSetOrgHierarchyForWriteName()

    • getOrgHierarchyForWriteEnterpriseName

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

    • isSetOrgHierarchyForWriteEnterpriseName

      public boolean isSetOrgHierarchyForWriteEnterpriseName()

    • getCreationTemplateName

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

    • isSetCreationTemplateName

      public boolean isSetCreationTemplateName()

    • getCreationTemplateBaseTemplateName

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

    • isSetCreationTemplateBaseTemplateName

      public boolean isSetCreationTemplateBaseTemplateName()

    • getCreationTemplateBaseTemplateLevelType

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

    • isSetCreationTemplateBaseTemplateLevelType

      public boolean isSetCreationTemplateBaseTemplateLevelType()

    • getCreationTemplateOwningOrgName

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

    • isSetCreationTemplateOwningOrgName

      public boolean isSetCreationTemplateOwningOrgName()

    • getCreationTemplateOwningOrgEnterpriseName

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

    • isSetCreationTemplateOwningOrgEnterpriseName

      public boolean isSetCreationTemplateOwningOrgEnterpriseName()

    • getCreationTemplateOwningUserName

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

    • isSetCreationTemplateOwningUserName

      public boolean isSetCreationTemplateOwningUserName()

    • getCreationTemplateOwningUserEnterpriseName

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

    • isSetCreationTemplateOwningUserEnterpriseName

      public boolean isSetCreationTemplateOwningUserEnterpriseName()

    • 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()

    • setEnterpriseName

      public void setEnterpriseName​(java.lang.String value)
      Sets the value of EnterpriseName, and also nullifies the following surrogate ids: SysEnterpriseId, SysOrganizationId, SysRoleSiteId. 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 EnterpriseName - the following will also be nullified: SysEnterpriseId, SysOrganizationId, SysRoleSiteId

    • setOrganizationName

      public void setOrganizationName​(java.lang.String value)
      Sets the value of OrganizationName, and also nullifies the following surrogate ids: SysOrganizationId, SysRoleSiteId. 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 OrganizationName - the following will also be nullified: SysOrganizationId, SysRoleSiteId

    • setSiteName

      public void setSiteName​(java.lang.String value)
      Sets the value of SiteName, and also nullifies the following surrogate ids: SysRoleSiteId. 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 SiteName - the following will also be nullified: SysRoleSiteId

    • setOrgHierarchyForReadName

      public void setOrgHierarchyForReadName​(java.lang.String value)
      Sets the value of OrgHierarchyForReadName, and also nullifies the following surrogate ids: SysOrgHierarchyForReadId. 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 OrgHierarchyForReadName - the following will also be nullified: SysOrgHierarchyForReadId

    • setOrgHierarchyForReadEnterpriseName

      public void setOrgHierarchyForReadEnterpriseName​(java.lang.String value)
      Sets the value of OrgHierarchyForReadEnterpriseName, and also nullifies the following surrogate ids: SysOrgHierarchyForReadId. 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 OrgHierarchyForReadEnterpriseName - the following will also be nullified: SysOrgHierarchyForReadId

    • setOrgHierarchyForWriteName

      public void setOrgHierarchyForWriteName​(java.lang.String value)
      Sets the value of OrgHierarchyForWriteName, and also nullifies the following surrogate ids: SysOrgHierarchyForWriteId. 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 OrgHierarchyForWriteName - the following will also be nullified: SysOrgHierarchyForWriteId

    • setOrgHierarchyForWriteEnterpriseName

      public void setOrgHierarchyForWriteEnterpriseName​(java.lang.String value)
      Sets the value of OrgHierarchyForWriteEnterpriseName, and also nullifies the following surrogate ids: SysOrgHierarchyForWriteId. 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 OrgHierarchyForWriteEnterpriseName - the following will also be nullified: SysOrgHierarchyForWriteId

    • setCreationTemplateName

      public void setCreationTemplateName​(java.lang.String value)
      Sets the value of CreationTemplateName, and also nullifies the following surrogate ids: SysCreationTemplateId. 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 CreationTemplateName - the following will also be nullified: SysCreationTemplateId

    • setCreationTemplateBaseTemplateName

      public void setCreationTemplateBaseTemplateName​(java.lang.String value)
      Sets the value of CreationTemplateBaseTemplateName, and also nullifies the following surrogate ids: SysCreationTemplateId. 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 CreationTemplateBaseTemplateName - the following will also be nullified: SysCreationTemplateId

    • setCreationTemplateBaseTemplateLevelType

      public void setCreationTemplateBaseTemplateLevelType​(java.lang.String value)
      Sets the value of CreationTemplateBaseTemplateLevelType, and also nullifies the following surrogate ids: SysCreationTemplateId. 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 CreationTemplateBaseTemplateLevelType - the following will also be nullified: SysCreationTemplateId

    • setCreationTemplateOwningOrgName

      public void setCreationTemplateOwningOrgName​(java.lang.String value)
      Sets the value of CreationTemplateOwningOrgName, and also nullifies the following surrogate ids: SysCreationTemplateId. 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 CreationTemplateOwningOrgName - the following will also be nullified: SysCreationTemplateId

    • setCreationTemplateOwningOrgEnterpriseName

      public void setCreationTemplateOwningOrgEnterpriseName​(java.lang.String value)
      Sets the value of CreationTemplateOwningOrgEnterpriseName, and also nullifies the following surrogate ids: SysCreationTemplateId. 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 CreationTemplateOwningOrgEnterpriseName - the following will also be nullified: SysCreationTemplateId

    • setCreationTemplateOwningUserName

      public void setCreationTemplateOwningUserName​(java.lang.String value)
      Sets the value of CreationTemplateOwningUserName, and also nullifies the following surrogate ids: SysCreationTemplateId. 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 CreationTemplateOwningUserName - the following will also be nullified: SysCreationTemplateId

    • setCreationTemplateOwningUserEnterpriseName

      public void setCreationTemplateOwningUserEnterpriseName​(java.lang.String value)
      Sets the value of CreationTemplateOwningUserEnterpriseName, and also nullifies the following surrogate ids: SysCreationTemplateId. 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 CreationTemplateOwningUserEnterpriseName - the following will also be nullified: SysCreationTemplateId

    • isActive

      public boolean isActive()

    • unsetActive

      public void unsetActive()

    • 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

    • getSysEnterpriseId

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

    • setSysEnterpriseId

      public void setSysEnterpriseId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysEnterpriseId. 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: enterpriseName. 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 SysEnterpriseId
      nullifyNaturalKeys - true to nullify the related natural keys (enterpriseName), 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

    • getSysOrganizationId

      public java.lang.Long getSysOrganizationId()
      Returns the surrogate id value for SysOrganizationId. After reading a model, this will always match with the corresponding natural keys, which are: enterpriseName, organizationName

    • setSysOrganizationId

      public void setSysOrganizationId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysOrganizationId. 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: enterpriseName, organizationName. 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 SysOrganizationId
      nullifyNaturalKeys - true to nullify the related natural keys (enterpriseName, organizationName), 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

    • getSysRoleSiteId

      public java.lang.Long getSysRoleSiteId()
      Returns the surrogate id value for SysRoleSiteId. After reading a model, this will always match with the corresponding natural keys, which are: enterpriseName, organizationName, siteName

    • setSysRoleSiteId

      public void setSysRoleSiteId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysRoleSiteId. 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: enterpriseName, organizationName, siteName. 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 SysRoleSiteId
      nullifyNaturalKeys - true to nullify the related natural keys (enterpriseName, organizationName, siteName), 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

    • getSysOrgHierarchyForReadId

      public java.lang.Long getSysOrgHierarchyForReadId()
      Returns the surrogate id value for SysOrgHierarchyForReadId. After reading a model, this will always match with the corresponding natural keys, which are: orgHierarchyForReadName, orgHierarchyForReadEnterpriseName

    • setSysOrgHierarchyForReadId

      public void setSysOrgHierarchyForReadId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysOrgHierarchyForReadId. 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: orgHierarchyForReadName, orgHierarchyForReadEnterpriseName. 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 SysOrgHierarchyForReadId
      nullifyNaturalKeys - true to nullify the related natural keys (orgHierarchyForReadName, orgHierarchyForReadEnterpriseName), 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

    • getSysOrgHierarchyForWriteId

      public java.lang.Long getSysOrgHierarchyForWriteId()
      Returns the surrogate id value for SysOrgHierarchyForWriteId. After reading a model, this will always match with the corresponding natural keys, which are: orgHierarchyForWriteName, orgHierarchyForWriteEnterpriseName

    • setSysOrgHierarchyForWriteId

      public void setSysOrgHierarchyForWriteId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysOrgHierarchyForWriteId. 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: orgHierarchyForWriteName, orgHierarchyForWriteEnterpriseName. 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 SysOrgHierarchyForWriteId
      nullifyNaturalKeys - true to nullify the related natural keys (orgHierarchyForWriteName, orgHierarchyForWriteEnterpriseName), 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

    • getSysCreationTemplateId

      public java.lang.Long getSysCreationTemplateId()
      Returns the surrogate id value for SysCreationTemplateId. After reading a model, this will always match with the corresponding natural keys, which are: creationTemplateName, creationTemplateBaseTemplateName, creationTemplateBaseTemplateLevelType, creationTemplateOwningOrgName, creationTemplateOwningOrgEnterpriseName, creationTemplateOwningUserName, creationTemplateOwningUserEnterpriseName

    • setSysCreationTemplateId

      public void setSysCreationTemplateId​(java.lang.Long value, boolean nullifyNaturalKeys)
      Sets the surrogate id value for SysCreationTemplateId. 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: creationTemplateName, creationTemplateBaseTemplateName, creationTemplateBaseTemplateLevelType, creationTemplateOwningOrgName, creationTemplateOwningOrgEnterpriseName, creationTemplateOwningUserName, creationTemplateOwningUserEnterpriseName. 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 SysCreationTemplateId
      nullifyNaturalKeys - true to nullify the related natural keys (creationTemplateName, creationTemplateBaseTemplateName, creationTemplateBaseTemplateLevelType, creationTemplateOwningOrgName, creationTemplateOwningOrgEnterpriseName, creationTemplateOwningUserName, creationTemplateOwningUserEnterpriseName), 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