com.ibm.commerce.store.facade.datatypes

Interface GeoNodeType

public interface GeoNodeType

A representation of the model object 'Geo Node Type'. The type definition of the GeoNode noun.

The following features are supported:

• Geo Node Identifier
• Store Identifier
• Description
• Parent Geo Node Identifier
• User Data
• Display Sequence
• Top Geo Node
• Type

See Also:

StorePackage.getGeoNodeType()

Method Summary

Modifier and Type	Method and Description
java.util.List	getDescription() Returns the value of the 'Description' containment reference list.
double	getDisplaySequence() Returns the value of the 'Display Sequence' attribute.
GeoNodeIdentifierType	getGeoNodeIdentifier() Returns the value of the 'Geo Node Identifier' containment reference.
GeoNodeIdentifierType	getParentGeoNodeIdentifier() Returns the value of the 'Parent Geo Node Identifier' containment reference.
StoreIdentifierType	getStoreIdentifier() Returns the value of the 'Store Identifier' containment reference.
java.lang.String	getType_() Returns the value of the 'Type' attribute.
UserDataType	getUserData() Returns the value of the 'User Data' containment reference.
boolean	isSetDisplaySequence() Returns whether the value of the 'Display Sequence' attribute is set.
boolean	isSetTopGeoNode() Returns whether the value of the 'Top Geo Node' attribute is set.
boolean	isTopGeoNode() Returns the value of the 'Top Geo Node' attribute.
void	setDisplaySequence(double value) Sets the value of the 'Display Sequence' attribute.
void	setGeoNodeIdentifier(GeoNodeIdentifierType value) Sets the value of the 'Geo Node Identifier' containment reference.
void	setParentGeoNodeIdentifier(GeoNodeIdentifierType value) Sets the value of the 'Parent Geo Node Identifier' containment reference.
void	setStoreIdentifier(StoreIdentifierType value) Sets the value of the 'Store Identifier' containment reference.
void	setTopGeoNode(boolean value) Sets the value of the 'Top Geo Node' attribute.
void	setType(java.lang.String value) Sets the value of the 'Type' attribute.
void	setUserData(UserDataType value) Sets the value of the 'User Data' containment reference.
void	unsetDisplaySequence() Unsets the value of the 'Display Sequence' attribute.
void	unsetTopGeoNode() Unsets the value of the 'Top Geo Node' attribute.

Method Detail

getGeoNodeIdentifier

GeoNodeIdentifierType getGeoNodeIdentifier()

Returns the value of the 'Geo Node Identifier' containment reference. The geo node identifier.

Returns:

the value of the 'Geo Node Identifier' containment reference.

See Also:

setGeoNodeIdentifier(GeoNodeIdentifierType), StorePackage.getGeoNodeType_GeoNodeIdentifier()

setGeoNodeIdentifier

void setGeoNodeIdentifier(GeoNodeIdentifierType value)

Sets the value of the 'Geo Node Identifier' containment reference.

Parameters:

value - the new value of the 'Geo Node Identifier' containment reference.

See Also:

getGeoNodeIdentifier()

getStoreIdentifier

StoreIdentifierType getStoreIdentifier()

Returns the value of the 'Store Identifier' containment reference.

If the meaning of the 'Store Identifier' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Store Identifier' containment reference.

See Also:

setStoreIdentifier(StoreIdentifierType), StorePackage.getGeoNodeType_StoreIdentifier()

setStoreIdentifier

void setStoreIdentifier(StoreIdentifierType value)

Sets the value of the 'Store Identifier' containment reference.

Parameters:

value - the new value of the 'Store Identifier' containment reference.

See Also:

getStoreIdentifier()

getDescription

java.util.List getDescription()

Returns the value of the 'Description' containment reference list. The list contents are of type GeoNodeDescriptionType. The geo node description.

Returns:

the value of the 'Description' containment reference list.

See Also:

StorePackage.getGeoNodeType_Description()

