FreeFormEffectivePeriodType (ph-ubltr 6.4.2 API)

java.lang.Object
- tr.gov.efatura.useraccount.FreeFormEffectivePeriodType

All Implemented Interfaces:: com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class FreeFormEffectivePeriodType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

 <?xml version="1.0" encoding="UTF-8"?><ccts:CategoryCode xmlns:ccts="urn:un:unece:uncefact:documentation:1.1" xmlns="http://www.hr-xml.org/3" xmlns:oa="http://www.openapplications.org/oagis/9" xmlns:xsd="http://www.w3.org/2001/XMLSchema">ABIE</ccts:CategoryCode>

 <?xml version="1.0" encoding="UTF-8"?><ccts:DictionaryEntryName xmlns:ccts="urn:un:unece:uncefact:documentation:1.1" xmlns="http://www.hr-xml.org/3" xmlns:oa="http://www.openapplications.org/oagis/9" xmlns:xsd="http://www.w3.org/2001/XMLSchema">Effective Date Period. Details</ccts:DictionaryEntryName>

 <?xml version="1.0" encoding="UTF-8"?><ccts:DefinitionText xmlns:ccts="urn:un:unece:uncefact:documentation:1.1" xmlns="http://www.hr-xml.org/3" xmlns:oa="http://www.openapplications.org/oagis/9" xmlns:xsd="http://www.w3.org/2001/XMLSchema">Indicates
                                        the date period in which the associated component is effective. Based on the
                                        same TimePeriodType UN/CEFACT ABIE (except start date is optional). The
                                        xsd:choice between an EndDate and Duration also was removed for processing
                                        simplicity. Generally, an EndDate or Duration would appear, but not both. This
                                        usage rule is not enforced by the schema.</ccts:DefinitionText>

 <?xml version="1.0" encoding="UTF-8"?><ccts:UsageRule xmlns:ccts="urn:un:unece:uncefact:documentation:1.1" xmlns="http://www.hr-xml.org/3" xmlns:oa="http://www.openapplications.org/oagis/9" xmlns:xsd="http://www.w3.org/2001/XMLSchema">FreeFormEffectivePeriod also has effective dating attributes. </ccts:UsageRule>

Java class for FreeFormEffectivePeriodType complex type.

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

 <complexType name="FreeFormEffectivePeriodType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.hr-xml.org/3}StartDate" minOccurs="0"/>
         <element ref="{http://www.hr-xml.org/3}EndDate" minOccurs="0"/>
         <element ref="{http://www.openapplications.org/oagis/9}Duration" minOccurs="0"/>
       </sequence>
       <attGroup ref="{http://www.hr-xml.org/3}EffectiveDateAttributeGroup"/>
     </restriction>
   </complexContent>
 </complexType>

This class was annotated by ph-jaxb22-plugin -Xph-annotate

This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode

This class contains methods created by ph-jaxb22-plugin -Xph-tostring

This class contains methods created by ph-jaxb22-plugin -Xph-list-extension

This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2

This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

