Class DateFormat

  • All Implemented Interfaces:
    IServiceDataObject, java.io.Serializable

    public class DateFormat
    extends ServiceDataObject
    implements java.io.Serializable
    DateFormat describes the formatting used for one of three configurable date formats: Input, Long or Short.
    Version:
    2013-08-26
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      DateFormat()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DateOrder getDateOrder()
      Gets the order of the elements in the date.
      java.lang.String getFormatName()
      Gets the name of the format (Input, Long, or Short).
      boolean getIs24HrClock()
      Gets whether the time is represented as a 24-hour clock.
      MonthFormat getMonthFormat()
      Gets the format of the month.
      java.lang.String getSeparator1()
      Gets the first separator character.
      java.lang.String getSeparator2()
      Gets the second separator character.
      YearFormat getYearFormat()
      Gets the format of the year.
      void load​(com.opentext.api.LLValue value)
      Deserialize an ServiceDataObject from an LLValue that is received from Livelink.
      void setDateOrder​(DateOrder value)
      Sets the order of the elements in the date.
      void setFormatName​(java.lang.String value)
      Sets the name of the format (Input, Long, or Short).
      void setIs24HrClock​(boolean value)
      Sets whether the time is represented as a 24-hour clock.
      void setMonthFormat​(MonthFormat value)
      Sets the format of the month.
      void setSeparator1​(java.lang.String value)
      Sets the first separator character.
      void setSeparator2​(java.lang.String value)
      Sets the second separator character.
      void setYearFormat​(YearFormat value)
      Sets the format of the year.
      com.opentext.api.LLValue toLLValue()
      Serialize an SDO object to an LLValue that can be sent to Livelink.
      java.lang.String toString()
      Returns a string representation of the object consisting of the object name and any features and their values within square brackets.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • DateFormat

        public DateFormat()
    • Method Detail

      • setDateOrder

        public void setDateOrder​(DateOrder value)
        Sets the order of the elements in the date.
      • getDateOrder

        public DateOrder getDateOrder()
        Gets the order of the elements in the date.
      • setFormatName

        public void setFormatName​(java.lang.String value)
        Sets the name of the format (Input, Long, or Short).
      • getFormatName

        public java.lang.String getFormatName()
        Gets the name of the format (Input, Long, or Short).
      • setIs24HrClock

        public void setIs24HrClock​(boolean value)
        Sets whether the time is represented as a 24-hour clock.
      • getIs24HrClock

        public boolean getIs24HrClock()
        Gets whether the time is represented as a 24-hour clock.
      • setMonthFormat

        public void setMonthFormat​(MonthFormat value)
        Sets the format of the month.
      • getMonthFormat

        public MonthFormat getMonthFormat()
        Gets the format of the month.
      • setSeparator1

        public void setSeparator1​(java.lang.String value)
        Sets the first separator character.
      • getSeparator1

        public java.lang.String getSeparator1()
        Gets the first separator character.
      • setSeparator2

        public void setSeparator2​(java.lang.String value)
        Sets the second separator character.
      • getSeparator2

        public java.lang.String getSeparator2()
        Gets the second separator character.
      • setYearFormat

        public void setYearFormat​(YearFormat value)
        Sets the format of the year.
      • getYearFormat

        public YearFormat getYearFormat()
        Gets the format of the year.
      • load

        public void load​(com.opentext.api.LLValue value)
        Description copied from interface: IServiceDataObject
        Deserialize an ServiceDataObject from an LLValue that is received from Livelink. The LLValue is an Assoc that contains all of the features of this SDO. These features may refer to other SDOs and contain arrays of primitive values or SDOs. Each referenced SDO, will have its load() method called as well. Note: this is an internal method not meant to be called by clients.
        Specified by:
        load in interface IServiceDataObject
        Overrides:
        load in class ServiceDataObject
        Parameters:
        value - the LLValue containing the data to be loaded
      • toLLValue

        public com.opentext.api.LLValue toLLValue()
        Description copied from interface: IServiceDataObject
        Serialize an SDO object to an LLValue that can be sent to Livelink. Each feature of the SDO is stored in a key of the LLValue Assoc. Any references to other SDOs cause their toLLValue() method to be called. Note: this is an internal method not meant to be called by clients.
        Specified by:
        toLLValue in interface IServiceDataObject
        Overrides:
        toLLValue in class ServiceDataObject
        Returns:
        Returns the LLValue object that represents this SDO
      • toString

        public java.lang.String toString()
        Description copied from class: ServiceDataObject
        Returns a string representation of the object consisting of the object name and any features and their values within square brackets. Intended for simple debugging or logging of an SDO.
        Overrides:
        toString in class ServiceDataObject