com.helger.phase4.model.pmode.leg

Class PModePayloadProfile

java.lang.Object

com.helger.phase4.model.pmode.leg.PModePayloadProfile

All Implemented Interfaces:

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

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

A payload part is a data structure that consists of five properties: name (or Content-ID) that is the part identifier, and can be used as an index in the notation PayloadProfile[]; MIME data type (text/xml, application/pdf, etc.); name of the applicable XML Schema file if the MIME data type is text/xml; maximum size in kilobytes; and a Boolean value indicating whether the part is expected or optional, within the User message. The message payload(s) must match this profile.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_MANDATORY

Constructor Summary

Constructors

Constructor and Description
PModePayloadProfile(String sName, com.helger.commons.mime.IMimeType aMimeType, String sXSDFilename, Integer aMaxSizeKB, com.helger.commons.state.EMandatory eMandatory)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Integer	getMaxSizeKB()
com.helger.commons.mime.IMimeType	getMimeType()
String	getName()
String	getXSDFilename()
int	hashCode()
boolean	hasMaxSizeKB()
boolean	hasXSDFilename()
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.state.IMandatoryIndicator

and, or

Field Detail

DEFAULT_MANDATORY

public static final boolean DEFAULT_MANDATORY

See Also:

Constant Field Values

Constructor Detail

PModePayloadProfile

public PModePayloadProfile(@Nonnull @Nonempty
                           String sName,
                           @Nonnull
                           com.helger.commons.mime.IMimeType aMimeType,
                           @Nullable
                           String sXSDFilename,
                           @Nullable
                           Integer aMaxSizeKB,
                           @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

getMimeType

@Nonnull
public com.helger.commons.mime.IMimeType getMimeType()

getXSDFilename

@Nullable
public String getXSDFilename()

hasXSDFilename

public boolean hasXSDFilename()

getMaxSizeKB

@Nullable
public Integer getMaxSizeKB()

hasMaxSizeKB

public boolean hasMaxSizeKB()

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