Micro Focus Content Manager SDK 9.3
HP.HPTRIM.SDK.ITrimActiveDates Interface Reference

Allows you to get and set the range of dates for which a particular object is active) More...

Inheritance diagram for HP.HPTRIM.SDK.ITrimActiveDates:
HP.HPTRIM.SDK.Classification HP.HPTRIM.SDK.Hold HP.HPTRIM.SDK.Jurisdiction HP.HPTRIM.SDK.Keyword HP.HPTRIM.SDK.Location HP.HPTRIM.SDK.LocationAddress HP.HPTRIM.SDK.LocationEAddress HP.HPTRIM.SDK.RecordType HP.HPTRIM.SDK.Schedule HP.HPTRIM.SDK.SecurityCaveat HP.HPTRIM.SDK.SecurityGuide HP.HPTRIM.SDK.SecurityLevel HP.HPTRIM.SDK.WorkflowTemplate

Public Member Functions

void SetActiveDateRange (TrimDateTime validFromDate, TrimDateTime validToDate)
 Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges. More...
 

Properties

TrimDateTime DateActiveFrom [get]
 Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...
 
TrimDateTime DateActiveTo [get]
 Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...
 
string ActiveDateRangeDescription [get]
 Gets a string describing the period during which this object was active. More...
 
bool IsActive [get]
 Gets a boolean value indicating whether this object is currently active. More...
 

Detailed Description

Allows you to get and set the range of dates for which a particular object is active)

Member Function Documentation

void HP.HPTRIM.SDK.ITrimActiveDates.SetActiveDateRange ( TrimDateTime  validFromDate,
TrimDateTime  validToDate 
)

Property Documentation

string HP.HPTRIM.SDK.ITrimActiveDates.ActiveDateRangeDescription
get

Gets a string describing the period during which this object was active.

TrimDateTime HP.HPTRIM.SDK.ITrimActiveDates.DateActiveFrom
get

Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value).

TrimDateTime HP.HPTRIM.SDK.ITrimActiveDates.DateActiveTo
get

Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value).

bool HP.HPTRIM.SDK.ITrimActiveDates.IsActive
get

Gets a boolean value indicating whether this object is currently active.