C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.Attributes.ServerHasDefault Class Reference

Indicates that the property, if left null, will have a default value generated and filled in by the server. More...

Public Member Functions

 ServerHasDefault ()
 Attribute indicates that if left null, the server will supply a default value for this property (the exact value of which is unknown to the client). More...
 
 ServerHasDefault (object defaultValue)
 Attribute indicates that if left null, the server will supply the specified default value for this property. More...
 
virtual object GetDefaultValue (object owner)
 Returns the expected default value for the property based on the owner. More...
 
virtual bool HasDefaultValue (object owner)
 Returns whether there exists an expected default value for the property based on the specified owner. More...
 

Public Attributes

virtual bool HasKnownDefault => HasDefaultValue(null)
 Indicates whether this attribute specifies an expected default value that the server is known to return in all cases. More...
 

Protected Member Functions

 ServerHasDefault (bool hasKnownDefault)
 Constructor that allows the derived class to specify whether it supplies a known default value for all objects via an overridden GetDefaultValue method. More...
 

Properties

virtual object DefaultValue [get]
 Indicates whether this attribute specifies an expected default value that the server is known to return in all cases. More...
 

Detailed Description

Indicates that the property, if left null, will have a default value generated and filled in by the server.

Definition at line 8 of file ServerHasDefault.cs.

Inheritance diagram for AnalyzeRe.Attributes.ServerHasDefault:
AnalyzeRe.APIResourceView.TargetCurrencyDefault AnalyzeRe.Attributes.ServerHasDefaultEmptyObject

Constructor & Destructor Documentation

AnalyzeRe.Attributes.ServerHasDefault.ServerHasDefault ( )
inline

Attribute indicates that if left null, the server will supply a default value for this property (the exact value of which is unknown to the client).

Definition at line 32 of file ServerHasDefault.cs.

AnalyzeRe.Attributes.ServerHasDefault.ServerHasDefault ( object  defaultValue)
inline

Attribute indicates that if left null, the server will supply the specified default value for this property.

Parameters
defaultValueThe expected default value that the server will return. (Must be a static constant value.)

Definition at line 38 of file ServerHasDefault.cs.

AnalyzeRe.Attributes.ServerHasDefault.ServerHasDefault ( bool  hasKnownDefault)
inlineprotected

Constructor that allows the derived class to specify whether it supplies a known default value for all objects via an overridden GetDefaultValue method.

Parameters
hasKnownDefaultTrue

Definition at line 47 of file ServerHasDefault.cs.

Member Function Documentation

virtual object AnalyzeRe.Attributes.ServerHasDefault.GetDefaultValue ( object  owner)
inlinevirtual

Returns the expected default value for the property based on the owner.

Parameters
ownerThe object from which a default value will be derived.
Returns
The expected default value for the specified object.

Reimplemented in AnalyzeRe.APIResourceView.TargetCurrencyDefault.

Definition at line 64 of file ServerHasDefault.cs.

virtual bool AnalyzeRe.Attributes.ServerHasDefault.HasDefaultValue ( object  owner)
inlinevirtual

Returns whether there exists an expected default value for the property based on the specified owner.

Parameters
ownerThe object from which a default value will be derived.
Returns
False if there is no known default value for the supplied object.

Definition at line 56 of file ServerHasDefault.cs.

Member Data Documentation

virtual bool AnalyzeRe.Attributes.ServerHasDefault.HasKnownDefault => HasDefaultValue(null)

Indicates whether this attribute specifies an expected default value that the server is known to return in all cases.

Definition at line 15 of file ServerHasDefault.cs.

Property Documentation

virtual object AnalyzeRe.Attributes.ServerHasDefault.DefaultValue
get

Indicates whether this attribute specifies an expected default value that the server is known to return in all cases.

Definition at line 20 of file ServerHasDefault.cs.


The documentation for this class was generated from the following file: