Interface IArcherContentAccess

Inherited Members
Namespace: Estrelica.Archer.Content
Assembly: Estrelica.Interfaces.dll
Syntax
[StayPublic]
[DoNotObfuscateType]
public interface IArcherContentAccess : IArcherRecord, IRecordAccess<int>, IRecordAccess, IEditableInterface<IArcherContentEdit>, IEditable

Properties

ContentHistory

Returns a collection of IContentHistory information for the current record. Note that this is loaded and cached on first call. Set it to any value (namely null, anything else will be ignored) to flush the cache and reload if needed.

Declaration
IEnumerable<IContentHistory> ContentHistory { get; set; }
Property Value
IEnumerable<IContentHistory>

this[IArcherField]

Declaration
dynamic this[IArcherField field] { get; }
Parameters
IArcherField field

Property Value
dynamic

this[Guid]

Declaration
dynamic this[Guid identifer] { get; }
Parameters
Guid identifer

Property Value
dynamic

this[int]

Declaration
dynamic this[int fieldId] { get; }
Parameters
int fieldId

Property Value
dynamic

this[string]

Declaration
dynamic this[string fieldNameOrAlias] { get; }
Parameters
string fieldNameOrAlias

Property Value
dynamic

TrackedFieldIds

Returns a collection of integer field Ids for which History Log information is available on the current record.

Declaration
IEnumerable<int> TrackedFieldIds { get; }
Property Value
IEnumerable<int>

Methods

DateValue(Guid)

Declaration
DateTime? DateValue(Guid dateFieldGuid)
Parameters
Guid dateFieldGuid

Returns
DateTime?

DateValue(int)

Declaration
DateTime? DateValue(int dateFieldId)
Parameters
int dateFieldId

Returns
DateTime?

DateValue(string)

Declaration
DateTime? DateValue(string dateFieldNameOrAlias)
Parameters
string dateFieldNameOrAlias

Returns
DateTime?

DocumentSelection(Guid)

Declaration
IEnumerable<IArcherDocument> DocumentSelection(Guid documentFieldGuid)
Parameters
Guid documentFieldGuid

Returns
IEnumerable<IArcherDocument>

DocumentSelection(int)

Declaration
IEnumerable<IArcherDocument> DocumentSelection(int documentFieldId)
Parameters
int documentFieldId

Returns
IEnumerable<IArcherDocument>

DocumentSelection(string)

Declaration
IEnumerable<IArcherDocument> DocumentSelection(string documentFieldNameOrAlias)
Parameters
string documentFieldNameOrAlias

Returns
IEnumerable<IArcherDocument>

ExternalLinkSelection(Guid)

Declaration
IEnumerable<IExternalLink> ExternalLinkSelection(Guid externalLinksFieldGuid)
Parameters
Guid externalLinksFieldGuid

Returns
IEnumerable<IExternalLink>

ExternalLinkSelection(int)

Declaration
IEnumerable<IExternalLink> ExternalLinkSelection(int externalLinksFieldId)
Parameters
int externalLinksFieldId

Returns
IEnumerable<IExternalLink>

ExternalLinkSelection(string)

Declaration
IEnumerable<IExternalLink> ExternalLinkSelection(string externalLinksFieldNameOrAlias)
Parameters
string externalLinksFieldNameOrAlias

Returns
IEnumerable<IExternalLink>

FieldHistory(IArcherField)

Returns a collection of IFieldHistoryEx information from this record for a specific field

Declaration
IEnumerable<IFieldHistoryEx> FieldHistory(IArcherField field)
Parameters
IArcherField field

Returns
IEnumerable<IFieldHistoryEx>

Remarks

This requires that the field is tracked by at least one History Log field. If not, or if there is no history found, a non-null empty result will be returned.

FieldHistory(int)

Returns a collection of IFieldHistoryEx information from this record for a specific field by Id

Declaration
IEnumerable<IFieldHistoryEx> FieldHistory(int fieldId)
Parameters
int fieldId

Returns
IEnumerable<IFieldHistoryEx>

Remarks