getParentGeoNodeIdentifier

GeoNodeIdentifierType getParentGeoNodeIdentifier()

Returns the value of the 'Parent Geo Node Identifier' containment reference. The geo node identifier of the parent.

Returns:

the value of the 'Parent Geo Node Identifier' containment reference.

See Also:

setParentGeoNodeIdentifier(GeoNodeIdentifierType), StorePackage.getGeoNodeType_ParentGeoNodeIdentifier()

setParentGeoNodeIdentifier

void setParentGeoNodeIdentifier(GeoNodeIdentifierType value)

Sets the value of the 'Parent Geo Node Identifier' containment reference.

Parameters:

value - the new value of the 'Parent Geo Node Identifier' containment reference.

See Also:

getParentGeoNodeIdentifier()

getUserData

UserDataType getUserData()

Returns the value of the 'User Data' containment reference. The user data area.

Returns:

the value of the 'User Data' containment reference.

See Also:

setUserData(UserDataType), StorePackage.getGeoNodeType_UserData()

setUserData

void setUserData(UserDataType value)

Sets the value of the 'User Data' containment reference.

Parameters:

value - the new value of the 'User Data' containment reference.

See Also:

getUserData()

getDisplaySequence

double getDisplaySequence()

Returns the value of the 'Display Sequence' attribute. This is used in context with the parent node for display.

Returns:

the value of the 'Display Sequence' attribute.

See Also:

isSetDisplaySequence(), unsetDisplaySequence(), setDisplaySequence(double), StorePackage.getGeoNodeType_DisplaySequence()

setDisplaySequence

void setDisplaySequence(double value)

Sets the value of the 'Display Sequence' attribute.

Parameters:

value - the new value of the 'Display Sequence' attribute.

See Also:

isSetDisplaySequence(), unsetDisplaySequence(), getDisplaySequence()

unsetDisplaySequence

void unsetDisplaySequence()

Unsets the value of the 'Display Sequence' attribute.

See Also:

isSetDisplaySequence(), getDisplaySequence(), setDisplaySequence(double)

isSetDisplaySequence

boolean isSetDisplaySequence()

Returns whether the value of the 'Display Sequence' attribute is set.

Returns:

whether the value of the 'Display Sequence' attribute is set.

See Also:

unsetDisplaySequence(), getDisplaySequence(), setDisplaySequence(double)

isTopGeoNode

boolean isTopGeoNode()

Returns the value of the 'Top Geo Node' attribute. True for a top level geo node.

Returns:

the value of the 'Top Geo Node' attribute.

See Also:

isSetTopGeoNode(), unsetTopGeoNode(), setTopGeoNode(boolean), StorePackage.getGeoNodeType_TopGeoNode()

setTopGeoNode

void setTopGeoNode(boolean value)

Sets the value of the 'Top Geo Node' attribute.

Parameters:

value - the new value of the 'Top Geo Node' attribute.

See Also:

isSetTopGeoNode(), unsetTopGeoNode(), isTopGeoNode()

unsetTopGeoNode

void unsetTopGeoNode()

Unsets the value of the 'Top Geo Node' attribute.

See Also:

isSetTopGeoNode(), isTopGeoNode(), setTopGeoNode(boolean)

isSetTopGeoNode

boolean isSetTopGeoNode()

Returns whether the value of the 'Top Geo Node' attribute is set.

Returns:

whether the value of the 'Top Geo Node' attribute is set.

See Also:

unsetTopGeoNode(), isTopGeoNode(), setTopGeoNode(boolean)

getType_

java.lang.String getType_()

Returns the value of the 'Type' attribute. This is used in context with the parent node for display.

Returns:

the value of the 'Type' attribute.

See Also:

setType(String), StorePackage.getGeoNodeType_Type()

setType

void setType(java.lang.String value)

Sets the value of the 'Type' attribute.

Parameters:

value - the new value of the 'Type' attribute.

See Also:

getType_()