FreeFormEffectivePeriodType()
Default constructor
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Constructors
Constructor and Description
`FreeFormEffectivePeriodType()` Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValidFrom(String elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`addValidTo(String elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`FreeFormEffectivePeriodType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(FreeFormEffectivePeriodType ret)` This method clones all values from `this` to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`Duration`	`getDuration()` Gets the value of the duration property.
`FreeFormDateType`	`getEndDate()` Gets the value of the endDate property.
`FreeFormDateType`	`getStartDate()` Gets the value of the startDate property.
`List<String>`	`getValidFrom()` Gets the value of the validFrom property.
`String`	`getValidFromAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getValidFromCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`List<String>`	`getValidTo()` Gets the value of the validTo property.
`String`	`getValidToAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getValidToCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoValidFromEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoValidToEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasValidFromEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasValidToEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setDuration(Duration value)` Sets the value of the duration property.
`void`	`setEndDate(FreeFormDateType value)` Sets the value of the endDate property.
`void`	`setStartDate(FreeFormDateType value)` Sets the value of the startDate property.
`void`	`setValidFrom(List<String> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setValidTo(List<String> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`String`	`toString()` Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FreeFormEffectivePeriodType
```
public FreeFormEffectivePeriodType()
```
    Default constructor
    Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
  - getStartDate
```
@Nullable
public FreeFormDateType getStartDate()
```
    Gets the value of the startDate property.
    
    Returns:
    
    possible object is FreeFormDateType
  - setStartDate
```
public void setStartDate(@Nullable
                         FreeFormDateType value)
```
    Sets the value of the startDate property.
    
    Parameters:
    
    value - allowed object is FreeFormDateType
  - getEndDate
```
@Nullable
public FreeFormDateType getEndDate()
```
    Gets the value of the endDate property.
    
    Returns:
    
    possible object is FreeFormDateType
  - setEndDate
```
public void setEndDate(@Nullable
                       FreeFormDateType value)
```
    Sets the value of the endDate property.
    
    Parameters:
    
    value - allowed object is FreeFormDateType
  - getDuration
```
@Nullable
public Duration getDuration()
```
    Gets the value of the duration property.
    
    Returns:
    
    possible object is Duration
  - setDuration
```
public void setDuration(@Nullable
                        Duration value)
```
    Sets the value of the duration property.
    
    Parameters:
    
    value - allowed object is Duration
  - getValidFrom
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<String> getValidFrom()
```
    Gets the value of the validFrom 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 validFrom property.
    For example, to add a new item, do as follows:
```
    getValidFrom().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getValidTo
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<String> getValidTo()
```
    Gets the value of the validTo 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 validTo property.
    For example, to add a new item, do as follows:
```
    getValidTo().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - equals
```
public boolean equals(Object o)
```
    Created by ph-jaxb22-plugin -Xph-equalshashcode
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Created by ph-jaxb22-plugin -Xph-equalshashcode
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Created by ph-jaxb22-plugin -Xph-tostring
    
    Overrides:
    
    toString in class Object
  - setValidFrom
```
public void setValidFrom(@Nullable
                         List<String> aList)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    aList - The new list member to set. May be null.
  - setValidTo
```
public void setValidTo(@Nullable
                       List<String> aList)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    aList - The new list member to set. May be null.
  - hasValidFromEntries
```
public boolean hasValidFromEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if at least one item is contained, false otherwise.
  - hasNoValidFromEntries
```
public boolean hasNoValidFromEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if no item is contained, false otherwise.
  - getValidFromCount
```
@Nonnegative
public int getValidFromCount()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    The number of contained elements. Always ≥ 0.
  - getValidFromAtIndex
```
@Nullable
public String getValidFromAtIndex(@Nonnegative
                                             int index)
                                      throws IndexOutOfBoundsException
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    index - The index to retrieve
    
    Returns:
    
    The element at the specified index. May be null
    
    Throws:
    
    IndexOutOfBoundsException - if the index is invalid!
  - addValidFrom
```
public void addValidFrom(@Nonnull
                         String elem)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    elem - The element to be added. May not be null.
  - hasValidToEntries
```
public boolean hasValidToEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if at least one item is contained, false otherwise.
  - hasNoValidToEntries
```
public boolean hasNoValidToEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if no item is contained, false otherwise.
  - getValidToCount
```
@Nonnegative
public int getValidToCount()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    The number of contained elements. Always ≥ 0.
  - getValidToAtIndex
```
@Nullable
public String getValidToAtIndex(@Nonnegative
                                           int index)
                                    throws IndexOutOfBoundsException
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    index - The index to retrieve
    
    Returns:
    
    The element at the specified index. May be null
    
    Throws:
    
    IndexOutOfBoundsException - if the index is invalid!
  - addValidTo
```
public void addValidTo(@Nonnull
                       String elem)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    elem - The element to be added. May not be null.
  - cloneTo
```
public void cloneTo(@Nonnull
                    FreeFormEffectivePeriodType ret)
```
    This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
    
    Parameters:
    
    ret - The target object to clone to. May not be null.
  - clone
```
@Nonnull
 @ReturnsMutableCopy
public FreeFormEffectivePeriodType clone()
```
    Created by ph-jaxb22-plugin -Xph-cloneable2
    
    Specified by:
    
    clone in interface com.helger.commons.lang.IExplicitlyCloneable
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    The cloned object. Never null.

Class FreeFormEffectivePeriodType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FreeFormEffectivePeriodType

Method Detail

getStartDate

setStartDate

getEndDate

setEndDate

getDuration

setDuration

getValidFrom

getValidTo

equals

hashCode

toString

setValidFrom

setValidTo

hasValidFromEntries

hasNoValidFromEntries

getValidFromCount

getValidFromAtIndex

addValidFrom

hasValidToEntries

hasNoValidToEntries

getValidToCount

getValidToAtIndex

addValidTo

cloneTo

clone