com.helger.phase4.model.pmode.leg

Class PModeProperty

java.lang.Object

com.helger.phase4.model.pmode.leg.PModeProperty

All Implemented Interfaces:

com.helger.commons.name.IHasName, com.helger.commons.state.IMandatoryIndicator, com.helger.commons.text.IHasDescription, Serializable

@Immutable
 @MustImplementEqualsAndHashcode
public class PModeProperty
extends Object
implements com.helger.commons.name.IHasName, com.helger.commons.text.IHasDescription, com.helger.commons.state.IMandatoryIndicator, Serializable

A property is a data structure that consists of four values: the property name, which can be used as an identifier of the property (e.g. a required property named "messagetype" can be noted as: Properties[messagetype].required="true"); the property description; the property data type; and a Boolean value, indicating whether the property is expected or optional, within the User message. This parameter controls the contents of the element eb:Messaging/eb:UserMessage/eb:MessageProperties.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_TYPE_STRING
static boolean	DEFAULT_MANDATORY

Constructor Summary

Constructors

Constructor and Description
PModeProperty(String sName, String sDescription, String sDataType, com.helger.commons.state.EMandatory eMandatory)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDataType()
String	getDescription()
String	getName()
int	hashCode()
boolean	isMandatory()
boolean	isOptional()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.name.IHasName

getComparatorCollating, getComparatorName

Methods inherited from interface com.helger.commons.text.IHasDescription

hasDescription

Methods inherited from interface com.helger.commons.state.IMandatoryIndicator

and, or

Field Detail

DATA_TYPE_STRING

public static final String DATA_TYPE_STRING

See Also:

Constant Field Values

DEFAULT_MANDATORY

public static final boolean DEFAULT_MANDATORY

See Also:

Constant Field Values

Constructor Detail

PModeProperty

public PModeProperty(@Nonnull @Nonempty
                     String sName,
                     @Nullable
                     String sDescription,
                     @Nonnull @Nonempty
                     String sDataType,
                     @Nonnull
                     com.helger.commons.state.EMandatory eMandatory)

Method Detail

getName

@Nonnull
 @Nonempty
public String getName()

Specified by:

getName in interface com.helger.commons.name.IHasName

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface com.helger.commons.text.IHasDescription

getDataType

@Nonnull
 @Nonempty
public String getDataType()

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface com.helger.commons.state.IMandatoryIndicator

isOptional

public boolean isOptional()

Specified by:

isOptional in interface com.helger.commons.state.IMandatoryIndicator

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object