Term (javadoc-im_master

java.lang.Object
- jp.co.intra_mart.foundation.datastore.common.structure.Term

すべての実装されたインタフェース:

Serializable, Comparable

非推奨です。
代替クラスはありません。
```
public class Term
extends Object
implements Comparable, Serializable
```
有効期間を表します。有効期間は開始時間と終了時間から構成されます。次の式を満たす範囲が有効期間として認められます。
開始時間 ≤ 有効期間 < 終了時間
また、開始時間と終了時間は常に次の関係である必要があります。
開始時間 < 終了時間
設定された開始時間および終了時間の時刻は、00:00:00 に切り捨てられます。
ただし、終了時刻に有効最大日時 (9999/12/31|23:59:59) が設定された場合は切り捨ては行いません。

なお、システムで有効な最小日時は以下のAPIで取得することができます。
- getMinDate()
- DateUtil.getMinDate()
システムで有効な最大日時は以下のAPIで取得することができます。
- getMaxDate()
- DateUtil.getMaxDate()
導入されたバージョン:

5.0

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`Term()` 非推奨です。代替メソッドはありません。
`Term(Date activation)` 非推奨です。代替メソッドはありません。
`Term(Date activation, Date expiration)` 非推奨です。代替メソッドはありません。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`int`	`compareTo(Object o)` 非推奨です。代替メソッドはありません。
`boolean`	`containsDate(Date date)` 非推奨です。代替メソッドはありません。
`boolean`	`equals(Object obj)` 非推奨です。代替メソッドはありません。
`Date`	`getActivationDate()` 非推奨です。代替メソッドはありません。
`Date`	`getExpirationDate()` 非推奨です。代替メソッドはありません。
`static Date`	`getMaxDate()` 非推奨です。代替メソッドはありません。
`static Date`	`getMinDate()` 非推奨です。代替メソッドはありません。
`int`	`hashCode()` 非推奨です。代替メソッドはありません。
`String`	`toString()` 非推奨です。代替メソッドはありません。

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - Term
```
public Term()
```
    非推奨です。代替メソッドはありません。
    
    開始時間、終了時間とも指定されていない有効期間を生成します。このコンストラクタで指定された有効期間は常に有効であることを意味します。
  - Term
```
public Term(Date activation)
```
    非推奨です。代替メソッドはありません。
    
    開始時間のみが指定された有効期間を生成します。終了時間が定義されていないため、終了日時には期間の最大日付が設定されます
    
    パラメータ:
    
    activation - 有効開始時間
    
    例外:
    
    IllegalArgumentException - 指定された開始時間が期間の最小日時、最大日時に含まれる日付でないとき発生する
    
    NullPointerException - 有効開始時間が null
  - Term
```
public Term(Date activation,
            Date expiration)
     throws IllegalArgumentException
```
    非推奨です。代替メソッドはありません。
    
    開始時間と終了時間がともに指定された有効期間を生成します。開始時間と終了時間をともに設定する場合、以下の式を満たす必要があります。
    開始時間 ≤ 終了時間
    
    パラメータ:
    
    activation - 有効期間の開始時間
    
    expiration - 有効期間の終了時間
    
    例外:
    
    IllegalArgumentException - 開始時間が終了時間よりも後
    
    NullPointerException - 有効開始時間または有効終了時間が null
- メソッドの詳細
  - getActivationDate
```
public Date getActivationDate()
```
    非推奨です。代替メソッドはありません。
    
    開始時間を取得します。
    
    戻り値:
    
    開始時間
  - getExpirationDate
```
public Date getExpirationDate()
```
    非推奨です。代替メソッドはありません。
    
    終了時間を取得します。
    
    戻り値:
    
    終了時間
  - getMinDate
```
public static Date getMinDate()
```
    非推奨です。代替メソッドはありません。
    
    システムで設定できる期間の最小日時を取得します。
    
    戻り値:
    
    期間の最小日時
  - getMaxDate
```
public static Date getMaxDate()
```
    非推奨です。代替メソッドはありません。
    
    システムで設定できる期間の最大日時を取得します。
    
    戻り値:
    
    期間の最大日時
  - containsDate
```
public boolean containsDate(Date date)
                     throws NullPointerException,
                            IllegalArgumentException
```
    非推奨です。代替メソッドはありません。
    
    指定された日時が期間内に入っているかどうかを指定します。
    
    パラメータ:
    
    date - 日時
    
    戻り値:
    
    指定された日時が期間内に入っている場合は true 、そうでなければ false
    
    例外:
    
    NullPointerException - 指定された日付が null
    
    IllegalArgumentException - 不正な日付が設定された場合
  - compareTo
```
public int compareTo(Object o)
              throws ClassCastException,
                     IllegalArgumentException
```
    非推奨です。代替メソッドはありません。
    
    この期間と指定された期間を比較します。比較する期間どうしは完全に一致するか、少しも重なっていないかのいずれかである必要があります。期間の一部のみが重なっていたり、一方が他方の期間を包含している場合は例外が発生します。
    
    定義:
    
    compareTo インタフェース内 Comparable
    
    パラメータ:
    
    o - 比較対照の期間（ Term）
    
    戻り値:
    
    この期間が引数で指定された期間より過去である場合は負の整数、等しい場合はゼロ、この期間が引数で指定された期間より未来である場合は正の整数
    
    例外:
    
    ClassCastException - 指定された期間が Termではない
    
    IllegalArgumentException - 指定された期間の一部が重なっている、または一方が他方を包含している
  - equals
```
public boolean equals(Object obj)
```
    非推奨です。代替メソッドはありません。
    
    この有効期間と他の有効期間が等しいかどうかを示します。開始時間と終了時間がそれぞれの有効期間において完全に一致している場合、有効期間が等しいとみなされます。
    
    オーバーライド:
    
    equals クラス内 Object
    
    パラメータ:
    
    obj - 比較対象の有効期間
    
    戻り値:
    
    obj 引数に指定された有効期間とこの有効期間が等しい場合は true 、そうでない場合は false
  - hashCode
```
public int hashCode()
```
    非推奨です。代替メソッドはありません。
    
    有効期間のハッシュコード値を返します。
    
    オーバーライド:
    
    hashCode クラス内 Object
    
    戻り値:
    
    有効期間のハッシュコード値
  - toString
```
public String toString()
```
    非推奨です。代替メソッドはありません。
    
    オブジェクトの文字列表現を返します。
    有効開始時間と有効終了時間をそれぞれ DateUtil.dateToString(Date) で変換した String を、半角ハイフン(-)で連結した文字列を返します。つまり、このメソッドは次の値と等しい文字列を返します。
    DateUtil.dateToString(getActivationDate()) + " - " + DateUtil.dateToString(getExpirationDate())
    
    オーバーライド:
    
    toString クラス内 Object
    
    戻り値:
    
    このオブジェクトの文字列表現

クラス Term

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

Term

Term

Term

メソッドの詳細

getActivationDate

getExpirationDate

getMinDate

getMaxDate

containsDate

compareTo

equals

hashCode

toString