Class ReturnMerchandiseAuthorizationState

Namespace

Dynamicweb.Ecommerce.Orders.ReturnMerchandiseAuthorization

Assembly

Dynamicweb.Ecommerce.dll

The class ReturnMerchandiseAuthorizationState represent state for ReturnMerchandiseAuthorization.

public class ReturnMerchandiseAuthorizationState

Inheritance

object

ReturnMerchandiseAuthorizationState

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ReturnMerchandiseAuthorizationState()

public ReturnMerchandiseAuthorizationState()

Properties

DefaultDescription

public string DefaultDescription { get; set; }

Property Value

string

DefaultName

public string DefaultName { get; set; }

Property Value

string

Description

Gets or sets the description.

[Obsolete("Use GetDescription and SetDescription instead.")]
public string Description { get; set; }

Property Value

string

The description.

Id

Gets the ID.

public int Id { get; }

Property Value

int

IsDefaultStateForNewRma

Gets or sets a value indicating whether the state is a the default state for new RMAs .

public bool IsDefaultStateForNewRma { get; set; }

Property Value

bool

true if the state is the default state; otherwise, false.

IsNew

Gets a value indicating whether this instance is new.

public bool IsNew { get; }

Property Value

bool

true if this instance is new; otherwise, false.

Language

Gets the Language. If LanguageID is set and is an ID for a valid Language then this is returned; otherwise Default Language is used.

[Obsolete("Use translations instead.")]
public Language Language { get; }

Property Value

Language

LanguageId

Gets or sets the language ID.

[Obsolete("Use Translations instead.")]
public string LanguageId { get; set; }

Property Value

string

Name

Gets or sets the name.

[Obsolete("Use GetName and SetName instead.")]
public string Name { get; set; }

Property Value

string

The name.

Translations

Gets the translations for the current entity

public TranslationCollection<ReturnMerchandiseAuthorizationStateTranslation> Translations { get; }

Property Value

TranslationCollection<ReturnMerchandiseAuthorizationStateTranslation>

Types

Gets a collection of the ReturnMerchandiseAuthorizationType objects that this ReturnMerchandiseAuthorizationState is associated with.

public ReturnMerchandiseAuthorizationTypeCollection Types { get; set; }

Property Value

ReturnMerchandiseAuthorizationTypeCollection

Methods

ClearCache()

Clears the cache.

public static void ClearCache()

CreateTranslation(string)

Creates a new ReturnMerchandiseAuthorizationState with all the properties of this but with the given LanguageID.

[Obsolete("Use Translations instead")]
public ReturnMerchandiseAuthorizationState CreateTranslation(string languageID)

Parameters

languageID string

The LanguageID.

Returns

ReturnMerchandiseAuthorizationState

Delete()

Deletes this instance.

[Obsolete("Use DeleteTranslation(string languageId) instead.")]
public void Delete()

DeleteAll()

Deletes all translations of this ReturnMerchandiseAuthorizationState.

public void DeleteAll()

DeleteTranslation(string)

public void DeleteTranslation(string languageId)

Parameters

languageId string

GetAllStates()

Gets a ReturnMerchandiseAuthorizationStateCollection containing all ReturnMerchandiseAuthorizationState.

public static ReturnMerchandiseAuthorizationStateCollection GetAllStates()

Returns

ReturnMerchandiseAuthorizationStateCollection

GetAllStatesById(int)

Gets all translations of the ReturnMerchandiseAuthorizationState having the given ID.

[Obsolete("Use GetStateById(int stateId) instead.")]
public static ReturnMerchandiseAuthorizationStateCollection GetAllStatesById(int stateId)

Parameters

stateId int

The ID.

Returns

ReturnMerchandiseAuthorizationStateCollection

GetAllStatesByLanguageId(string)

Gets all ReturnMerchandiseAuthorizationState object translations for the given LanguageID. If a translation is missing for the given language, the Default Rma State is used.

[Obsolete("Use GetAllStates instead.")]
public static ReturnMerchandiseAuthorizationStateCollection GetAllStatesByLanguageId(string languageId)

Parameters

languageId string

The LanguageID.

Returns

ReturnMerchandiseAuthorizationStateCollection

GetAllStatesByLanguageId(string, bool)

Gets all ReturnMerchandiseAuthorizationState object translations for the given LanguageID. If a translation is missing for the given language and fallbackToDefault is set to true, the Default Rma State is used.

[Obsolete("Use GetAllStates instead.")]
public static ReturnMerchandiseAuthorizationStateCollection GetAllStatesByLanguageId(string languageId, bool fallbackToDefault)

Parameters

languageId string

The LanguageID.

fallbackToDefault bool

If true the Default ReturnMerchandiseAuthorizationState is used if no translation was found; otherwise the state is skipped.

Returns

ReturnMerchandiseAuthorizationStateCollection

GetDefaultStateForNewRmaOrderLines()

Gets the default ReturnMerchandiseAuthorizationState for new ReturnMerchandiseAuthorization.

public static ReturnMerchandiseAuthorizationState GetDefaultStateForNewRmaOrderLines()

Returns

ReturnMerchandiseAuthorizationState

GetDescription(string)

public string GetDescription(string languageId)

Parameters

languageId string

Returns

string

GetName(string)

public string GetName(string languageId)

Parameters

languageId string

Returns

string

GetStateById(int)

public static ReturnMerchandiseAuthorizationState GetStateById(int stateId)

Parameters

stateId int

Returns

ReturnMerchandiseAuthorizationState

GetStateById(int, string)

Gets the ReturnMerchandiseAuthorizationState by ID and LanguageID. If no matching ReturnMerchandiseAuthorizationState exists, the Default ReturnMerchandiseAuthorizationState is used.

[Obsolete("Use GetStateById(int stateId) instead.")]
public static ReturnMerchandiseAuthorizationState GetStateById(int stateId, string languageId)

Parameters

stateId int

The ID.

languageId string

The LanguageID.

Returns

ReturnMerchandiseAuthorizationState

Save()

Saves this instance.

public void Save()

SetDescription(string, string)

public void SetDescription(string languageId, string description)

Parameters

languageId string

description string

SetName(string, string)

public void SetName(string languageId, string name)

Parameters

languageId string

name string

UpdateDefaultValues(string, string)

Updates the default name and description, which are used when no translation is found.

[Obsolete("Not used anymore.")]
public void UpdateDefaultValues(string newName, string newDescription)

Parameters

newName string

The new default name.

newDescription string

The new default description.