Class ServerTaskParametersAttribute

This attribute can be used to mark any implementation of the ServerTaskParameter class for defining parameters for a ITaskProcessor implementation

It is optional if the ITaskProcessor implementation is accessible from all UI clients, as that ServerTaskAttribute contains all the details.

If the ITaskProcessor is not always accessible then the ServerTaskParameter *must* be marked with this to provide detail on how to create parameters for the task and send to the server for processing

Inheritance

System.Object

System.Attribute

ServerTaskParametersAttribute

ServerTaskAttribute

Inherited Members

System.Attribute.Equals(System.Object)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetHashCode()

System.Attribute.IsDefaultAttribute()

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.Module, System.Type)

System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.Match(System.Object)

System.Attribute.TypeId

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: LemonEdge.API.Tasks

Assembly: API.dll

Syntax

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
public class ServerTaskParametersAttribute : Attribute

Constructors

ServerTaskParametersAttribute(String, String)

Creates a new instance of the server task parameters attribute for describing a ServerTaskParameter implementation

Declaration

public ServerTaskParametersAttribute(string userFriendlyTaskName, string uniqueTaskID)

Parameters

Type	Name	Description
System.String	userFriendlyTaskName	The user friendly name of the task type
System.String	uniqueTaskID	The globally unique System.Guid id for this task. Used in UniqueTaskID too.

Properties

DefaultForHasSaveProcessingTask

If this task works against an entity in the system that implements IHasSaveProcessingTask, then that type can be specified here and the Save command can integrate with it

The integration automatically creates the task during save or provide parameters for it depending on the ShouldAutomaticallyCreateTask(IHasSaveProcessingTask, IEntityUpdater) implementation

Declaration

public Type DefaultForHasSaveProcessingTask { get; set; }

Property Value

Type	Description
System.Type

Description

A user friendly description of this tasks operation

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

Name

The user friendly name of the task type

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

UniqueTaskID

The globally unique id for this task. Used in UniqueTaskID too.

Declaration

public Guid UniqueTaskID { get; }

Property Value

Type	Description
System.Guid

Extension Methods

MiscExtensions.SetIfNotEqual<T, P>(T, Expression<Func<T, P>>, P)

ReflectionExtensions.ClearEventInvocations(Object, String)

StringExtensions.ToCSVFormatString(Object, Type)

SQLExtensions.ToSQLValue(Object, Boolean)