spcp7.imagegallery.abstractionlayer.face.persistence
Interface PropertyModelFace

All Known Implementing Classes:

PropertyDTO, PropertyModelImpl

public interface PropertyModelFace

This interface describes a property of which several ones can be persisted within a content folder. Please remember that several fields of this class may not be set to true at the same time. Look at the specific getter and setters for details.

Author:

Phillip Merensky

See Also:

ContentFolderModelFace

Method Summary

java.lang.Boolean	getBool() If your property value is a boolean value and you only want boolean values in the "wert" field to be valid this should be true.
java.lang.Boolean	getBrowseable() If the property resembles a path which can be browsed as a hierarchical structure, set this to true.
java.lang.Boolean	getDeletable() Should the property be deletable?
java.lang.Boolean	getFolderSelection() If this is set to true the field "wert" contains a value which must be a folder.
java.lang.Long	getId() The id of the property
java.lang.Boolean	getImageSelection() If this is set to true only images can be selected when using a browseable view.
java.lang.Boolean	getNumber() If the "wert" field of this property contains a number and only numbers should be valid, this will be set to true.
java.lang.String	getSchluessel() This method gets the key of the property.
java.lang.Boolean	getUrlSelection() If the "wert" field should be a http retrievable url and the wert field is set to a ContentFace.getUrl(), set this to true.
java.lang.Boolean	getVisible()
java.lang.String	getWert() This method gets the value of the property.
void	setBool(java.lang.Boolean bool) This field and getNumber() getBrowseable() getFolderSelection() getImageSelection() getUrlSelection() must not be set to true at the same time.
void	setBrowseable(java.lang.Boolean browseable)
void	setDeletable(java.lang.Boolean deletable) Set if property should be deletable, or not.
void	setFolderSelection(java.lang.Boolean folderSelection) This field and getNumber() getBool() getImageSelection() getUrlSelection() must not be set to true at the same time whereas getBrowseable() should be.
void	setId(java.lang.Long id) Normally this should not be set manually but by the persistence provider.
void	setImageSelection(java.lang.Boolean imageSelection) This field and getNumber() getBool() getFolderSelection() getUrlSelection() must not be set to true at the same time whereas getBrowseable() should be.
void	setNumber(java.lang.Boolean number) This field and getBool() getBrowseable() getFolderSelection() getImageSelection() getUrlSelection() must not be set to true at the same time.
void	setSchluessel(java.lang.String key)
void	setUrlSelection(java.lang.Boolean urlSelection)
void	setVisible(java.lang.Boolean visible)
void	setWert(java.lang.String value)
boolean	validate() This method validates the whole property.

Method Detail

getId

java.lang.Long getId()

The id of the property

Returns:

Long the id.

setId

void setId(java.lang.Long id)

Normally this should not be set manually but by the persistence provider.

Parameters:

id - the id to set.

getDeletable

java.lang.Boolean getDeletable()

Should the property be deletable? Default is false

Returns:

Boolean true if property is deletable, false otherwise.

setDeletable

void setDeletable(java.lang.Boolean deletable)

Set if property should be deletable, or not.

Parameters:

deletable - true if property should be deletable, false otherwise.

See Also:

getDeletable()

getBrowseable

java.lang.Boolean getBrowseable()

If the property resembles a path which can be browsed as a hierarchical structure, set this to true. This field and

• getNumber()
• getBool()

cannot be set to true at the same time.

Returns:

Boolean True if the property resembles a full, browseable, absolute path, false otherwise.

setBrowseable

void setBrowseable(java.lang.Boolean browseable)

Parameters:

browseable - True if the property resembles a full, browseable, absolute path, false otherwise.

See Also:

getBrowseable()

getWert

java.lang.String getWert()

This method gets the value of the property. The German translation of value "wert" is used because value is a keyword in several databases.

Returns:

String the value of this property

setWert

void setWert(java.lang.String value)

Parameters:

value - The value of this property.

See Also:

getWert()

getSchluessel

java.lang.String getSchluessel()

This method gets the key of the property. The German translation of key "schluessel" is used because key is a keyword in several databases. This "schluessel" must also be used as key in maps like ContentProviderRegistryFace.getDefaultProperties()

Returns:

String the key of this property

See Also:

ContentProviderRegistryFace.getDefaultProperties()

setSchluessel

void setSchluessel(java.lang.String key)

Parameters:

key - The key of this property

See Also:

getSchluessel()

getBool

java.lang.Boolean getBool()

If your property value is a boolean value and you only want boolean values in the "wert" field to be valid this should be true.

Returns:

Boolean True if the "wert"(value) should be validated as boolean value, false otherwise.

setBool

void setBool(java.lang.Boolean bool)

This field and

• getNumber()
• getBrowseable()
• getFolderSelection()
• getImageSelection()
• getUrlSelection()

must not be set to true at the same time.

Parameters:

bool - True if the value(wert) of this property should only contain Boolean values, false otherwise.

See Also:

getBool()

getUrlSelection

java.lang.Boolean getUrlSelection()

If the "wert" field should be a http retrievable url and the wert field is set to a ContentFace.getUrl(), set this to true.

Returns:

True if this is a url, false otherwise.

setUrlSelection

void setUrlSelection(java.lang.Boolean urlSelection)

Parameters:

urlSelection - True if the "wert" field of this property should be a selectable url.

See Also:

getUrlSelection()

getFolderSelection

java.lang.Boolean getFolderSelection()

If this is set to true the field "wert" contains a value which must be a folder. For this to work "wert" must contain an absolute path to this folder. Within the browsing perspective of the gui this option allows only folders to be selected.

Returns:

True if the "wert" field of this property must contain an absolute path to a folder.

setFolderSelection

void setFolderSelection(java.lang.Boolean folderSelection)

This field and

• getNumber()
• getBool()
• getImageSelection()
• getUrlSelection()

must not be set to true at the same time whereas getBrowseable() should be.

Parameters:

folderSelection -

See Also:

getFolderSelection()

getImageSelection

java.lang.Boolean getImageSelection()

If this is set to true only images can be selected when using a browseable view. Within the "wert" field an absolute path to an image is valid when this field is set to true.

Returns:

true if only images have to be selected, false otherwise.

setImageSelection

void setImageSelection(java.lang.Boolean imageSelection)

This field and

• getNumber()
• getBool()
• getFolderSelection()
• getUrlSelection()

must not be set to true at the same time whereas getBrowseable() should be.

Parameters:

imageSelection - true if only images should be selectable, false otherwise.

See Also:

getImageSelection()

getNumber

java.lang.Boolean getNumber()

If the "wert" field of this property contains a number and only numbers should be valid, this will be set to true.

Returns:

true if the "wert" field contains a number, false otherwise.

setNumber

void setNumber(java.lang.Boolean number)

This field and

• getBool()
• getBrowseable()
• getFolderSelection()
• getImageSelection()
• getUrlSelection()

must not be set to true at the same time.

Parameters:

number - True if the value(wert) of this property should only contain Boolean numbers, false otherwise.

See Also:

getNumber()

getVisible

java.lang.Boolean getVisible()

Returns:

True if the value should be visible in the gui, false if it is only used internally.

setVisible

void setVisible(java.lang.Boolean visible)

Parameters:

visible - True if the value should be visible in the gui, false if it is only used internally.

See Also:

getVisible()

validate

boolean validate()

This method validates the whole property. Several fields of this property cannot be set to true or false a the same time. This method checks if these constraints are met. Look at the specific getter and setters to get to know the details.

Returns:

true if all constraints have been met and false otherwise.