ch.postfinance.sdk.model

Class DocumentTemplate

java.lang.Object

ch.postfinance.sdk.model.DocumentTemplate

public class DocumentTemplate
extends Object

A document template contains the customizations for a particular document template type.

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	defaultTemplate
protected Boolean	deliveryEnabled
protected Long	id
protected Long	linkedSpaceId
protected String	name
protected OffsetDateTime	plannedPurgeDate
protected Long	spaceId
protected CreationEntityState	state
protected ResourcePath	templateResource
protected Long	type
protected Integer	version

Constructor Summary

Constructors

Constructor and Description
DocumentTemplate()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Long	getId() The ID is the primary key of the entity.
Long	getLinkedSpaceId() The linked space id holds the ID of the space to which the entity belongs to.
String	getName()
OffsetDateTime	getPlannedPurgeDate() The planned purge date indicates when the entity is permanently removed.
Long	getSpaceId()
CreationEntityState	getState()
ResourcePath	getTemplateResource()
Long	getType()
Integer	getVersion() The version number indicates the version of the entity.
int	hashCode()
Boolean	isDefaultTemplate() The default document template is used whenever no specific template is specified for a particular template type.
Boolean	isDeliveryEnabled()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

defaultTemplate

protected Boolean defaultTemplate

deliveryEnabled

protected Boolean deliveryEnabled

id

protected Long id

linkedSpaceId

protected Long linkedSpaceId

name

protected String name

plannedPurgeDate

protected OffsetDateTime plannedPurgeDate

spaceId

protected Long spaceId

state

protected CreationEntityState state

templateResource

protected ResourcePath templateResource

type

protected Long type

version

protected Integer version

Constructor Detail

DocumentTemplate

public DocumentTemplate()

Method Detail

isDefaultTemplate

public Boolean isDefaultTemplate()

The default document template is used whenever no specific template is specified for a particular template type.

Returns:

defaultTemplate

isDeliveryEnabled

public Boolean isDeliveryEnabled()

Returns:

deliveryEnabled

getId

public Long getId()

The ID is the primary key of the entity. The ID identifies the entity uniquely.

Returns:

id

getLinkedSpaceId

public Long getLinkedSpaceId()

The linked space id holds the ID of the space to which the entity belongs to.

Returns:

linkedSpaceId

getName

public String getName()

Returns:

name

getPlannedPurgeDate

public OffsetDateTime getPlannedPurgeDate()

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.

Returns:

plannedPurgeDate

getSpaceId

public Long getSpaceId()

Returns:

spaceId

getState

public CreationEntityState getState()

Returns:

state

getTemplateResource

public ResourcePath getTemplateResource()

Returns:

templateResource

getType

public Long getType()

Returns:

type

getVersion

public Integer getVersion()

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.

Returns:

version

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