This requires that the field is tracked by at least one History Log field. If not, or if there is no history found, a non-null empty result will be returned.

FieldHistoryAsOf(IArcherField, DateTime?)

Returns the IFieldHistoryEx information carried by this record as of a specific UTC date/time for a specific field. This represents the most recent History Log-tracked edit that occurred to the field for this record as of the specified time.

Declaration
IFieldHistoryEx FieldHistoryAsOf(IArcherField field, DateTime? asOfUTC)
Parameters
IArcherField field

DateTime? asOfUTC

The "as of" date to be queried. If null, the most recent history event will be returned.
Returns
IFieldHistoryEx

An IFieldHistoryEx representing details of what was in the field as the specified date. Returns null if the field is not tracked by any History Log fields, or if it had no value as of the specified date

FieldHistoryAsOf(int, DateTime?)

Returns the IFieldHistoryEx information carried by this record as of a specific UTC date/time for a specific field by Id. This represents the most recent History Log-tracked edit that occurred to the field for this record as of the specified time.

Declaration
IFieldHistoryEx FieldHistoryAsOf(int fieldId, DateTime? asOfUTC)
Parameters
int fieldId

The id of the field to query for history
DateTime? asOfUTC

The "as of" date to be queried. If null, the most recent history event will be returned.
Returns
IFieldHistoryEx

An IFieldHistoryEx representing details of what was in the field as the specified date. Returns null if the field is not tracked by any History Log fields, or if it had no value as of the specified date

HistoryAsOf(DateTime?)

Returns a collection of IFieldHistoryEx information carried by this record as of a specific UTC date/time for all fields tracked by History Log fields. This collection represents the most recent History Log-tracked edits that occurred to the record across all of those fields as of the specified time.

Declaration
IEnumerable<IFieldHistoryEx> HistoryAsOf(DateTime? asOfUTC)
Parameters
DateTime? asOfUTC

The "as of" date to be queried. If null, the most recent history event for each of the tracked fields will be returned.
Returns
IEnumerable<IFieldHistoryEx>

Remarks

Only fields for which history events were found for the selected asOfDate will be represented in the results. The field associated with each may be identified via the IFieldHistoryEx Estrelica.Archer.Content.IFieldHistoryEx.Field or Estrelica.Archer.Content.IFieldHistoryEx.FieldId properties.

HistoryAsOf(DateTime?, IEnumerable<IArcherField>)

Returns a collection of IFieldHistoryEx information carried by this record as of a specific UTC date/time for specific fields tracked by History Log fields. This collection represents the most recent History Log-tracked edits that occurred to the record across all of those fields as of the specified time.

Declaration
IEnumerable<IFieldHistoryEx> HistoryAsOf(DateTime? asOfUTC, IEnumerable<IArcherField> fields)
Parameters
DateTime? asOfUTC

The "as of" date to be queried. If null, the most recent history event for each of the selected fields will be returned.
IEnumerable<IArcherField> fields

Returns
IEnumerable<IFieldHistoryEx>

Remarks

Only fields for which history events were found for the selected asOfDate will be represented in the results. The field associated with each may be identified via the IFieldHistoryEx Estrelica.Archer.Content.IFieldHistoryEx.Field or Estrelica.Archer.Content.IFieldHistoryEx.FieldId properties.

HistoryAsOf(DateTime?, IEnumerable<int>)

Returns a collection of IFieldHistoryEx information carried by this record as of a specific UTC date/time for specific fields tracked by History Log fields. This collection represents the most recent History Log-tracked edits that occurred to the record across all of those fields as of the specified time.

Declaration
IEnumerable<IFieldHistoryEx> HistoryAsOf(DateTime? asOfUTC, IEnumerable<int> fieldIds)
Parameters
DateTime? asOfUTC

The "as of" date to be queried. If null, the most recent history event for each of the selected fields will be returned.
IEnumerable<int> fieldIds

The integer Ids of specific fields to be returned in the result. If null, all tracked fields will be evaluated for return.
Returns
IEnumerable<IFieldHistoryEx>

Remarks

