Package com.onenetwork.platform.common

Class DocumentType

java.lang.Object
com.onenetwork.platform.common.Model
com.onenetwork.platform.common.DocumentType
All Implemented Interfaces:
Model, java.io.Serializable
public class DocumentType
extends com.onenetwork.platform.common.Model
implements java.io.Serializable
Represents a type of document which is associated to a "parent" transaction (like a Shipment or Order), and is either generated on-demand, or uploaded and attached by a user's action or a server process.

Java class for DocumentType complex type.

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

 <complexType name="DocumentType">
   <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="SourceModel" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="DocumentCategory" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="Name" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="OrganizationName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="OrganizationEnterpriseName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="PayloadType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="GeneratorAction" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="LabelType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Format" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SupportMultiple" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="Extension" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="IsDefaultChecked" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="DevicePrintOrder" type="{http://www.onenetwork.com/Platform}NullableInteger" minOccurs="0"/>
         <element name="PrintOrder" type="{http://www.onenetwork.com/Platform}NullableInteger" minOccurs="0"/>
         <element name="PermissionHandler" 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

    • actionExecTime

      protected java.util.Calendar actionExecTime

    • actionName

      protected java.lang.String actionName

    • inputRefId

      protected java.lang.String inputRefId

    • error

      protected StatusMessage error

    • creationUser

      protected java.lang.String creationUser

    • creationDate

      protected java.util.Calendar creationDate

    • lastModifiedUser

      protected java.lang.String lastModifiedUser

    • lastModifiedDate

      protected java.util.Calendar lastModifiedDate

    • levelModifiedDate

      protected java.util.Calendar levelModifiedDate

    • valueChainId

      protected long valueChainId

    • sourceModel

      protected java.lang.String sourceModel

    • documentCategory

      protected java.lang.String documentCategory

    • name

      protected java.lang.String name

    • organizationName

      protected java.lang.String organizationName

    • organizationEnterpriseName

      protected java.lang.String organizationEnterpriseName

    • description

      protected java.lang.String description

    • payloadType

      protected java.lang.String payloadType

    • generatorAction

      protected java.lang.String generatorAction

    • labelType

      protected java.lang.String labelType

    • format

      protected java.lang.String format

    • supportMultiple

      protected java.lang.Boolean supportMultiple

    • extension

      protected java.lang.String extension

    • isDefaultChecked

      protected java.lang.Boolean isDefaultChecked

    • devicePrintOrder

      protected java.lang.Integer devicePrintOrder

    • printOrder

      protected java.lang.Integer printOrder

    • permissionHandler

      protected java.lang.String permissionHandler

    • udfs

      protected com.onenetwork.platform.common.NameValuePairList udfs

    • issues

      protected java.util.List<Issue> issues

    • mdFsList

      protected java.util.List<javax.xml.bind.JAXBElement<? extends com.onenetwork.platform.common.MDFs>> mdFsList

    • attributes

      protected java.util.List<AttributeValue> attributes

    • MODEL_TYPE

      public static final com.onenetwork.platform.data.model.impl.ModelType MODEL_TYPE
      Constant reference to the ModelType for this JAXB.

    • MODEL_LEVEL_TYPE

      public static final com.onenetwork.platform.data.model.impl.ModelLevelType MODEL_LEVEL_TYPE
      Constant reference to the ModelLevelType for this JAXB.

    • STANDARD_MODEL_NAME

      public static final java.lang.String STANDARD_MODEL_NAME
      Constant reference to the standard model name for this JAXB.

    • sysOrganizationId

      protected java.lang.Long sysOrganizationId

  • Constructor Details

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

    • getSourceModel

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

    • setSourceModel

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

    • isSetSourceModel

      public boolean isSetSourceModel()

    • getDocumentCategory

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

    • setDocumentCategory

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

    • isSetDocumentCategory

      public boolean isSetDocumentCategory()

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

    • getOrganizationName

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

    • isSetOrganizationName

      public boolean isSetOrganizationName()

    • getOrganizationEnterpriseName

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

    • isSetOrganizationEnterpriseName

      public boolean isSetOrganizationEnterpriseName()

    • getDescription

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

    • setDescription

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

    • isSetDescription

      public boolean isSetDescription()

    • getPayloadType

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

    • setPayloadType

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

    • isSetPayloadType

      public boolean isSetPayloadType()

    • getGeneratorAction

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

    • setGeneratorAction

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

    • isSetGeneratorAction

      public boolean isSetGeneratorAction()

    • getLabelType

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

    • setLabelType

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

    • isSetLabelType

      public boolean isSetLabelType()

    • getFormat

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

    • setFormat

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

    • isSetFormat

      public boolean isSetFormat()

    • setSupportMultiple

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

    • isSetSupportMultiple

      public boolean isSetSupportMultiple()

    • getExtension

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

    • setExtension

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

    • isSetExtension

      public boolean isSetExtension()

    • setIsDefaultChecked

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

    • isSetIsDefaultChecked

      public boolean isSetIsDefaultChecked()

    • setDevicePrintOrder

      public void setDevicePrintOrder​(int value)
      Sets the value of the devicePrintOrder property.
      Parameters:
      value - allowed object is String

    • isSetDevicePrintOrder

      public boolean isSetDevicePrintOrder()

    • setPrintOrder

      public void setPrintOrder​(int value)
      Sets the value of the printOrder property.
      Parameters:
      value - allowed object is String

    • isSetPrintOrder

      public boolean isSetPrintOrder()

    • getPermissionHandler

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

    • setPermissionHandler

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

    • isSetPermissionHandler

      public boolean isSetPermissionHandler()

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

    • setOrganizationName

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

    • setOrganizationEnterpriseName

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

    • isSupportMultiple

      public boolean isSupportMultiple()

    • unsetSupportMultiple

      public void unsetSupportMultiple()

    • isIsDefaultChecked

      public boolean isIsDefaultChecked()

    • unsetIsDefaultChecked

      public void unsetIsDefaultChecked()

    • getDevicePrintOrder

      public int getDevicePrintOrder()

    • unsetDevicePrintOrder

      public void unsetDevicePrintOrder()

    • getPrintOrder

      public int getPrintOrder()

    • unsetPrintOrder

      public void unsetPrintOrder()

    • 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

    • 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: organizationName, organizationEnterpriseName

    • 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: organizationName, organizationEnterpriseName. 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 (organizationName, organizationEnterpriseName), 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