Only fields for which history events were found for the selected asOfDate will be represented in the results. The field associated with each may be identified via the IFieldHistoryEx Estrelica.Archer.Content.IFieldHistoryEx.Field or Estrelica.Archer.Content.IFieldHistoryEx.FieldId properties.

IPAddressValue(Guid)

Declaration
string IPAddressValue(Guid ipAddressFieldGuid)
Parameters
Guid ipAddressFieldGuid

Returns
string

IPAddressValue(int)

Declaration
string IPAddressValue(int ipAddressFieldId)
Parameters
int ipAddressFieldId

Returns
string

IPAddressValue(string)

Declaration
string IPAddressValue(string ipAddressFieldNameOrAlias)
Parameters
string ipAddressFieldNameOrAlias

Returns
string

NumericValue(Guid)

Declaration
decimal? NumericValue(Guid numericFieldGuid)
Parameters
Guid numericFieldGuid

Returns
decimal?

NumericValue(int)

Declaration
decimal? NumericValue(int numericFieldId)
Parameters
int numericFieldId

Returns
decimal?

NumericValue(string)

Declaration
decimal? NumericValue(string numericFieldNameOrAlias)
Parameters
string numericFieldNameOrAlias

Returns
decimal?

NumericValue<N>(Guid)

Declaration
N? NumericValue<N>(Guid numericFieldGuid) where N : struct, IComparable, IComparable<N>, IConvertible, IEquatable<N>, IFormattable
Parameters
Guid numericFieldGuid

Returns
N?

Type Parameters
N

NumericValue<N>(int)

Declaration
N? NumericValue<N>(int numericFieldId) where N : struct, IComparable, IComparable<N>, IConvertible, IEquatable<N>, IFormattable
Parameters
int numericFieldId

Returns
N?

Type Parameters
N

NumericValue<N>(string)

Declaration
N? NumericValue<N>(string numericFieldNameOrAlias) where N : struct, IComparable, IComparable<N>, IConvertible, IEquatable<N>, IFormattable
Parameters
string numericFieldNameOrAlias

Returns
N?

Type Parameters
N

ReferencedRecordsSelection(Guid)

Declaration
IReferencedRecordsSelection ReferencedRecordsSelection(Guid referenceFieldGuid)
Parameters
Guid referenceFieldGuid

Returns
IReferencedRecordsSelection

ReferencedRecordsSelection(int)

Declaration
IReferencedRecordsSelection ReferencedRecordsSelection(int referenceFieldId)
Parameters
int referenceFieldId

Returns
IReferencedRecordsSelection

ReferencedRecordsSelection(string)

Declaration
IReferencedRecordsSelection ReferencedRecordsSelection(string referenceFieldNameOrAlias)
Parameters
string referenceFieldNameOrAlias

Returns
IReferencedRecordsSelection

Reload(ContentSource?)

Declaration
IArcherContentAccess Reload(ContentSource? contentSource = null)
Parameters
ContentSource? contentSource

Returns
IArcherContentAccess

TextValue(Guid)

Declaration
string TextValue(Guid textFieldGuid)
Parameters
Guid textFieldGuid

Returns
string

TextValue(int)

Declaration
string TextValue(int textFieldId)
Parameters
int textFieldId

Returns
string

TextValue(string)

Declaration
string TextValue(string textFieldNameOrAlias)
Parameters
string textFieldNameOrAlias

Returns
string

UserGroupListSelection(Guid)

Declaration
IUserGroupListSelection UserGroupListSelection(Guid userGroupListFieldGuid)
Parameters
Guid userGroupListFieldGuid

Returns
IUserGroupListSelection

UserGroupListSelection(int)

Declaration
IUserGroupListSelection UserGroupListSelection(int userGroupListFieldId)
Parameters
int userGroupListFieldId

Returns
IUserGroupListSelection

UserGroupListSelection(string)

Declaration
IUserGroupListSelection UserGroupListSelection(string userGroupListFieldNameOrAlias)
Parameters
string userGroupListFieldNameOrAlias

Returns
IUserGroupListSelection

Value(IArcherField)

Declaration
dynamic Value(IArcherField field)
Parameters
IArcherField field

Returns
dynamic

Value(IBaseDateField)

Declaration
DateTime? Value(IBaseDateField field)
Parameters
IBaseDateField field

Returns
DateTime?

Value(IDocumentField)

Declaration
IEnumerable<IArcherDocument> Value(IDocumentField documentField)
Parameters
IDocumentField documentField

Returns
IEnumerable<IArcherDocument>

Value(IExternalLinksField)

Declaration
IEnumerable<IExternalLink> Value(IExternalLinksField externalLinksField)
Parameters
IExternalLinksField externalLinksField

Returns
IEnumerable<IExternalLink>

Value(IIPAddressField)

Declaration
string Value(IIPAddressField ipAddressField)
Parameters
IIPAddressField ipAddressField

Returns
string

Value(INumericField)

Declaration
decimal? Value(INumericField numericField)
Parameters
INumericField numericField

Returns
decimal?

Value(IRecordStatusField)

Declaration
RecordStatus Value(IRecordStatusField recordStatusField)
Parameters
IRecordStatusField recordStatusField

Returns
RecordStatus

Value(IReferenceField)

Declaration
IReferencedRecordsSelection Value(IReferenceField referenceField)
Parameters
IReferenceField referenceField

Returns
IReferencedRecordsSelection

Value(ITextField)

Declaration
string Value(ITextField textField)
Parameters
ITextField textField

Returns
string

Value(ITrackingIDField)

Declaration
string Value(ITrackingIDField trackingIdField)
Parameters
ITrackingIDField trackingIdField

Returns
string

Value(IUserGroupListField)

Declaration
IUserGroupListSelection Value(IUserGroupListField userGroupListField)
Parameters
IUserGroupListField userGroupListField

Returns
IUserGroupListSelection

Value(IValuesListField)

Declaration
IValuesListSelection Value(IValuesListField valueListField)
Parameters
IValuesListField valueListField

Returns
IValuesListSelection

Value(Guid)

Declaration
dynamic Value(Guid identifer)
Parameters
Guid identifer

Returns
dynamic

Value(int)

Declaration
dynamic Value(int fieldId)
Parameters
int fieldId

Returns
dynamic

Value<V>(IArcherField, V)

Declaration
V Value<V>(IArcherField field, V defaultIfUnassigned = default)
Parameters
IArcherField field

V defaultIfUnassigned

Returns
V

Type Parameters
V

Value<N>(INumericField)

Declaration
N? Value<N>(INumericField numericField) where N : struct, IComparable, IComparable<N>, IConvertible, IEquatable<N>, IFormattable
Parameters
INumericField numericField

Returns
N?

Type Parameters
N

Value<V>(Guid, V)

Declaration
V Value<V>(Guid fieldGuid, V defaultIfUnassigned = default)
Parameters
Guid fieldGuid

V defaultIfUnassigned

Returns
V

Type Parameters
V

Value<V>(int, V)

Declaration
V Value<V>(int fieldId, V defaultIfUnassigned = default)
Parameters
int fieldId

V defaultIfUnassigned

Returns
V

Type Parameters
V

Value<V>(string, V)

Declaration
V Value<V>(string fieldNameOrAlias, V defaultIfUnassigned = default)
Parameters
string fieldNameOrAlias

V defaultIfUnassigned

Returns
V

Type Parameters
V

ValuesListSelection(Guid)

Declaration
IValuesListSelection ValuesListSelection(Guid valuesListFieldGuid)
Parameters
Guid valuesListFieldGuid

Returns
IValuesListSelection

ValuesListSelection(int)

Declaration
IValuesListSelection ValuesListSelection(int valuesListFieldId)
Parameters
int valuesListFieldId

Returns
IValuesListSelection

ValuesListSelection(string)

Declaration
IValuesListSelection ValuesListSelection(string valuesListFieldNameOrAlias)
Parameters
string valuesListFieldNameOrAlias

Returns
IValuesListSelection

Extension Methods